[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/McDbLayerTable

Class: McDbLayerTable ​

2d.McDbLayerTable

Represents a database layer table, where all layer information is stored.

Example

//Get all layers
import { MxCpp, McDbLayerTable } from "mxcad"
//Retrieve the layer table of the current CAD object
let layerTable:McDbLayerTable = MxCpp.getCurrentMxCAD().getDatabase().getLayerTable();
//Retrieve all record object IDs from the layer table
let aryId = layerTable.getAllRecordId();
//Traverse the layer table to record objects
aryId.forEach((id) => {
    let layerRec = id.getMcDbLayerTableRecord();
    if (layerRec === null) return;
    console.log(layerRec);
    console.log("layerRec.color:" + layerRec.color.getColorString());
    console.log("layerRec.name:" + layerRec.name);
});

Hierarchy ​

• McDbObject

  ↳ McDbLayerTable

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• dxf0
• objectName

Methods ​

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

Constructors ​

constructor ​

• new McDbLayerTable(imp?)

Constructor.

Parameters ​

Overrides ​

McDbObject.constructor

Properties ​

imp ​

• imp: any = 0

Internal implementation object.

Inherited from ​

McDbObject.imp

Accessors ​

dxf0 ​

• get dxf0(): string

Obtain the type name of the object's DXF group code, which is the same as the DXF group code in AutoCAD. For example, the type name of the line is McDbLine, and the group code value for DXF0 is: LINE and DXF0 group code values can be used for type filtering when constructing sets.

Returns ​

string

Inherited from ​

McDbObject.dxf0

objectName ​

• get objectName(): string

Get the object name.

Returns ​

string

Return object name

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.objectName);

Inherited from ​

McDbObject.objectName

Methods ​

add ​

▸ add(rec): McObjectId

Add layer records to the layer table.

Parameters ​

Returns ​

McObjectId

Add layer record object 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

Setting the state of the object to be changed can automatically trigger the update display function to update the display. For example, if the block table record is updated and the block reference needs to be notified to update the display, this function can be called.

Parameters ​

Returns ​

number

Example

//Assuming obj is a database object
obj.assertObjectModification()

Inherited from ​

McDbObject.assertObjectModification

clone ​

▸ clone(): null | McDbObject

Clone objects.

Returns ​

null | McDbObject

The cloned object.

Example

//Assuming obj is a database object
const obj_clone = obj.clone();

Inherited from ​

McDbObject.clone

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns ​

boolean

Example

//Assuming obj is a database object
const res = obj.createExtensionDictionary();

Inherited from ​

McDbObject.createExtensionDictionary

erase ​

▸ erase(): boolean

Delete object.

Returns ​

boolean

Whether the deletion was successful.

Example

//Assuming obj is a database object
const res = obj.erase();
console.log(res);

Inherited from ​

McDbObject.erase

get ​

▸ get(sName, skipDeleted?): McObjectId

Search for layer records in the layer table.

Parameters ​

Returns ​

McObjectId

Layer record object ID.

Example

import { MxCpp, McDbLayerTable } from "mxcad";

const layerTable:McDbLayerTable = MxCpp.getCurrentMxCAD().getDatabase().getLayerTable();
const layerRec = new McDbLayerTableRecord();
LayerRec.name="Test Layer"
layerTable.add(layerRec);
Const id=layerTable. get ("test layer")

getAllRecordId ​

▸ getAllRecordId(skipDeleted?): McObjectId[]

Retrieve the IDs of all layer records in the layer table.

Parameters ​

Returns ​

McObjectId[]

Layer ID array

Example

import { MxCpp, McDbLayerTable } from "mxcad";

const layerTable:McDbLayerTable = MxCpp.getCurrentMxCAD().getDatabase().getLayerTable();
const aryId = layerTable.getAllRecordId();
console.log(aryId)

getDatabase ​

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Returns ​

McDbDatabase

Return to database

Example

//Assuming obj is a database object
const data = obj.getDatabase();

Inherited from ​

McDbObject.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns ​

number

Example

//Assuming obj is a database object
const id = obj.getDatabaseIndexId();

Inherited from ​

McDbObject.getDatabaseIndexId

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns ​

McDbDictionary

Expand dictionary data

Example

//Assuming obj is a database object
const id = obj.getOwnerID();

Inherited from ​

McDbObject.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Returns ​

McGePoint3dArray

Example

//Assuming obj is a database object
const ptArr = obj.getGripPoints();

Inherited from ​

McDbObject.getGripPoints

getHandle ​

▸ getHandle(): string

Obtain object handle

Returns ​

string

Return object handle

Example

//Assuming obj is a database object
const handle = obj.getHandle();

Inherited from ​

McDbObject.getHandle

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Returns ​

any

Internal implementation object.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let imp = obj.getImp();

Inherited from ​

McDbObject.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Returns ​

string

A string in JSON format.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const json = obj.getJson()

Inherited from ​

McDbObject.getJson

getObjectID ​

▸ getObjectID(): McObjectId

Get the object ID.

Returns ​

McObjectId

Object ID.

Example

import { McDbObject } from "mxcad";
const id = obj.getObjectID();

Inherited from ​

McDbObject.getObjectID

getOwnerID ​

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns ​

number

Example

//Assuming obj is a database object
const id = obj.getOwnerID();

Inherited from ​

McDbObject.getOwnerID

has ​

▸ has(sName, skipDeleted?): boolean

Check if there is a layer record with the specified name in the layer table.

Parameters ​

Returns ​

boolean

Boolean value.

Example

import {MxCpp, McDbLayerTable } from "mxcad";

const layerTable:McDbLayerTable = MxCpp.getCurrentMxCAD().getDatabase().getLayerTable();
const layerRec = new McDbLayerTableRecord();
LayerRec.name="Test Layer"
layerTable.add(layerRec);
Const res=layerTable. has ("test layer");
console.log(res);

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters ​

Returns ​

void

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
obj.initTempObject()

Inherited from ​

McDbObject.initTempObject

isErased ​

▸ isErased(): boolean

Has the object been deleted

Returns ​

boolean

Example

//Assuming obj is a database object
const res = obj.isErased();
console.log(res);

Inherited from ​

McDbObject.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns ​

boolean

Example

//Assuming obj is a database object
const res = obj.isHaveExtensionDictionary();

Inherited from ​

McDbObject.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Parameters ​

Returns ​

boolean

Return whether the object is of the target type

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); //  Output: True or false

Inherited from ​

McDbObject.isKindOf

isNull ​

▸ isNull(): any

Determine if it is an empty object

Returns ​

any

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.isNull()); //  Output: True or false

Inherited from ​

McDbObject.isNull

moveGripPointsAt ​

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

Control points for moving objects

Parameters ​

Returns ​

any

Example

//Assuming obj is a database object
obj.moveGripPointsAt(1,10,10,10);

Inherited from ​

McDbObject.moveGripPointsAt

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Parameters ​

Returns ​

boolean

Is the setting successful.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)

Inherited from ​

McDbObject.setJson

unErase ​

▸ unErase(): boolean

Anti delete object.

Returns ​

boolean

Example

//Assuming obj is a database object
const res = obj.unErase();
console.log(res);

Inherited from ​

McDbObject.unErase