Class InsertEnt

块插入实体类表示CAD中的块插入实体，继承自实体基类用于在图纸中插入预定义的块（图块）

Example

import { InsertEnt, Point2D, Engine } from 'vjcad';

// 创建块插入
const insert = new InsertEnt("块ID", new Point2D(100, 100), 1.0, 0);
insert.setDefaults();

// 添加到画布
Engine.addEntities(insert);

Hierarchy (View Summary)

EntityBase
- InsertEnt

Constructors

constructor

new InsertEnt(
    blockId?: string,
    insertionPoint?: PointInput,
    scaleFactor?: number,
    rotationAngle?: number,
    color?: number,
): InsertEnt
构造函数支持简化的数组写法 [x, y]。
Parameters
- blockId: string = ""
  块ID（8位GUID字符串）
- insertionPoint: PointInput = ...
  插入点坐标，支持 Point2D 或数组 [x, y]
- scaleFactor: number = 1
  缩放因子
- rotationAngle: number = 0
  旋转角度
- color: number = 256
  颜色索引，默认为256
Returns InsertEnt
Example
```
// 简化写法
const insert1 = new InsertEnt("blockId", [100, 100], 1.0, 0);

// Point2D 写法
const insert2 = new InsertEnt("blockId", new Point2D(100, 100), 1.0, 0);
```
Overrides EntityBase.constructor
- Defined in entities/InsertEnt.ts:70

Properties

objectId

objectId: string

DWG对象ID（句柄）- 从DWG文件导入时的唯一标识符这个值不应该在克隆时复制，新创建的实体应该为空字符串

id

id: number

实体索引ID - 从1开始递增的唯一索引用于在WebCAD格式中标识实体

_lineType

_lineType: string

_isAlive

_isAlive: boolean

isDirty

isDirty: boolean

是否处于脏状态，供渲染器增量更新

`Optional`block

block?: any

type

type: string

实体类型标识符（如"LINE"、"CIRCLE"等）

_rotation

_rotation: number

_nestEntities

_nestEntities: any[]

_nestBaseEntities

_nestBaseEntities: any[]

Accessors

handle

get handle(): string
DWG句柄别名（兼容性）

Returns string
Alias
objectId
Inherited from EntityBase.handle
- Defined in entities/EntityBase.ts:121

entityType

get entityType(): string
实体类型别名（兼容性）

Returns string
Alias
type
Inherited from EntityBase.entityType
- Defined in entities/EntityBase.ts:129

color

get color(): number
获取颜色索引

Returns number
颜色索引值（256表示"随图层"颜色）
Inherited from EntityBase.color
- Defined in entities/EntityBase.ts:140
set color(value: number): void
设置颜色索引
Parameters
- value: number
  颜色索引值（256表示"随图层"颜色）
Returns void
Inherited from EntityBase.color
- Defined in entities/EntityBase.ts:149

layerId

get layerId(): string
获取图层ID

Returns string
图层ID字符串
Inherited from EntityBase.layerId
- Defined in entities/EntityBase.ts:161
set layerId(value: string): void
设置图层ID
Parameters
- value: string
  图层ID字符串
Returns void
Inherited from EntityBase.layerId
- Defined in entities/EntityBase.ts:170

lineTypeScale

get lineTypeScale(): number
获取线型比例

Returns number
线型比例因子
Inherited from EntityBase.lineTypeScale
- Defined in entities/EntityBase.ts:182
set lineTypeScale(value: number): void
设置线型比例
Parameters
- value: number
  线型比例因子
Returns void
Inherited from EntityBase.lineTypeScale
- Defined in entities/EntityBase.ts:191

lineWeight

get lineWeight(): number
获取线宽

Returns number
线宽值（-1=ByLayer, -2=ByBlock, >=0为具体值，单位为0.01mm）
Inherited from EntityBase.lineWeight
- Defined in entities/EntityBase.ts:203
set lineWeight(value: number): void
设置线宽
Parameters
- value: number
  线宽值（-1=ByLayer, -2=ByBlock, >=0为具体值）
Returns void
Inherited from EntityBase.lineWeight
- Defined in entities/EntityBase.ts:212

transpMgr

get transpMgr(): TransparencyManager
获取透明度管理器

Returns TransparencyManager
透明度管理器实例
Inherited from EntityBase.transpMgr
- Defined in entities/EntityBase.ts:224
set transpMgr(value: TransparencyManager): void
设置透明度管理器
Parameters
- value: TransparencyManager
  透明度管理器实例
Returns void
Inherited from EntityBase.transpMgr
- Defined in entities/EntityBase.ts:233

isAlive

get isAlive(): boolean
获取实体存活状态

Returns boolean
是否存活（true表示有效，false表示已删除）
Inherited from EntityBase.isAlive
- Defined in entities/EntityBase.ts:243
set isAlive(value: boolean): void
设置实体存活状态
Parameters
- value: boolean
  是否存活
Returns void
Inherited from EntityBase.isAlive
- Defined in entities/EntityBase.ts:252

visible

get visible(): boolean
DXF Group Code 60 entity visibility. true = visible (default), false = invisible.

Returns boolean
Inherited from EntityBase.visible
- Defined in entities/EntityBase.ts:261
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from EntityBase.visible
- Defined in entities/EntityBase.ts:265

xdataRaw

get xdataRaw(): Record<string, string>
获取原始扩展数据（用于序列化）格式: { "1001": "AppName", "1000": "JSON字符串" }

Returns Record<string, string>
原始xdata对象或undefined
Inherited from EntityBase.xdataRaw
- Defined in entities/EntityBase.ts:282
set xdataRaw(value: Record<string, string>): void
设置原始扩展数据（从数据库加载时使用）
Parameters
- value: Record<string, string>
  原始xdata对象
Returns void
Inherited from EntityBase.xdataRaw
- Defined in entities/EntityBase.ts:291

extData

get extData(): Record<string, any>
获取扩展数据（用户友好格式）自动解析JSON字符串返回对象

Returns Record<string, any>
解析后的扩展数据对象，或undefined
Example
```
const data = entity.extData;
console.log(data?.sensorVal); // 10
```
Inherited from EntityBase.extData
- Defined in entities/EntityBase.ts:307

extDataAppName

get extDataAppName(): string
获取扩展数据的应用程序名（AppName）

Returns string
AppName字符串，或undefined
Inherited from EntityBase.extDataAppName
- Defined in entities/EntityBase.ts:321

doc

get doc(): any
获取所属文档

通过实体所在的块来获取文档对象。在CAD系统中，实体总是属于某个块，而块又属于某个文档。

Returns any
文档对象，如果无法获取则返回undefined
Inherited from EntityBase.doc
- Defined in entities/EntityBase.ts:377

layer

get layer(): string
获取图层名称

根据实体的layerId从文档的图层集合中查找对应的图层名称。如果找不到对应的图层，则返回默认图层"0"。

Returns string
图层名称，默认为"0"
Inherited from EntityBase.layer
- Defined in entities/EntityBase.ts:390
set layer(layerName: string): void
设置图层名称

根据图层名称查找对应的图层ID并设置给实体。如果找不到指定的图层，则使用默认图层ID（"0"）。

注意：优先使用实体所属文档的图层列表，如果实体尚未添加到文档，则使用 Engine.currentDoc 的图层列表。
Parameters
- layerName: string
  图层名称
Returns void
Inherited from EntityBase.layer
- Defined in entities/EntityBase.ts:407

lineType

get lineType(): string
获取线型

返回实体当前的线型设置。线型控制线条的显示样式（如实线、虚线、点划线等）。

Returns string
线型名称
Inherited from EntityBase.lineType
- Defined in entities/EntityBase.ts:424
set lineType(lineTypeName: string): void
设置线型

设置实体的线型，支持标准CAD线型、常见别名和自定义线型。输入的线型名称会被转换为大写进行匹配。

支持的线型：
- CONTINUOUS: 连续线（实线）
- HIDDEN/DASHED: 虚线（虚线）
- CENTER: 中心线
- PHANTOM: 幻影线
- DOT: 点线（映射为虚线）
- 自定义线型：通过LinetypeManager管理的线型
Parameters
- lineTypeName: string
  线型名称
Returns void
Inherited from EntityBase.lineType
- Defined in entities/EntityBase.ts:445

blockId

get blockId(): string
Returns string
- Defined in entities/InsertEnt.ts:107
set blockId(val: string): void
Parameters
- val: string
Returns void
- Defined in entities/InsertEnt.ts:111

insertionPoint

get insertionPoint(): Point2D
Returns Point2D
- Defined in entities/InsertEnt.ts:117
set insertionPoint(val: PointInput): void
Parameters
- val: PointInput
Returns void
- Defined in entities/InsertEnt.ts:121

scaleFactor

get scaleFactor(): number
Returns number
- Defined in entities/InsertEnt.ts:131
set scaleFactor(val: number): void
Parameters
- val: number
Returns void
- Defined in entities/InsertEnt.ts:135

isReversedX

get isReversedX(): boolean
Returns boolean
- Defined in entities/InsertEnt.ts:141
set isReversedX(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in entities/InsertEnt.ts:145

isReversedY

get isReversedY(): boolean
Returns boolean
- Defined in entities/InsertEnt.ts:151
set isReversedY(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in entities/InsertEnt.ts:155

attributes

get attributes(): any[]
Returns any[]
- Defined in entities/InsertEnt.ts:161
set attributes(val: any[]): void
Parameters
- val: any[]
Returns void
- Defined in entities/InsertEnt.ts:165

rotation

get rotation(): number
获取旋转角度

Returns number
旋转角度（弧度）
- Defined in entities/InsertEnt.ts:174
set rotation(rotationAngle: number): void
设置旋转角度
Parameters
- rotationAngle: number
  旋转角度（弧度）
Returns void
- Defined in entities/InsertEnt.ts:182

name

get name(): string
获取块名称根据块ID从文档中获取对应的块名称

Returns string
块名称，如果找不到则返回"unknown"
- Defined in entities/InsertEnt.ts:195

Methods

setExtData

setExtData(appName: string, data: Record<string, any>): void
设置扩展数据（用户友好格式）自动将对象序列化为JSON字符串存储
Parameters
- appName: string
  应用程序名（用于在DWG中标识数据来源）
- data: Record<string, any>
  要存储的数据对象（将被序列化为JSON）
Returns void
Example
```
entity.setExtData("MY_SENSOR", {
  sensorVal: 10,
  deviceName: "温度传感器",
  isActive: true
});
```
Inherited from EntityBase.setExtData
- Defined in entities/EntityBase.ts:340

clearExtData

clearExtData(): void
清除扩展数据

Returns void
Inherited from EntityBase.clearExtData
- Defined in entities/EntityBase.ts:352

hasExtData

hasExtData(): boolean
检查是否有扩展数据

Returns boolean
是否存在扩展数据
Inherited from EntityBase.hasExtData
- Defined in entities/EntityBase.ts:362

fromDefaultProps

fromDefaultProps(defaultPropsObject: any): this
从默认属性对象复制属性

将指定的默认属性对象的所有相关属性复制到当前实体。这通常用于创建新实体时应用默认设置。
Parameters
- defaultPropsObject: any
  默认属性对象，包含layer、colorIndex、lineType等属性
Returns this
当前实例（支持链式调用）
Inherited from EntityBase.fromDefaultProps
- Defined in entities/EntityBase.ts:509

setCloneSource

setCloneSource(sourceHandle: string, mapid?: string, version?: string): void
显式标记本实体克隆自哪个图纸中的哪个实体

generateCloneObjectId 依赖 Engine.currentDoc.serverSource，编程式成图时当前文档往往不是克隆来源，需要用这个方法直接指定。

导出 DWG 时后端据此从源图做 ODA 克隆，只把发生变化的属性覆盖上去，未改动的字体、线型和填充图案保持源实体原样。
Parameters
- sourceHandle: string
  源实体在 DWG 中的 handle
- Optionalmapid: string
  源图 mapid；省略表示克隆自当前文档的 templateFrom 模板
- version: string = "v1"
  源图版本，默认 "v1"
Returns void
Inherited from EntityBase.setCloneSource
- Defined in entities/EntityBase.ts:573

setDefaults

setDefaults(): void
设置为系统默认值

从全局CAD系统设置中获取当前的默认属性值并应用到实体。这些默认值包括当前图层、当前颜色、当前线型等。

使用的全局变量：
- Engine.currentDoc.CLAYER: 当前图层名称
- Engine.CECOLOR: 当前实体颜色
- Engine.CELTYPE: 当前实体线型
- Engine.CELTSCALE: 当前实体线型比例
Returns void
Inherited from EntityBase.setDefaults
- Defined in entities/EntityBase.ts:628

fromDbDefaultProps

fromDbDefaultProps(dbPropsObject: any): this
从数据库默认属性对象设置属性

从数据库查询结果或序列化数据中恢复实体属性。这个方法处理数据库中可能存在的空值和默认值情况。
Parameters
- dbPropsObject: any
  数据库属性对象，包含layerId、colorIndex等属性
Returns this
当前实例（支持链式调用）
Inherited from EntityBase.fromDbDefaultProps
- Defined in entities/EntityBase.ts:648

mapToDbDefaultProps

mapToDbDefaultProps(targetDbObject: any): any
将属性映射到数据库默认属性对象

将当前实体的属性映射到数据库存储格式的对象中。用于保存实体数据到数据库或序列化。
Parameters
- targetDbObject: any
  目标数据库属性对象
Returns any
映射后的属性对象
Inherited from EntityBase.mapToDbDefaultProps
- Defined in entities/EntityBase.ts:711

setModified

setModified(): void
通知渲染系统此实体已被修改。在桶渲染模式下，这将标记对应的桶为"脏"，以便在下次 regenPartial 时重绘。注意：此方法只标记，不触发重绘。调用方需要在适当的时候（如命令结束时）调用 regenPartial()。

Returns void
Inherited from EntityBase.setModified
- Defined in entities/EntityBase.ts:761

dispose

dispose(): void
释放实体占用的外部资源子类如持有 PIXI 对象或大尺寸缓冲，应覆盖此方法清理

Returns void
Inherited from EntityBase.dispose
- Defined in entities/EntityBase.ts:777

addAttribute

addAttribute(
    attribute: {
        tag: string;
        textString?: string;
        position?: Point2D | { x: number; y: number };
        height?: number;
        rotation?: number;
        invisible?: boolean;
        constant?: boolean;
        verifiable?: boolean;
        preset?: boolean;
        prompt?: string;
        color?: number;
        lineType?: string;
        lineTypeScale?: number;
    },
): void
添加属性值向块参照添加一个属性值
Parameters
- attribute: {
      tag: string;
      textString?: string;
      position?: Point2D | { x: number; y: number };
      height?: number;
      rotation?: number;
      invisible?: boolean;
      constant?: boolean;
      verifiable?: boolean;
      preset?: boolean;
      prompt?: string;
      color?: number;
      lineType?: string;
      lineTypeScale?: number;
  }
  属性值对象，包含tag、textString、position、colorIndex、lineType、lineTypeScale等属性
Returns void
- Defined in entities/InsertEnt.ts:205

getAttributeByTag

getAttributeByTag(tag: string): any
根据tag获取属性值
Parameters
- tag: string
  属性标签
Returns any
属性值对象，如果不存在则返回null
- Defined in entities/InsertEnt.ts:240

setAttributes

setAttributes(
    attributes: {
        tag: string;
        textString?: string;
        position?: Point2D | { x: number; y: number };
        height?: number;
        rotation?: number;
        invisible?: boolean;
        color?: number;
        lineType?: string;
        lineTypeScale?: number;
    }[],
): void
设置属性值数组
Parameters
- attributes: {
      tag: string;
      textString?: string;
      position?: Point2D | { x: number; y: number };
      height?: number;
      rotation?: number;
      invisible?: boolean;
      color?: number;
      lineType?: string;
      lineTypeScale?: number;
  }[]
  属性值数组
Returns void
- Defined in entities/InsertEnt.ts:248

getAttributes

getAttributes(): any[]
获取所有属性值

Returns any[]
属性值数组的副本
- Defined in entities/InsertEnt.ts:257

allPointsWithInBox

allPointsWithInBox(boundingBox: BoundingBox): boolean
检查所有点是否在指定边界框内对于块插入实体，总是返回false（由嵌套实体处理）
Parameters
- boundingBox: BoundingBox
  边界框
Returns boolean
总是返回false
- Defined in entities/InsertEnt.ts:267

mirror

mirror(mirrorAxisStart: PointInput, mirrorAxisEnd: PointInput): void
镜像变换对块插入进行镜像变换，包括复杂的角度处理和轴反转逻辑
Parameters
- mirrorAxisStart: PointInput
  镜像轴起点
- mirrorAxisEnd: PointInput
  镜像轴终点
Returns void
Overrides EntityBase.mirror
- Defined in entities/InsertEnt.ts:277

move

move(fromPoint: PointInput, toPoint: PointInput): void
移动变换移动块插入的位置
Parameters
- fromPoint: PointInput
  起始位置
- toPoint: PointInput
  目标位置
Returns void
Overrides EntityBase.move
- Defined in entities/InsertEnt.ts:321

rotate

rotate(rotationCenter: PointInput, rotationAngle: number): void
旋转变换围绕指定点旋转块插入
Parameters
- rotationCenter: PointInput
  旋转中心点
- rotationAngle: number
  旋转角度（弧度）
Returns void
- Defined in entities/InsertEnt.ts:340

scale

scale(scaleCenter: PointInput, scaleFactor: number): void
缩放变换以指定点为中心缩放块插入
Parameters
- scaleCenter: PointInput
  缩放中心点
- scaleFactor: number
  缩放因子
Returns void
- Defined in entities/InsertEnt.ts:364

stretch

stretch(
    stretchStartPoint: PointInput,
    stretchEndPoint: PointInput,
    stretchBox: BoundingBox,
): void
拉伸变换在指定的拉伸框内拉伸块插入
Parameters
- stretchStartPoint: PointInput
  拉伸起始点
- stretchEndPoint: PointInput
  拉伸目标点
- stretchBox: BoundingBox
  拉伸框对象，包含pt1和pt2属性
Returns void
- Defined in entities/InsertEnt.ts:385

gripEdit

gripEdit(newGripPosition: Point2D, gripType: string): void
夹点编辑通过拖拽夹点来编辑块插入的位置
Parameters
- newGripPosition: Point2D
  新的夹点位置
- gripType: string
  夹点类型标识符
Returns void
- Defined in entities/InsertEnt.ts:409

repairStretch

repairStretch(backupInsert: InsertEnt): void
修复拉伸从备份对象恢复拉伸前的插入点位置
Parameters
- backupInsert: InsertEnt
  备份的块插入对象
Returns void
- Defined in entities/InsertEnt.ts:422

updateNestEnts

updateNestEnts(blocksCollection?: any): void
更新嵌套实体根据块定义更新块插入中的所有嵌套实体，应用变换同时处理属性文本替换，确保绘制和选择使用同一份数据
Parameters
- blocksCollection: any = Engine.currentDoc.blocks
  块集合，默认为当前文档的块集合建议重命名为：updateNestedEntities
Returns void
- Defined in entities/InsertEnt.ts:434

getNestEnts

getNestEnts(forceUpdate?: boolean): any[]
获取嵌套实体获取块插入中的所有嵌套实体，使用延迟更新机制
Parameters
- forceUpdate: boolean = false
  是否强制更新嵌套实体，默认为false
Returns any[]
嵌套实体数组建议重命名为：getNestedEntities
- Defined in entities/InsertEnt.ts:624

boundingBox

boundingBox(coordinateSystemType?: number): BoundingBox
计算边界框计算块插入在指定坐标系中的边界框
Parameters
- coordinateSystemType: number = CoordinateSystemType.WCS
  坐标系类型（WCS/UCS/DCS）
Returns BoundingBox
块插入的边界框
- Defined in entities/InsertEnt.ts:637

undoMap

undoMap(backupInsert: InsertEnt): void
撤销映射从备份对象恢复块插入的所有属性
Parameters
- backupInsert: InsertEnt
  备份的块插入对象
Returns void
- Defined in entities/InsertEnt.ts:656

clone

clone(): InsertEnt
克隆块插入对象创建当前块插入对象的完整副本

Returns InsertEnt
克隆的块插入对象
Overrides EntityBase.clone
- Defined in entities/InsertEnt.ts:671

toDb

toDb(): DbBlockRef
转换为数据库对象将块插入对象转换为可存储到数据库的格式

Returns DbBlockRef
数据库块插入对象
- Defined in entities/InsertEnt.ts:694

fromDb

fromDb(dbData: DbBlockRef): void
从数据库对象加载从数据库对象恢复块插入的所有属性
Parameters
- dbData: DbBlockRef
  数据库块插入对象
Returns void
- Defined in entities/InsertEnt.ts:718

Class InsertEnt

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InsertEnt

Example

Properties

objectId

id

_lineType

_isAlive

isDirty

Optionalblock

type

_rotation

_nestEntities

_nestBaseEntities

Accessors

handle

Returns string

Alias

entityType

Returns string

Alias

color

Returns number

Parameters

Returns void

layerId

Returns string

Parameters

Returns void

lineTypeScale

Returns number

Parameters

Returns void

lineWeight

Returns number

Parameters

Returns void

transpMgr

Returns TransparencyManager

Parameters

Returns void

isAlive

Returns boolean

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

xdataRaw

Returns Record<string, string>

Parameters

Returns void

extData

Returns Record<string, any>

Example

extDataAppName

Returns string

doc

Returns any

layer

Returns string

Parameters

Returns void

lineType

Returns string

Parameters

Returns void

blockId

Returns string

`Optional`block