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

    Class TextEnt

    文本实体类 表示CAD中的文本实体,继承自实体基类 包含文本内容、字体、对齐方式等属性,通过WASM进行矢量渲染

    import { TextEnt, Point2D, TextAlignmentEnum, Engine } from '@aspect/webcad-lib-ts';

    // 创建文本
    const text = new TextEnt(new Point2D(100, 100), "Hello World", 10);
    text.setDefaults();

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

    Hierarchy (View Summary)

    Index

    Constructors

    • 构造函数 支持简化的数组写法 [x, y]

      Parameters

      • insertionPoint: PointInput

        插入点坐标,支持 Point2D 或数组 [x, y]

      • textString: string

        文本字符串

      • height: number

        文本高度

      • rotation: number

        旋转角度

      • textAlignment: TextAlignmentEnum

        文本对齐方式

      • font: string = ''

        字体对象,默认为BIZ_UDGothic

      • color: number = 256

        颜色索引,默认为256

      Returns TextEnt

      // 简化写法
      const text1 = new TextEnt([100, 100], "Hello", 10, 0, TextAlignmentEnum.Left);

      // Point2D 写法
      const text2 = new TextEnt(new Point2D(100, 100), "Hello", 10, 0, TextAlignmentEnum.Left);

    Properties

    type: string

    实体类型标识符(如"LINE"、"CIRCLE"等)

    objectId: string

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

    id: number

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

    _lineType: string
    _isAlive: boolean
    isDirty: boolean

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

    block?: any
    _textString: string
    _height: number
    _rotation: number
    _textAlignment: TextAlignmentEnum
    _showBorder: boolean
    _styleName: string
    textStyle: TextStyle
    _insertionPoint: Point2D

    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 font(): string

      Returns string

    • set font(value: string): void

      Parameters

      • value: string

      Returns void

    • get tag(): string

      Returns string

    • set tag(value: string): void

      Parameters

      • value: string

      Returns void

    • get prompt(): string

      Returns string

    • set prompt(value: string): void

      Parameters

      • value: string

      Returns void

    • get invisible(): boolean

      Returns boolean

    • set invisible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get constant(): boolean

      Returns boolean

    • set constant(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get verifiable(): boolean

      Returns boolean

    • set verifiable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get preset(): boolean

      Returns boolean

    • set preset(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get styleName(): string

      获取文本样式名称

      Returns string

      文本样式名称

    • set styleName(value: string): void

      设置文本样式名称

      当设置样式名称时,会自动从文档的文本样式集合中获取对应的样式对象并设置。

      Parameters

      • value: string

        新的文本样式名称

      Returns void

    • get insertionPoint(): Point2D

      获取插入点

      Returns Point2D

      插入点坐标

    • set insertionPoint(value: PointInput): void

      设置插入点

      Parameters

      • value: PointInput

        新的插入点坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get showBorder(): boolean

      获取边框显示状态

      Returns boolean

      是否显示边框

    • set showBorder(shouldShowBorder: boolean): void

      设置边框显示状态

      边框在渲染时直接使用 getInnerCornerPoints() 获取范围渲染。

      Parameters

      • shouldShowBorder: boolean

        是否显示边框

      Returns void

    • get height(): number

      获取文本高度

      Returns number

      文本高度

    • set height(newHeight: number): void

      设置文本高度

      当文本高度改变时,重新计算边界框。

      Parameters

      • newHeight: number

        新的文本高度

      Returns void

    • get rotation(): number

      获取旋转角度

      Returns number

      旋转角度(弧度)

    • set rotation(newRotation: number): void

      设置旋转角度

      设置文本的旋转角度。

      Parameters

      • newRotation: number

        新的旋转角度(弧度)

      Returns void

    • get textAlignment(): TextAlignmentEnum

      获取文本对齐方式

      Returns TextAlignmentEnum

      文本对齐方式(Z枚举值)

    • set textAlignment(newAlignment: TextAlignmentEnum): void

      设置文本对齐方式

      当文本对齐方式改变时,重新计算边界框。

      Parameters

      • newAlignment: TextAlignmentEnum

        新的文本对齐方式(Z枚举值)

      Returns void

    • get textString(): string

      获取文本字符串

      Returns string

      文本字符串内容

    • set textString(newTextString: string): void

      设置文本字符串

      设置文本内容,自动解码Unicode字符串并应用文本替换规则。 当文本内容改变时,重新计算边界框。

      Parameters

      • newTextString: string

        新的文本字符串

      Returns void

    • get text(): string

      获取文本内容(textString 的别名)

      Returns string

      文本字符串内容

    • set text(newText: string): void

      设置文本内容(textString 的别名)

      Parameters

      • newText: string

        新的文本字符串

      Returns void

    • get pt1(): Point2D

      获取文本框左下角点(pt1)

      从 WASM 渲染阶段写回的角点中获取左下角点(世界坐标)。

      Returns Point2D

      左下角点坐标

    • get pt2(): Point2D

      获取文本框底边中点(pt2)

      从 WASM 渲染阶段写回的角点中计算底边中点(世界坐标)。

      Returns Point2D

      底边中点坐标

    • get pt3(): Point2D

      获取文本框右下角点(pt3)

      从 WASM 渲染阶段写回的角点中获取右下角点(世界坐标)。

      Returns Point2D

      右下角点坐标

    • get pt4(): Point2D

      获取文本框左边中点(pt4)

      从 WASM 渲染阶段写回的角点中计算左边中点(世界坐标)。

      Returns Point2D

      左边中点坐标

    • get pt5(): Point2D

      获取文本框中心点(pt5)

      从 WASM 渲染阶段写回的角点中计算中心点(世界坐标)。

      Returns Point2D

      中心点坐标

    • get pt6(): Point2D

      获取文本框右边中点(pt6)

      从 WASM 渲染阶段写回的角点中计算右边中点(世界坐标)。

      Returns Point2D

      右边中点坐标

    • get pt7(): Point2D

      获取文本框左上角点(pt7)

      从 WASM 渲染阶段写回的角点中获取左上角点(世界坐标)。

      Returns Point2D

      左上角点坐标

    • get pt8(): Point2D

      获取文本框顶边中点(pt8)

      从 WASM 渲染阶段写回的角点中计算顶边中点(世界坐标)。

      Returns Point2D

      顶边中点坐标

    • get pt9(): Point2D

      获取文本框右上角点(pt9)

      从 WASM 渲染阶段写回的角点中获取右上角点(世界坐标)。

      Returns Point2D

      右上角点坐标

    • get opt1(): Point2D

      获取边界左下角选项点(opt1) 对应左对齐的插入点位置。

      Returns Point2D

      边界左下角点坐标

    • get opt2(): Point2D

      获取边界底边中点选项点(opt2) 对应中心对齐的插入点位置。

      Returns Point2D

      边界底边中点坐标

    • get opt3(): Point2D

      获取边界右下角选项点(opt3) 对应右对齐的插入点位置。

      Returns Point2D

      边界右下角点坐标

    • get opt4(): Point2D

      获取边界左边中点选项点(opt4) 对应中左对齐的插入点位置。

      Returns Point2D

      边界左边中点坐标

    • get opt5(): Point2D

      获取边界中心选项点(opt5) 对应中心对齐的插入点位置。

      Returns Point2D

      边界中心点坐标

    • get opt6(): Point2D

      获取边界右边中点选项点(opt6) 对应中右对齐的插入点位置。

      Returns Point2D

      边界右边中点坐标

    • get opt7(): Point2D

      获取边界左上角选项点(opt7) 对应顶左对齐的插入点位置。

      Returns Point2D

      边界左上角点坐标

    • get opt8(): Point2D

      获取边界顶边中点选项点(opt8) 对应顶中对齐的插入点位置。

      Returns Point2D

      边界顶边中点坐标

    • get opt9(): Point2D

      获取边界右上角选项点(opt9) 对应顶右对齐的插入点位置。

      Returns Point2D

      边界右上角点坐标

    Methods

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

      Parameters

      • appName: string

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

      • data: Record<string, any>

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

      Returns void

      entity.setExtData("MY_SENSOR", {
      sensorVal: 10,
      deviceName: "温度传感器",
      isActive: true
      });
    • 清除扩展数据

      Returns void

    • 检查是否有扩展数据

      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

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

    • 将属性映射到数据库默认属性对象

      将当前实体的属性映射到数据库存储格式的对象中。 用于保存实体数据到数据库或序列化。

      Parameters

      • targetDbObject: any

        目标数据库属性对象

      Returns any

      映射后的属性对象

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

      Returns void

    • 设置旋转角度(方法形式) 提供与rotation setter相同的功能,用于API一致性

      Parameters

      • angle: number

        新的旋转角度(弧度)

      Returns void

    • 通过关键字设置文本对齐方式

      根据关键字字符串设置文本对齐方式。

      Parameters

      • alignmentKeyword: string

        对齐方式关键字

      • shouldAdjustPosition: boolean = true

        是否调整插入点位置,默认为true

      Returns void

    • 设置文本对齐方式(带模式控制)

      根据对齐方式设置文本,可选择是否自动调整插入点位置。

      Parameters

      • alignmentMode: TextAlignmentEnum

        文本对齐方式(Z枚举值)

      • shouldAdjustPosition: boolean = true

        是否自动调整插入点位置,默认为true

      Returns void

    • 由渲染阶段写回内部四个角点(世界坐标系) 如果之前空间索引缓存了宽高为0的边界框,则更新缓存和索引

      Parameters

      Returns void

    • 获取内部角点坐标数组

      获取内部文本框(不包含内边距)的四个角点坐标。 角点由 WASM 渲染阶段写回,格式为 [左下, 右下, 右上, 左上](世界坐标)

      Returns Point2D[]

      内部文本框的四个角点坐标数组

    • 计算边界框

      根据指定的坐标系计算文本的边界框。 使用 WASM 渲染时写回的角点数据。

      Parameters

      • coordinateSystemType: CoordinateSystemType = CoordinateSystemType.WCS

        坐标系类型(M.WCS、M.UCS、M.DCS)

      Returns BoundingBox

      边界框对象

    • 获取文本对齐方式关键字

      将数字形式的文本对齐方式转换为关键字字符串。 用于数据库存储和用户界面显示。

      Returns string

      对齐方式关键字

    • 通过关键字获取文本对齐方式数值

      将关键字字符串转换为数字形式的文本对齐方式。 支持多种关键字格式,包括底部对齐的别名。

      Parameters

      • alignmentKeyword: string

        对齐方式关键字

      Returns number

      对齐方式数值,无效关键字返回undefined

    • 检查所有关键点是否在指定框内

      判断文本的插入点是否在指定的边界框内。 这是一个简化的可见性检测方法。

      Parameters

      Returns boolean

      如果插入点在框内返回true

    • 镜像变换

      对文本进行镜像变换,以指定的两点为镜像轴。 这是一个复杂的变换操作,需要根据文本的对齐方式和旋转角度 调整文本的位置和方向。

      Parameters

      Returns void

    • 移动变换

      将文本从一个位置移动到另一个位置。 移动插入点。

      Parameters

      Returns void

    • 旋转变换

      围绕指定点旋转文本。 旋转插入点和文本角度。

      Parameters

      • centerPoint: PointInput

        旋转中心点

      • rotationAngle: number

        旋转角度(弧度)

      Returns void

    • 缩放变换

      以指定点为中心对文本进行缩放。 缩放会影响插入点位置、文本高度和边界框。

      Parameters

      • centerPoint: PointInput

        缩放中心点

      • scaleFactor: number

        缩放因子

      Returns void

    • 拉伸变形操作

      根据拉伸框和移动向量对文本进行拉伸。 只有在拉伸框内的文本会被移动。

      Parameters

      Returns void

    • 修复拉伸操作

      从备份数据恢复文本的插入点位置。

      Parameters

      • backupData: TextEnt

        备份的文本数据

      Returns void

    • 夹点编辑操作

      处理文本的夹点编辑。目前只支持插入点的编辑。

      Parameters

      • newPoint: Point2D

        新的夹点位置

      • gripType: string

        夹点类型标识符

      Returns void

    • 撤销映射操作

      从撤销数据恢复文本的所有参数。

      Parameters

      • undoData: TextEnt

        撤销数据对象

      Returns void

    • 克隆文本对象

      创建当前文本的完整副本,包括所有属性和状态。

      Returns TextEnt

      新的文本实例

    • 转换为数据库格式

      将文本对象转换为适合数据库存储的格式。

      Returns DbDText

      数据库格式的文本对象

    • 从数据库格式恢复

      从数据库格式的对象恢复文本的所有参数。 支持向后兼容,处理可选属性。

      Parameters

      • dbData: DbDText

        数据库格式的文本数据

      Returns void

    • 获取嵌套实体 单行文本不包含嵌套实体,返回空数组

      Returns TextEnt[]

      空数组

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

      Returns void