mxcad_2d API 文档 / 2d / McDbDictionary
Class: McDbDictionary
2d.McDbDictionary
数据库中的字典类,用户的自定义数据可以存放在字典中,它可以理解一个映射表,字符串是关键字,可以映射到任何一个对象。字典中可以再包含字典。
Example
import { McDbDictionary, McDbXrecord } from "mxcad"
//遍历字典
function MxTest_GetNamedObjectsDictionary() {
// 获取当前CAD对象
let mxcad = MxCpp.getCurrentMxCAD();
// 获取数据库中的字典对象
let dict = mxcad.getDatabase().getNamedObjectsDictionary();
// 获取字典中所有的对象名
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);// 递归遍历字典对象
}
})
}
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
↳
McDbDictionary
Table of contents
Constructors
Properties
Accessors
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?
)
构造函数。
Parameters
Name | Type | Description |
---|---|---|
imp? | any | 内部实现对象。 |
Overrides
Properties
imp
• imp: any
= 0
内部实现对象。
Inherited from
Accessors
dxf0
• get
dxf0(): string
得到对象的DXF组码的类型名,这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为:McDbLine,DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。
Returns
string
Inherited from
McDbObject.dxf0
objectName
• get
objectName(): string
获取对象名称。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.objectName);
Returns
string
返回对象名
Inherited from
McDbObject.objectName
Methods
addObject
▸ addObject(sName
, obj
): McObjectId
向字典中添加对象
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
Name | Type | Description |
---|---|---|
sName | string | 对象名称 |
obj | McDbObject | 对象 |
Returns
对象ID
assertObjectModification
▸ assertObjectModification(autoUndo?
): number
设置对象被改变的状态,可自动触发更新显示函数,更新显示。 比如块表记录更新了,需要通知块引用更新显示,可以调用该函数。
Example
//假设obj为一个数据库对象
obj.assertObjectModification()
Parameters
Name | Type | Default value |
---|---|---|
autoUndo | boolean | false |
Returns
number
Inherited from
McDbObject.assertObjectModification
clone
▸ clone(): null
| McDbObject
克隆对象。
Example
//假设obj为一个数据库对象
const obj_clone = obj.clone();
Returns
null
| McDbObject
克隆出的对象。
Inherited from
createExtensionDictionary
▸ createExtensionDictionary(): boolean
创建对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.createExtensionDictionary();
Returns
boolean
Inherited from
McDbObject.createExtensionDictionary
erase
▸ erase(): boolean
删除对象。
Example
//假设obj为一个数据库对象
const res = obj.erase();
console.log(res);
Returns
boolean
是否删除成功。
Inherited from
getAllObject
▸ getAllObject(): McObjectId
[]
获取字典中的所有对象。
Example
import { MxCpp, McDbDictionary } from "mxcad";
let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const aryId = dict.getAllObject();
console.log(aryId);
Returns
对象ID数组
getAllObjectName
▸ getAllObjectName(): McGeStringArray
获取字典中所有的对象名。
Example
import { MxCpp, McDbDictionary } from "mxcad";
let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const aryName = dict.getAllObjectName();
console.log(aryName);
Returns
对象名数组
getAt
▸ getAt(sName
, isGetErased?
): McObjectId
获取字典中指定对象
Example
import { MxCpp, McDbDictionary } from "mxcad";
let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const objId = dict.getAt("测试字典");
Parameters
Name | Type | Default value | Description |
---|---|---|---|
sName | string | undefined | 对象名称 |
isGetErased | boolean | false | 是否获取已删除的对象 |
Returns
对象ID
getDatabase
▸ getDatabase(): McDbDatabase
得到对象所在的数据库
Example
//假设obj为一个数据库对象
const data = obj.getDatabase();
Returns
返回数据库
Inherited from
getDatabaseIndexId
▸ getDatabaseIndexId(): number
获取对象的索引ID
Example
//假设obj为一个数据库对象
const id = obj.getDatabaseIndexId();
Returns
number
Inherited from
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
得到对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
扩展字典数据
Inherited from
McDbObject.getExtensionDictionary
getGripPoints
▸ getGripPoints(): McGePoint3dArray
获取对象的控制点
Example
//假设obj为一个数据库对象
const ptArr = obj.getGripPoints();
Returns
Inherited from
getHandle
▸ getHandle(): string
得到对象句柄
Example
//假设obj为一个数据库对象
const handle = obj.getHandle();
Returns
string
返回对象句柄
Inherited from
getImp
▸ getImp(): any
获取内部实现对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let imp = obj.getImp();
Returns
any
内部实现对象。
Inherited from
getJson
▸ getJson(): string
获取 JSON 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const json = obj.getJson()
Returns
string
JSON 格式的字符串。
Inherited from
getObjectID
▸ getObjectID(): McObjectId
获取对象 ID。
Example
import { McDbObject } from "mxcad";
const id = obj.getObjectID();
Returns
对象 ID。
Inherited from
getOwnerID
▸ getOwnerID(): number
得到对象拥用者的id
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
number
Inherited from
initTempObject
▸ initTempObject(imp
): void
初始化临时对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
obj.initTempObject()
Parameters
Name | Type | Description |
---|---|---|
imp | any | 内部实现对象。 |
Returns
void
Inherited from
isErased
▸ isErased(): boolean
对象是否已经删除
Example
//假设obj为一个数据库对象
const res = obj.isErased();
console.log(res);
Returns
boolean
Inherited from
isHaveExtensionDictionary
▸ isHaveExtensionDictionary(): boolean
是否有扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.isHaveExtensionDictionary();
Returns
boolean
Inherited from
McDbObject.isHaveExtensionDictionary
isKindOf
▸ isKindOf(sObjectName
): boolean
判断对象类型
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // 输出: true 或 false
Parameters
Name | Type | Description |
---|---|---|
sObjectName | string | 类型名 |
Returns
boolean
返回对象是否是目标类型
Inherited from
isNull
▸ isNull(): any
判断是否为空对象
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.isNull()); // 输出: true 或 false
Returns
any
Inherited from
moveGripPointsAt
▸ moveGripPointsAt(iIndex
, dXOffset
, dYOffset
, dZOffset
): any
移动对象的控制点
Example
//假设obj为一个数据库对象
obj.moveGripPointsAt(1,10,10,10);
Parameters
Name | Type | Description |
---|---|---|
iIndex | number | 索引 |
dXOffset | number | X轴偏移量 |
dYOffset | number | Y轴偏移量 |
dZOffset | number | Z轴偏移量 |
Returns
any
Inherited from
remove
▸ remove(sName
): boolean
移除指定对象
Example
import { MxCpp, McDbDictionary } from "mxcad";
let mxcad = MxCpp.getCurrentMxCAD();
let dict:McDbDictionary = mxcad.getDatabase().getNamedObjectsDictionary();
const res = dict.remove("测试字典");
if(res){
//移除成功
}else{
//移除失败
}
Parameters
Name | Type | Description |
---|---|---|
sName | string | 对象名称 |
Returns
boolean
布尔值
setJson
▸ setJson(str
): boolean
设置 JSON 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)
Parameters
Name | Type | Description |
---|---|---|
str | string | JSON 格式的字符串。 |
Returns
boolean
是否设置成功。
Inherited from
unErase
▸ unErase(): boolean
反删除对象。
Example
//假设obj为一个数据库对象
const res = obj.unErase();
console.log(res);
Returns
boolean