WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Class MLeaderEnt

    多重引线实体 (MLeader)

    用于创建带有引线的标注,可以包含文字或块内容。

    import { MLeaderEnt, Point2D, MLeaderContentType, LeaderType } from 'webcad-lib-ts';

    // 创建带MText内容的多重引线
    const mleader = new MLeaderEnt();
    mleader.contentType = MLeaderContentType.MText;
    mleader.textContent = "示例文字";
    mleader.textPosition = new Point2D(100, 100);

    // 添加引线
    mleader.addLeaderLine(new Point2D(0, 0)); // 箭头位置

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    type: string = "CUSTOM"

    实体类型标识(固定为 "CUSTOM")

    _nestEntsCache: EntityBase[] = null

    嵌套实体缓存 用于避免重复生成嵌套实体,提高渲染性能

    objectId: string

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

    id: number

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

    _lineType: string
    _isAlive: boolean
    isDirty: boolean

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

    block?: any
    customType: string = 'MLEADER'

    自定义实体类型标识

    customDisplayName: string = '多重引线'

    自定义实体显示名称

    _ownerRefs: OwnerReference[] = []

    关联的源实体引用(箭头点捕捉到的实体)

    _reactorDirty: boolean = false

    反应器是否脏(需要更新)

    _reactorRegistered: boolean = false

    是否已注册反应器

    Accessors

    • get color(): number

      获取颜色索引

      Returns number

      颜色索引值(256表示"随图层"颜色)

    • set color(value: number): void

      设置颜色索引

      Parameters

      • value: number

        颜色索引值(256表示"随图层"颜色)

      Returns void

    • get layerId(): string

      获取图层ID

      Returns string

      图层ID字符串

    • set layerId(value: string): void

      设置图层ID

      Parameters

      • value: string

        图层ID字符串

      Returns void

    • get lineTypeScale(): number

      获取线型比例

      Returns number

      线型比例因子

    • set lineTypeScale(value: number): void

      设置线型比例

      Parameters

      • value: number

        线型比例因子

      Returns void

    • get lineWeight(): number

      获取线宽

      Returns number

      线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值,单位为0.01mm)

    • set lineWeight(value: number): void

      设置线宽

      Parameters

      • value: number

        线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值)

      Returns void

    • get transpMgr(): TransparencyManager

      获取透明度管理器

      Returns TransparencyManager

      透明度管理器实例

    • set transpMgr(value: TransparencyManager): void

      设置透明度管理器

      Parameters

      Returns void

    • get isAlive(): boolean

      获取实体存活状态

      Returns boolean

      是否存活(true表示有效,false表示已删除)

    • set isAlive(value: boolean): void

      设置实体存活状态

      Parameters

      • value: boolean

        是否存活

      Returns void

    • get xdataRaw(): Record<string, string>

      获取原始扩展数据(用于序列化) 格式: { "1001": "AppName", "1000": "JSON字符串" }

      Returns Record<string, string>

      原始xdata对象或undefined

    • set xdataRaw(value: Record<string, string>): void

      设置原始扩展数据(从数据库加载时使用)

      Parameters

      • value: Record<string, string>

        原始xdata对象

      Returns void

    • get extData(): Record<string, any>

      获取扩展数据(用户友好格式) 自动解析JSON字符串返回对象

      Returns Record<string, any>

      解析后的扩展数据对象,或undefined

      const data = entity.extData;
      console.log(data?.sensorVal); // 10
    • get extDataAppName(): string

      获取扩展数据的应用程序名(AppName)

      Returns string

      AppName字符串,或undefined

    • get doc(): any

      获取所属文档

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

      Returns any

      文档对象,如果无法获取则返回undefined

    • get layer(): string

      获取图层名称

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

      Returns string

      图层名称,默认为"0"

    • set layer(layerName: string): void

      设置图层名称

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

      注意:优先使用实体所属文档的图层列表,如果实体尚未添加到文档, 则使用 Engine.currentDoc 的图层列表。

      Parameters

      • layerName: string

        图层名称

      Returns void

    • get lineType(): string

      获取线型

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

      Returns string

      线型名称

    • set lineType(lineTypeName: string): void

      设置线型

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

      支持的线型:

      • CONTINUOUS: 连续线(实线)
      • HIDDEN/DASHED: 虚线(虚线)
      • CENTER: 中心线
      • PHANTOM: 幻影线
      • DOT: 点线(映射为虚线)
      • 自定义线型:通过LinetypeManager管理的线型

      Parameters

      • lineTypeName: string

        线型名称

      Returns void

    • get leaderType(): LeaderType

      Returns LeaderType

    • set leaderType(value: LeaderType): void

      Parameters

      Returns void

    • get textContent(): string

      Returns string

    • set textContent(value: string): void

      Parameters

      • value: string

      Returns void

    • get textPosition(): Point2D

      Returns Point2D

    • set textPosition(value: Point2D): void

      Parameters

      Returns void

    • get textHeight(): number

      Returns number

    • set textHeight(value: number): void

      Parameters

      • value: number

      Returns void

    • get textRotation(): number

      Returns number

    • set textRotation(value: number): void

      Parameters

      • value: number

      Returns void

    • get enableFrameText(): boolean

      Returns boolean

    • set enableFrameText(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get blockId(): string

      Returns string

    • set blockId(value: string): void

      Parameters

      • value: string

      Returns void

    • get blockPosition(): Point2D

      Returns Point2D

    • set blockPosition(value: Point2D): void

      Parameters

      Returns void

    • get blockScale(): { x: number; y: number; z: number }

      Returns { x: number; y: number; z: number }

    • set blockScale(value: { x: number; y: number; z: number }): void

      Parameters

      • value: { x: number; y: number; z: number }

      Returns void

    • get blockRotation(): number

      Returns number

    • set blockRotation(value: number): void

      Parameters

      • value: number

      Returns void

    • get enableLanding(): boolean

      Returns boolean

    • set enableLanding(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get landingGap(): number

      Returns number

    • set landingGap(value: number): void

      Parameters

      • value: number

      Returns void

    • get enableLandingLine(): boolean

      是否启用着陆段线条

      Returns boolean

    • set enableLandingLine(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get landingLength(): number

      着陆段长度(水平连接段的长度)

      Returns number

    • set landingLength(value: number): void

      Parameters

      • value: number

      Returns void

    • get arrowSize(): number

      Returns number

    • set arrowSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get leaderLineColor(): number

      Returns number

    • set leaderLineColor(value: number): void

      Parameters

      • value: number

      Returns void

    • get leaderLineWeight(): number

      Returns number

    • set leaderLineWeight(value: number): void

      Parameters

      • value: number

      Returns void

    • get overallScale(): number

      获取整体缩放因子

      Returns number

    • set overallScale(value: number): void

      设置整体缩放因子

      Parameters

      • value: number

      Returns void

    • get isAssociative(): boolean

      是否有关联的源实体

      Returns boolean

    Methods

    • 炸开实体

      将自定义实体分解为基本图元(线、圆弧等)。 用于分解命令和DXF导出。

      子类可以重写此方法以提供自定义的炸开逻辑。 如果不重写,默认使用 getNestEnts() 返回的实体进行炸开。

      Returns EntityBase[]

      炸开后的基本实体数组

      explode(): EntityBase[] {
      const line1 = new LineEnt(this.point1, this.point2);
      const arc = new ArcEnt(this.center, this.radius, this.startAng, this.endAng);
      return [line1, arc];
      }
    • 获取嵌套实体(带缓存)

      返回组成该自定义实体的子实体,用于渲染显示。

      此方法使用内部缓存来避免重复生成嵌套实体,提高渲染性能:

      • 如果缓存有效,直接返回缓存的实体数组
      • 如果缓存无效(为 null),调用 buildNestEnts() 生成新实体并缓存
      • 当实体被修改(调用 setModified())时,缓存自动清除

      子类如需重写此方法(如需支持额外参数),应注意正确处理缓存逻辑。

      Returns EntityBase[]

      嵌套实体数组

    • 清除嵌套实体缓存

      在需要强制重新生成嵌套实体时调用。 通常在setModified时会自动调用。

      Returns void

    • 计算边界框

      默认实现:根据 getNestEnts() 返回的子实体计算合并边界框。 子类可以重写此方法以提供自定义的边界框计算逻辑。

      Parameters

      Returns BoundingBox

      边界框

    • 将属性映射到数据库默认属性对象(重写父类方法)

      除了调用父类的基础属性映射外,还会序列化嵌套实体用于DWG导出。

      Parameters

      • targetDbObject: any

        目标数据库属性对象

      Returns any

      映射后的属性对象

    • 获取属性面板显示名称

      返回在属性面板中显示的实体名称。 超过指定长度的内容将被截断并显示"..."

      Parameters

      • maxLength: number = 20

        最大显示长度,默认为20

      Returns string

      显示名称

    • 标记实体已修改

      重写父类方法,在标记修改时同时清除嵌套实体缓存。

      Returns void

    • 设置扩展数据(用户友好格式) 自动将对象序列化为JSON字符串存储

      Parameters

      • appName: string

        应用程序名(用于在DWG中标识数据来源)

      • data: Record<string, any>

        要存储的数据对象(将被序列化为JSON)

      Returns void

      entity.setExtData("MY_SENSOR", {
      sensorVal: 10,
      deviceName: "温度传感器",
      isActive: true
      });
    • 检查是否有扩展数据

      Returns boolean

      是否存在扩展数据

    • 从默认属性对象复制属性

      将指定的默认属性对象的所有相关属性复制到当前实体。 这通常用于创建新实体时应用默认设置。

      Parameters

      • defaultPropsObject: any

        默认属性对象,包含layer、colorIndex、lineType等属性

      Returns this

      当前实例(支持链式调用)

    • 设置为系统默认值

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

      使用的全局变量:

      • Engine.currentDoc.CLAYER: 当前图层名称
      • Engine.CECOLOR: 当前实体颜色
      • Engine.CELTYPE: 当前实体线型
      • Engine.CELTSCALE: 当前实体线型比例

      Returns void

    • 从数据库默认属性对象设置属性

      从数据库查询结果或序列化数据中恢复实体属性。 这个方法处理数据库中可能存在的空值和默认值情况。

      Parameters

      • dbPropsObject: any

        数据库属性对象,包含layerId、colorIndex等属性

      Returns this

      当前实例(支持链式调用)

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

      Returns void

    • Returns number

    • Returns number

    • 获取缩放后的着陆段长度

      Returns number

    • Returns number

    • 获取所有引线集群索引

      Returns number[]

    • 添加引线集群

      Returns number

      新添加的引线集群索引

    • 移除引线集群

      Parameters

      • leaderIndex: number

        要移除的引线集群索引

      Returns void

    • 获取所有引线线条索引

      Returns number[]

    • 获取指定引线集群的引线线条索引

      Parameters

      • leaderIndex: number

      Returns number[]

    • 添加引线线条到指定引线集群

      Parameters

      • leaderIndex: number

        引线集群索引

      Returns number

      新添加的引线线条索引

    • 添加引线线条(自动创建引线集群)

      Parameters

      • firstPoint: Point2D

        引线起点(箭头位置)

      Returns number

      引线线条索引

    • 移除引线线条

      Parameters

      • leaderLineIndex: number

        引线线条索引

      Returns void

    • 获取引线线条所属的引线集群

      Parameters

      • leaderLineIndex: number

      Returns number

    • 设置引线线条的第一个顶点

      Parameters

      • leaderLineIndex: number
      • point: Point2D

      Returns void

    • 获取引线线条的第一个顶点

      Parameters

      • leaderLineIndex: number

      Returns Point2D

    • 设置引线线条的最后一个顶点

      Parameters

      • leaderLineIndex: number
      • point: Point2D

      Returns void

    • 获取引线线条的最后一个顶点

      Parameters

      • leaderLineIndex: number

      Returns Point2D

    • 添加顶点到引线线条末尾

      Parameters

      • leaderLineIndex: number
      • point: Point2D

      Returns void

    • 获取引线线条的顶点数量

      Parameters

      • leaderLineIndex: number

      Returns number

    • 获取指定顶点

      Parameters

      • leaderLineIndex: number
      • index: number

      Returns Point2D

    • 设置指定顶点

      Parameters

      • leaderLineIndex: number
      • index: number
      • point: Point2D

      Returns void

    • 设置基线方向

      Parameters

      • leaderIndex: number
      • direction: Point2D

      Returns void

    • 获取基线方向

      Parameters

      • leaderIndex: number

      Returns Point2D

    • 设置指定引线集群的基线长度

      Parameters

      • leaderIndex: number
      • length: number

      Returns void

    • 获取指定引线集群的基线长度

      Parameters

      • leaderIndex: number

      Returns number

    • 获取内容位置

      Returns Point2D

    • 设置内容位置

      Parameters

      Returns void

    • 获取连接点(基线与内容的连接位置)

      Parameters

      • leaderIndex: number

      Returns Point2D

    • 从当前文档应用样式

      Returns void

    • 获取关联的Owner实体ID列表

      Returns number[]

    • 从源实体更新箭头位置

      Returns boolean

      是否成功更新

    • 标记反应器脏

      Returns void

    • 检查反应器是否处于脏状态

      Returns boolean

    • 断开所有Owner关联

      Returns void

    • 尝试重新注册反应器(在添加到文档后调用)

      Returns boolean

    • 设置箭头点的源实体关联

      Parameters

      • leaderLineIndex: number

        引线线条索引

      • entityId: number

        源实体ID

      • OptionalsegmentIndex: number

        线段索引(多段线)

      • OptionalpointType: string

        点类型(start/end/midpoint/nearest)

      • OptionalparameterT: number

        参数T值(用于精确定位曲线上的点)

      • OptionalpointAngle: number

        点角度(用于圆/弧)

      Returns void

    • 清除指定引线线条的源实体关联

      Parameters

      • leaderLineIndex: number

      Returns void

    • 移动变换

      默认实现:移动所有夹点。子类可重写以实现自定义移动逻辑。

      Parameters

      Returns void

    • 旋转变换

      Parameters

      • centerPoint: Point2D

        旋转中心

      • angle: number

        旋转角度(弧度)

      Returns void

    • 缩放变换

      Parameters

      • centerPoint: Point2D

        缩放中心

      • factor: number

        缩放因子

      Returns void

    • 镜像变换

      Parameters

      • mirrorAxisStart: Point2D

        镜像轴起点

      • mirrorAxisEnd: Point2D

        镜像轴终点

      Returns void

    • 夹点编辑

      响应夹点拖拽操作。子类应根据gripId识别不同的夹点。

      Parameters

      • newPosition: Point2D

        新的夹点位置

      • gripId: string

        夹点标识符

      Returns void