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

Class: McObjectId ​

2d.McObjectId

The McObjectid class represents a unique identifier for a model object.

Table of contents ​

Constructors ​

• constructor

Properties ​

• id
• type

Methods ​

• clone
• erase
• getMcDbBlockTableRecord
• getMcDbCurve
• getMcDbCustomEntity
• getMcDbDictionary
• getMcDbDimStyleTableRecord
• getMcDbDimension
• getMcDbEntity
• getMcDbGroup
• getMcDbLayerTableRecord
• getMcDbLinetypeTableRecord
• getMcDbObject
• getMcDbRasterImageDef
• getMcDbTextStyleTableRecord
• getMcDbXrecord
• getMxDbEntity
• getObjectName
• isErase
• isKindOf
• isNull
• isValid

Constructors ​

constructor ​

• new McObjectId(id?, type?)

Create an instance of McObjectid.

Parameters ​

Properties ​

id ​

• id: number

Object ID

type ​

• type: McObjectIdType

object type

Methods ​

clone ​

▸ clone(): null | McDbObject

Clone object

Example

//Assuming that objectId is an object id
const obj_clone = objectId.clone();

Returns ​

null | McDbObject

Return cloned database objects

erase ​

▸ erase(isErase?): void

Delete object.

Example

//Assuming objectId is a model object id
objectId.erase();

Parameters ​

Returns ​

void

getMcDbBlockTableRecord ​

▸ getMcDbBlockTableRecord(): null | McDbBlockTableRecord

Return the MxCAD block table record object.

Example

//Assuming objectId is a block object id
const blkRecord = objectId.getMcDbBlockTableRecord();

Returns ​

null | McDbBlockTableRecord

getMcDbCurve ​

▸ getMcDbCurve(): null | McDbCurve

Return the MxCAD McDbCurve object.

Example

//Assuming objectId is a curve object id
const curve = objectId.getMcDbCurve();

Returns ​

null | McDbCurve

getMcDbCustomEntity ​

▸ getMcDbCustomEntity(): null | McDbCustomEntity

Get custom entity

Example

//Assuming objectId is a custom entity id
const customEnt = objectId.getMcDbCustomEntity();

Returns ​

null | McDbCustomEntity

getMcDbDictionary ​

▸ getMcDbDictionary(): null | McDbDictionary

Retrieve dictionary information from the database

Example

//Assuming that objectId is an object id
const dic = objectId.getMcDbDictionary();

Returns ​

null | McDbDictionary

getMcDbDimStyleTableRecord ​

▸ getMcDbDimStyleTableRecord(): null | McDbDimStyleTableRecord

Return the MxCAD annotation sample table record object.

Example

Returns ​

null | McDbDimStyleTableRecord

getMcDbDimension ​

▸ getMcDbDimension(): null | McDbDimension

Return the MxCAD McDbDimension object.

Example

//Assuming objectId is a annotation id
const dim = objectId.getMcDbDimension();

Returns ​

null | McDbDimension

getMcDbEntity ​

▸ getMcDbEntity(): null | McDbEntity

Return the MxCAD McDbEntity object.

Example

//Assuming objectId is a graphic object id
const ent = objectId.getMcDbEntity();

Returns ​

null | McDbEntity

getMcDbGroup ​

▸ getMcDbGroup(): null | McDbGroup

Return the MxCAD McDbGroup object.

Example

//Assuming that objectId is a Group ID
const group = objectId.getMcDbGroup();

Returns ​

null | McDbGroup

getMcDbLayerTableRecord ​

▸ getMcDbLayerTableRecord(): null | McDbLayerTableRecord

Return the recorded objects in the MxCAD layer table.

Example

//Assuming objectId is a layer object id
const layerRecord = objectId.getMcDbLayerTableRecord();

Returns ​

null | McDbLayerTableRecord

getMcDbLinetypeTableRecord ​

▸ getMcDbLinetypeTableRecord(): null | McDbLinetypeTableRecord

Return the MxCAD line type table record object.

Example

//Assuming objectId is a linear object id
const lineTypeRecord = objectId.getMcDbLinetypeTableRecord();

Returns ​

null | McDbLinetypeTableRecord

getMcDbObject ​

▸ getMcDbObject(): null | McDbObject

Return the MxCAD McDbObject object.

Example

//Assuming objectId is a model object id
const obj = objectId.getMcDbObject();

Returns ​

null | McDbObject

Return a database object

getMcDbRasterImageDef ​

▸ getMcDbRasterImageDef(): null | McDbRasterImageDef

Obtain raster image information

Example

//Assuming that objectId is an object id
const def = objectId.getMcDbRasterImageDef();

Returns ​

null | McDbRasterImageDef

getMcDbTextStyleTableRecord ​

▸ getMcDbTextStyleTableRecord(): null | McDbTextStyleTableRecord

Return the MxCAD text style sheet record object.

Example

//Assuming objectId is a text style id
const textStyleRecord = objectId.getMcDbTextStyleTableRecord();

Returns ​

null | McDbTextStyleTableRecord

getMcDbXrecord ​

▸ getMcDbXrecord(): null | McDbXrecord

Retrieve extended record information

Example

//Assuming that objectId is an object id
const Xrecord = objectId.getMcDbXrecord();

Returns ​

null | McDbXrecord

getMxDbEntity ​

▸ getMxDbEntity(): null | MxDbEntity

Return the MxDraw object.

Example

//Assuming that objectId is an object id
const mx_obj = objectId.getMxDbEntity();

Returns ​

null | MxDbEntity

getObjectName ​

▸ getObjectName(): string

Return the name of the object pointed to by the ID

Example

//Assuming that objectId is an object id
const obj_name = objectId.getObjectName();

Returns ​

string

isErase ​

▸ isErase(): boolean

Is the ID pointing to the object in a deleted state

Example

//Assuming objectId is a model object id
const res = objectId.isErase();
console.log(res)

Returns ​

boolean

Boolean value

isKindOf ​

▸ isKindOf(className): boolean

Determine the type of an object

Example

import { McDbLine, McGePoint3d, MxCpp } from 'mxcad';

const line = new McDbLine(new McGePoint3d(0,0,0),new McGePoint3d(20,20,0) );
const objectId = MxCpp.getCurrentCAD().drawEntity(line);
console.log(objectId.isKindOf('McDbLine'))

Parameters ​

Returns ​

boolean

isNull ​

▸ isNull(): boolean

Is the ID NULL

Example

//Assuming objectId is a model object id
const res = objectId.isNull();
console.log(res)

Returns ​

boolean

Boolean value

isValid ​

▸ isValid(): boolean

Is the ID valid

Example

//Assuming objectId is a model object id
const res = objectId.isValid();
console.log(res)

Returns ​

boolean

Boolean value