mxcad_2d API 文档 / 2d / McDbLayerTable

Class: McDbLayerTable

2d.McDbLayerTable

McDbLayerTable 是数据库中的图层表，负责管理当前图纸中的所有图层记录。

Description

该类用于管理 CAD 图层的集合，便于查询、添加、判断和访问图层对象。 通过它可以完成：

• 获取图层表中所有图层记录 ID；
• 向图层表中新增图层；
• 按名称查找某个图层；
• 判断某个图层是否存在；
• 后续通过 McObjectId 获取真正的 McDbLayerTableRecord 进行属性编辑。

使用方式：

1. 先通过数据库对象获取当前图层表；
2. 调用 getAllRecordId() 获取所有图层 ID；
3. 使用 add() / get() / has() 管理图层；
4. 对返回的图层记录继续设置颜色、状态、线宽等属性。

总结：在实际开发中，McDbLayerTable 主要用于统一管理图层资源，是图层增删查改和图层状态控制的核心入口。

Example

import { MxCpp, McDbLayerTable } from "mxcad";

// 创建图层表并向其中添加图层记录。
async function testLayerTable() {
  const mxcad = MxCpp.getCurrentMxCAD();
  const layerTable: McDbLayerTable = mxcad.getDatabase().getLayerTable();

  const aryId = layerTable.getAllRecordId();
  console.log("图层数量:", aryId.length);

  aryId.forEach((id) => {
    const layerRec = id.getMcDbLayerTableRecord();
    if (!layerRec) return;
    console.log("图层名:", layerRec.name);
  });

  const exists = layerTable.has("测试图层");
  console.log("是否存在测试图层:", exists);
}

Hierarchy

• McDbObject

  ↳ McDbLayerTable

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• dxf0
• objectName

Methods

• add
• assertObjectModification
• clone
• createExtensionDictionary
• erase
• get
• getAllRecordId
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• has
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• setJson
• unErase

Constructors

constructor

• new McDbLayerTable(imp?)

构造函数。

Parameters

Name	Type	Description
imp?	any	内部实现对象。

Overrides

McDbObject.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbObject.imp

Accessors

dxf0

• get dxf0(): string

得到对象的DXF组码的类型名，这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为：McDbLine，DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。

Returns

string

Inherited from

McDbObject.dxf0

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Inherited from

McDbObject.objectName

Methods

add

▸ add(rec): McObjectId

向图层表中添加图层记录。

Parameters

Name	Type	Description
rec	McDbLayerTableRecord	图层表记录对象。

Returns

McObjectId

新增图层记录对象ID。

Example

import { MxCpp, McDbLayerTable } from "mxcad";

const layerTable:McDbLayerTable = MxCpp.getCurrentMxCAD().getDatabase().getLayerTable();
const layerRec = new McDbLayerTableRecord();
const id = layerTable.add(layerRec);

---

assertObjectModification

▸ assertObjectModification(autoUndo?): number

设置对象被改变的状态，可自动触发更新显示函数，更新显示。 比如块表记录更新了，需要通知块引用更新显示，可以调用该函数。

Parameters

Name	Type	Default value	Description
autoUndo	boolean	false	这次修改是否要自动支持撤销,默认为false

Returns

number

Inherited from

McDbObject.assertObjectModification

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbObject.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

创建对象的扩展字典数据.

Returns

boolean

Inherited from

McDbObject.createExtensionDictionary

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbObject.erase

---

get

▸ get(sName, skipDeleted?): McObjectId

查找图层表中的图层记录。

Parameters

Name	Type	Default value	Description
sName	string	undefined	图层名称。
skipDeleted	boolean	true	是否跳过已删除图层。

Returns

McObjectId

图层记录对象ID。

---

getAllRecordId

▸ getAllRecordId(skipDeleted?): McObjectId[]

获取层表中的所有图层记录的ID。

Parameters

Name	Type	Default value	Description
skipDeleted	boolean	true	是否跳过已删除图层。

Returns

McObjectId[]

图层ID数组

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Inherited from

McDbObject.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Inherited from

McDbObject.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

得到对象的扩展字典数据.

Returns

McDbDictionary

扩展字典数据

Inherited from

McDbObject.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

获取对象的夹点对应的编辑基点索引。

Returns

number[]

Inherited from

McDbObject.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取对象的夹点数组

Returns

McGePoint3dArray

Inherited from

McDbObject.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Inherited from

McDbObject.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbObject.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbObject.getJson

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbObject.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbObject.getOwnerID

---

has

▸ has(sName, skipDeleted?): boolean

检查图层表中是否存在指定名称的图层记录。

Parameters

Name	Type	Default value	Description
sName	string	undefined	图层名称。
skipDeleted	boolean	true	是否跳过已删除图层。

Returns

boolean

布尔值。

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

Name	Type	Description
imp	any	内部实现对象。

Returns

void

Inherited from

McDbObject.initTempObject

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbObject.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbObject.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Inherited from

McDbObject.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Inherited from

McDbObject.isNull

---

moveGripPointsAt

▸ moveGripPointsAt(iIndex, dXOffset, dYOffset, dZOffset): any

移动对象的夹点

Parameters

Name	Type	Description
iIndex	number	索引
dXOffset	number	X轴偏移量
dYOffset	number	Y轴偏移量
dZOffset	number	Z轴偏移量

Returns

any

Inherited from

McDbObject.moveGripPointsAt

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

Name	Type	Description
str	string	JSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbObject.setJson

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbObject.unErase