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

Class: McDbDictionary ​

2d.McDbDictionary

The dictionary class in the database allows users to store custom data in a dictionary, which can understand a mapping table where strings are keywords that can be mapped to any object. The dictionary can contain additional dictionaries.

Example

import { McDbDictionary, McDbXrecord } from "mxcad"

//Traverse the dictionary
function MxTest_GetNamedObjectsDictionary() {
//Retrieve the current CAD object
  let mxcad = MxCpp.getCurrentMxCAD();
//Retrieve dictionary objects from the database
  let dict = mxcad.getDatabase().getNamedObjectsDictionary();
//Retrieve all object names from the dictionary
  let aryName = dict.getAllObjectName();
//Traverse object names
  aryName.forEach((name) => {
    console.log(name);
    let id = dict.getAt(name);
    let obj = id.getMcDbObject();
    if (obj instanceof McDbDictionary) {
      let dict: McDbDictionary = obj;
      console.log(dict);
MxTest_DictionaryData(dict);//  Recursive traversal of dictionary objects
    }
  })
}

function MxTest_DictionaryData(dict: McDbDictionary) {
  let aryName = dict.getAllObjectName();
  aryName.forEach((name) => {
    console.log(name);
    let id = dict.getAt(name);
    let obj = id.getMcDbObject();
    if (obj instanceof McDbDictionary) {
      let dict: McDbDictionary = obj;
      console.log(dict);
      MxTest_DictionaryData(dict);
    }
    else if (obj instanceof McDbXrecord) {
      let xrec: McDbXrecord = obj;
      let data = xrec.getData()
      data.PrintData();
    }
  })
}

Hierarchy ​

• McDbObject

  ↳ McDbDictionary

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• dxf0
• objectName

Methods ​

• addObject
• assertObjectModification
• clone
• createExtensionDictionary
• erase
• getAllObject
• getAllObjectName
• getAt
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• remove
• setJson
• unErase

Constructors ​

constructor ​

• new McDbDictionary(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.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

Return object name

Inherited from ​

McDbObject.objectName

Methods ​

addObject ​

▸ addObject(sName, obj): McObjectId

Add objects to the dictionary

Example

import { MxCpp, McDbDictionary, McDbObject } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const objectId = dict.addObject("newObject", new McDbObject());

Parameters ​

Returns ​

McObjectId

Object ID

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.

Example

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

Parameters ​

Returns ​

number

Inherited from ​

McDbObject.assertObjectModification

clone ​

▸ clone(): null | McDbObject

Clone objects.

Example

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

Returns ​

null | McDbObject

The cloned object.

Inherited from ​

McDbObject.clone

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Example

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

Returns ​

boolean

Inherited from ​

McDbObject.createExtensionDictionary

erase ​

▸ erase(): boolean

Delete object.

Example

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

Returns ​

boolean

Whether the deletion was successful.

Inherited from ​

McDbObject.erase

getAllObject ​

▸ getAllObject(): McObjectId[]

Retrieve all objects from the dictionary.

Example

import { MxCpp, McDbDictionary } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const aryId = dict.getAllObject();
console.log(aryId);

Returns ​

McObjectId[]

Object ID array

getAllObjectName ​

▸ getAllObjectName(): McGeStringArray

Retrieve all object names from the dictionary.

Example

import { MxCpp, McDbDictionary } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const aryName = dict.getAllObjectName();
console.log(aryName);

Returns ​

McGeStringArray

Object name array

getAt ​

▸ getAt(sName, isGetErased?): McObjectId

Retrieve the specified object from the dictionary

Example

import { MxCpp, McDbDictionary } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
Const objId=dict.getAt ("test dictionary");

Parameters ​

Returns ​

McObjectId

Object ID

getDatabase ​

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Example

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

Returns ​

McDbDatabase

Return to database

Inherited from ​

McDbObject.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

Get the index ID of the object

Example

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

Returns ​

number

Inherited from ​

McDbObject.getDatabaseIndexId

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Example

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

Returns ​

McDbDictionary

Expand dictionary data

Inherited from ​

McDbObject.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Example

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

Returns ​

McGePoint3dArray

Inherited from ​

McDbObject.getGripPoints

getHandle ​

▸ getHandle(): string

Obtain object handle

Example

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

Returns ​

string

Return object handle

Inherited from ​

McDbObject.getHandle

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Internal implementation object.

Inherited from ​

McDbObject.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

A string in JSON format.

Inherited from ​

McDbObject.getJson

getObjectID ​

▸ getObjectID(): McObjectId

Get the object ID.

Example

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

Returns ​

McObjectId

Object ID.

Inherited from ​

McDbObject.getObjectID

getOwnerID ​

▸ getOwnerID(): number

Obtain the ID of the object owner

Example

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

Returns ​

number

Inherited from ​

McDbObject.getOwnerID

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

void

Inherited from ​

McDbObject.initTempObject

isErased ​

▸ isErased(): boolean

Has the object been deleted

Example

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

Returns ​

boolean

Inherited from ​

McDbObject.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Example

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

Returns ​

boolean

Inherited from ​

McDbObject.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

boolean

Return whether the object is of the target type

Inherited from ​

McDbObject.isKindOf

isNull ​

▸ isNull(): any

Determine if it is an empty object

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Inherited from ​

McDbObject.isNull

moveGripPointsAt ​

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

Control points for moving objects

Example

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

Parameters ​

Returns ​

any

Inherited from ​

McDbObject.moveGripPointsAt

remove ​

▸ remove(sName): boolean

Remove specified object

Example

import { MxCpp, McDbDictionary } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
Const res=dict.remove ("test dictionary");
if(res){
//Removal successful
}else{
//Removal failed
}

Parameters ​

Returns ​

boolean

Boolean value

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

boolean

Is the setting successful.

Inherited from ​

McDbObject.setJson

unErase ​

▸ unErase(): boolean

Anti delete object.

Example

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

Returns ​

boolean

Inherited from ​

McDbObject.unErase