Skip to content
On this page

mxcad_2d API 文档 / 2d / McDbDimension

Class: McDbDimension

2d.McDbDimension

表示AutoCAD中所有标注实体类型的类的基类

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new McDbDimension(imp?)

构造函数

Parameters

NameTypeDescription
imp?any实现对象

Overrides

McDbEntity.constructor

Properties

imp

imp: any = 0

内部实现对象。

Inherited from

McDbEntity.imp

Accessors

colorIndex

get colorIndex(): number

得到对象颜色索引

Returns

number

Example

ts
import { McDbEntity, ColorIndexType } from 'mxcad'
 const ent = new McDbEntity();
 ent.colorIndex = ColorIndexType.kByblock;
 console.log(ent.colorIndex)

Inherited from

McDbEntity.colorIndex

set colorIndex(val): void

设置对象颜色索引

Parameters

NameTypeDescription
valnumber颜色索引(ColorIndexType)

Returns

void

Inherited from

McDbEntity.colorIndex


dimensionStyle

get dimensionStyle(): McObjectId

设置标注样式id

Returns

McObjectId

Example

ts
import { MxCpp } from "mxcad";

//设置 dim 为有效标注实体
const dimStyleId = MxCpp.getCurrentMxCAD().addDimStyle("MyDimStyle2", "41,0.18,141,0.09,40,200", "77,1,271,3", "", "");
dim.dimensionStyle = dimStyleId;
console.log("标注样式id:", dim.dimensionStyle)

set dimensionStyle(val): void

Parameters

NameType
valMcObjectId

Returns

void


dimensionText

get dimensionText(): string

获取或设置标注文本

Returns

string

Example

ts
//设置 dim 为有效标注实体
dim.dimensionText = "测试文本";
console.log("标注文本:", dim.dimensionText)// 测试文本

set dimensionText(val): void

Parameters

NameType
valstring

Returns

void


drawOrder

get drawOrder(): number

对象的显示顺序

Returns

number

Example

ts
// 假设ent为有效实例对象
const order = ent.drawOrder();

Inherited from

McDbEntity.drawOrder

set drawOrder(order): void

对象的显示顺序

Parameters

NameTypeDescription
ordernumber顺序值

Returns

void

Example

ts
import { MxCpp, MxCADSelectionSet } from "mxcad";

let ss = new MxCADSelectionSet();
if (!await ss.userSelect("\n选择对象")) return;
//得到当前图上对象的最大,小最显示顺序.
let minmaxOrder = MxCpp.getCurrentDatabase().currentSpace.getMinMaxDrawOrder();
// 把对象放到最上面。
let lOrder = minmaxOrder.maxDrawOrder + 1;
ss.forEach((id) => {
  let ent = id.getMcDbEntity();
  if (ent) {
    ent.drawOrder = lOrder;
  }
})

Inherited from

McDbEntity.drawOrder


dxf0

get dxf0(): string

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

Returns

string

Inherited from

McDbEntity.dxf0


elevation

get elevation(): number

获取或设置高度

Returns

number

Example

ts
//设置 dim 为有效标注实体
dim.elevation = 10;
console.log("获取高度:", dim.elevation)

set elevation(val): void

Parameters

NameType
valnumber

Returns

void


horizontalRotation

get horizontalRotation(): number

获取或设置水平旋转角度

Returns

number

水平旋转角度

Example

ts
//设置 dim 为有效标注实体
dim.horizontalRotation = Math.PI/4
console.log("水平旋转角度:", dim.horizontalRotation)// 45

set horizontalRotation(val): void

Parameters

NameType
valnumber

Returns

void


layer

get layer(): string

得到对象图层名

Returns

string

Inherited from

McDbEntity.layer

set layer(val): void

设置对象图层名

Parameters

NameTypeDescription
valstring图层名

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
 const ent = new McDbEntity();
 ent.layer = "newLayerName";
 console.log(ent.layer)

Inherited from

McDbEntity.layer


layerId

get layerId(): McObjectId

获取图层ID对象

Returns

McObjectId

Example

ts
// 假设ent为有效实例对象
const layerId = ent.layerId;

Inherited from

McDbEntity.layerId

set layerId(id): void

设置图层Id对象

Parameters

NameType
idMcObjectId

Returns

void

Example

ts
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const layerId = mxcad.addLayer("测试图层")
ent.layerId = layerId;

Inherited from

McDbEntity.layerId


linetype

get linetype(): string

得到对象线型名

Returns

string

Inherited from

McDbEntity.linetype

set linetype(val): void

设置对象线型名

Parameters

NameTypeDescription
valstring线型名

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)

Inherited from

McDbEntity.linetype


linetypeId

get linetypeId(): McObjectId

获取实体对象线型ID

Returns

McObjectId

Example

ts
// 假设ent为有效实例对象
const linetypeId = ent.linetypeId;

Inherited from

McDbEntity.linetypeId

set linetypeId(id): void

设置实体对象线型ID

Parameters

NameType
idMcObjectId

Returns

void

Example

ts
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const lineId = mxcad.addLinetypeEx("TestMyLine", '25,-5');
ent.linetypeId = lineId;

Inherited from

McDbEntity.linetypeId


linetypeScale

get linetypeScale(): number

得到对象线型比例

Returns

number

Inherited from

McDbEntity.linetypeScale

set linetypeScale(val): void

设置对象线型比例

Parameters

NameTypeDescription
valnumber线型比例

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetypeScale = 0.8;
console.log(ent.linetypeScale)

Inherited from

McDbEntity.linetypeScale


lineweight

get lineweight(): number

得到对象线重

Returns

number

Inherited from

McDbEntity.lineweight

set lineweight(val): void

设置对象线重

Parameters

NameTypeDescription
valnumber线重

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.lineweight = 20;
console.log(ent.lineweight)

Inherited from

McDbEntity.lineweight


objectName

get objectName(): string

获取对象名称。

Returns

string

返回对象名

Example

ts
import { McRxObject } from 'mxcad';

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

Inherited from

McDbEntity.objectName


textAttachment

get textAttachment(): AttachmentPoint

获取或设置文本附着点

Returns

AttachmentPoint

文本附着点

Example

ts
import { McDb } from "mxcad";

//设置 dim 为有效标注实体
dim.textAttachment = McDb.AttachmentPoin.kMiddleCenter//设置中心点对齐
console.log("文本附着点:", dim.textAttachment)// 5

set textAttachment(val): void

Parameters

NameType
valAttachmentPoint

Returns

void


textPosition

get textPosition(): McGePoint3d

获取文本位置

Returns

McGePoint3d

文本位置

Example

ts
//设置 dim 为有效标注实体
const position = dim.textPosition;
console.log(position);

set textPosition(pt): void

设置文本位置

Parameters

NameTypeDescription
ptMcGePoint3d文本位置

Returns

void

Example

ts
//设置 dim 为有效标注实体
dim.textPosition = new McGePoint3(0,0,0);

textRotation

get textRotation(): number

获取或设置文本旋转角度

Returns

number

Example

ts
//设置 dim 为有效标注实体
dim.textRotation = Math.PI/4;
console.log("旋转角度:", dim.textRotation)

set textRotation(val): void

Parameters

NameType
valnumber

Returns

void


textStyle

get textStyle(): string

得到对象文字样式

Returns

string

Inherited from

McDbEntity.textStyle

set textStyle(val): void

设置对象文字样式

Parameters

NameTypeDescription
valstring文字样式名

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.textStyle = "st_style";

Inherited from

McDbEntity.textStyle


textStyleId

get textStyleId(): McObjectId

获取实体文字样式

Returns

McObjectId

Example

ts
// 假设ent为有效实例对象
const textStyleId = ent.textStyleId;

Inherited from

McDbEntity.textStyleId

set textStyleId(id): void

设置实体的文字样式

Parameters

NameType
idMcObjectId

Returns

void

Example

ts
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Inherited from

McDbEntity.textStyleId


trueColor

get trueColor(): McCmColor

得到对象颜色

Returns

McCmColor

Example

ts
import { McDbEntity, McCmColor} from 'mxcad'
 const ent = new McDbEntity();
 ent.trueColor = new McCmColor(255, 0, 0);
 console.log(ent.trueColor)

Inherited from

McDbEntity.trueColor

set trueColor(val): void

设置对象颜色

Parameters

NameType
valMcCmColor

Returns

void

Inherited from

McDbEntity.trueColor


visible

get visible(): boolean

对象是否可见

Returns

boolean

Inherited from

McDbEntity.visible

set visible(val): void

设置是否可见

Parameters

NameTypeDescription
valboolean布尔值

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.visible = true;
console.log(ent.visible)

Inherited from

McDbEntity.visible

Methods

GetAllText

GetAllText(): McGeStringArray

得到标注对象中的所有文字内容

Returns

McGeStringArray

Example

ts
//遍历dim中的所有文字
//设置 dim 为有效标注实体
let txts = dim.GetAllText();
txts.forEach((val, index) => {
  console.log(val)
});

IntersectWith

IntersectWith(intersectObject, exOption): McGePoint3dArray

与其他实体相交, 得到交点

Parameters

NameTypeDescription
intersectObjectMcDbEntity需要相交的是实体对象
exOptionIntersect相交的选项

Returns

McGePoint3dArray

得到所有交点

Example

ts
import { McDbLine, McDb } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
const line2 = new McDbLine(new McGePoint3d(10,10,0), new McGePoint3d(11,1,0));
const ptArr = line1.IntersectWith(line2, McDb.Intersect.kExtendBoth)

Inherited from

McDbEntity.IntersectWith


assertObjectModification

assertObjectModification(autoUndo?): number

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

Parameters

NameTypeDefault value
autoUndobooleanfalse

Returns

number

Example

ts
//假设obj为一个数据库对象
obj.assertObjectModification()

Inherited from

McDbEntity.assertObjectModification


clone

clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Example

ts
//假设obj为一个数据库对象
const obj_clone = obj.clone();

Inherited from

McDbEntity.clone


createExtensionDictionary

createExtensionDictionary(): boolean

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

Returns

boolean

Example

ts
//假设obj为一个数据库对象
const res = obj.createExtensionDictionary();

Inherited from

McDbEntity.createExtensionDictionary


deleteXData

deleteXData(appName): boolean

删除实体指定应用程序名称相关的数据

Parameters

NameTypeDescription
appNamestring扩展数据名称

Returns

boolean

Example

ts
import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.deleteXData("DataName");
if(res){
  //删除成功
}else
  //删除失败
}

Inherited from

McDbEntity.deleteXData


disableDisplay

disableDisplay(isDisable): void

禁用对象的自动更新显示.

Parameters

NameTypeDescription
isDisableboolean是否禁用对象自动更新显示

Returns

void

Example

ts
import { McDbLine } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
line1.disableDisplay(true)

Inherited from

McDbEntity.disableDisplay


erase

erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Example

ts
//假设obj为一个数据库对象
const res = obj.erase();
console.log(res);

Inherited from

McDbEntity.erase


explode

explode(): MxCADResbuf

打碎对象,返回打后对象数据链表

Returns

MxCADResbuf

resbuf 数据

Example

ts
import { McDbEntity, MxCADResbuf } from "mxcad";
// 获取目标对象
let getEnt = new MxCADUiPrEntity();
getEnt.setMessage("选择打碎对象:");
let id = await getEnt.go();
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
// 打碎对象
let retExplode: MxCADResbuf = ent.explode();

Inherited from

McDbEntity.explode


freeTempRelationObject

freeTempRelationObject(): void

释放临时关系对象

Returns

void

Example

ts
//假设obj为一个数据库对象
obj.freeTempRelationObject();

Inherited from

McDbEntity.freeTempRelationObject


getAllAppName

getAllAppName(): McGeStringArray

获取实体中包含的所有 XData 记录的应用程序名(AppName)

Returns

McGeStringArray

Example

ts
// 假设ent为有效实例对象
const appNames = ent.getAllAppName();
console.log(appNames);

Inherited from

McDbEntity.getAllAppName


getArea

getArea(): Object

计算面积

Returns

Object

val 面积值 | ret 是否获取成功

NameType
retboolean
valnumber

Example

ts
import { McGePoint3d, McDbCircle } from "mxcad"

const center = new McGePoint3d(0,0,0);
const circle = new McDbCircle(center, 20);
const area = circle.getArea();
console.log("圆面积:", area)

Inherited from

McDbEntity.getArea


getBoundingBox

getBoundingBox(): Object

得到对象的最小外包

Returns

Object

NameType
maxPtMcGePoint3d
minPtMcGePoint3d
retboolean

Example

ts
import { McDbText, McGePoint3d } from 'mxcad'
const text = new McDbText();
text.textString = "测试Test";
text.height = 20;
text.position = text.alignmentPoint = new McGePoint3d(0,0,0);
const { minPt, maxPt, ret } = text.getBoundingBox()

Inherited from

McDbEntity.getBoundingBox


getDatabase

getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Example

ts
//假设obj为一个数据库对象
const data = obj.getDatabase();

Inherited from

McDbEntity.getDatabase


getDatabaseIndexId

getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Example

ts
//假设obj为一个数据库对象
const id = obj.getDatabaseIndexId();

Inherited from

McDbEntity.getDatabaseIndexId


getDimVarDouble

getDimVarDouble(iType): number

获取标注变量浮点数值

Parameters

NameTypeDescription
iTypenumber标注变量类型

Returns

number

标注变量浮点数值


getDimVarInt

getDimVarInt(iType): number

获取标注变量整数值

Parameters

NameTypeDescription
iTypenumber标注变量类型

Returns

number

标注变量整数值


getDimVarObjectId

getDimVarObjectId(iType): McObjectId

获取标注变量对象 ID

Parameters

NameTypeDescription
iTypenumber标注变量类型

Returns

McObjectId

标注变量对象 ID


getDimVarString

getDimVarString(iType): string

获取标注变量字符串值

Parameters

NameTypeDescription
iTypenumber标注变量类型

Returns

string

标注变量字符串值


getExtensionDictionary

getExtensionDictionary(): McDbDictionary

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

Returns

McDbDictionary

扩展字典数据

Example

ts
//假设obj为一个数据库对象
const id = obj.getOwnerID();

Inherited from

McDbEntity.getExtensionDictionary


getGripPoints

getGripPoints(): McGePoint3dArray

获取对象的控制点

Returns

McGePoint3dArray

Example

ts
//假设obj为一个数据库对象
const ptArr = obj.getGripPoints();

Inherited from

McDbEntity.getGripPoints


getHandle

getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Example

ts
//假设obj为一个数据库对象
const handle = obj.getHandle();

Inherited from

McDbEntity.getHandle


getImp

getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Example

ts
import { McRxObject } from 'mxcad';

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

Inherited from

McDbEntity.getImp


getJson

getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Example

ts
import { McRxObject } from 'mxcad';

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

Inherited from

McDbEntity.getJson


getObjectID

getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Example

ts
import { McDbObject } from "mxcad";

const obj = new McDbObject();
const id = obj.getObjectID();

Inherited from

McDbEntity.getObjectID


getOwnerID

getOwnerID(): number

得到对象拥用者的id

Returns

number

Example

ts
//假设obj为一个数据库对象
const id = obj.getOwnerID();

Inherited from

McDbEntity.getOwnerID


getxData

getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters

NameTypeDefault valueDescription
appNamestring""扩展数据名

Returns

MxCADResbuf

Example

ts
// 假设ent为有效实例对象
const xData = ent.getXData();

Inherited from

McDbEntity.getxData


getxDataDouble

getxDataDouble(appName): Object

获取实体的指定 XData 类型中的 double 值

Parameters

NameTypeDescription
appNamestring扩展数据名称

Returns

Object

double 值

NameType
retboolean
valnumber

Example

ts
// 假设ent为有效实例对象
let data = ent.getxDataDouble("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbEntity.getxDataDouble


getxDataLong

getxDataLong(appName): Object

获取实体的指定 XData 类型中的 long(整数)值

Parameters

NameTypeDescription
appNamestring扩展数据名称

Returns

Object

long 值

NameType
retboolean
valnumber

Example

ts
// 假设ent为有效实例对象
let data = ent.getxDataLong("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbEntity.getxDataLong


getxDataPoint

getxDataPoint(appName): Object

获取实体的指定 XData 类型中的点对象

Parameters

NameTypeDescription
appNamestring扩展数据名称

Returns

Object

获取结果及三维点对象

NameType
retboolean
valMcGePoint3d

Inherited from

McDbEntity.getxDataPoint


getxDataString

getxDataString(appName): Object

获取与特定实体关联的 XData 信息,并以字符串形式返回

Parameters

NameTypeDescription
appNamestring扩展数据名称

Returns

Object

val XData信息 | ret 是否返回成功

NameType
retboolean
valstring

Example

ts
// 假设ent为有效实例对象
let data = ent.getxDataString("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbEntity.getxDataString


highlight

highlight(isHighlight): void

设置对象是否高亮

Parameters

NameTypeDescription
isHighlightboolean是否高亮

Returns

void

Example

ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.highlight(true);

Inherited from

McDbEntity.highlight


initTempObject

initTempObject(imp): void

初始化临时对象。

Parameters

NameTypeDescription
impany内部实现对象。

Returns

void

Example

ts
import { McRxObject } from 'mxcad';

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

Inherited from

McDbEntity.initTempObject


isErased

isErased(): boolean

对象是否已经删除

Returns

boolean

Example

ts
//假设obj为一个数据库对象
const res = obj.isErased();
console.log(res);

Inherited from

McDbEntity.isErased


isHaveExtensionDictionary

isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Example

ts
//假设obj为一个数据库对象
const res = obj.isHaveExtensionDictionary();

Inherited from

McDbEntity.isHaveExtensionDictionary


isKindOf

isKindOf(sObjectName): boolean

判断对象类型

Parameters

NameTypeDescription
sObjectNamestring类型名

Returns

boolean

返回对象是否是目标类型

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // 输出: true 或 false

Inherited from

McDbEntity.isKindOf


isNull

isNull(): any

判断是否为空对象

Returns

any

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.isNull()); // 输出: true 或 false

Inherited from

McDbEntity.isNull


isUsingDefaultTextPosition

isUsingDefaultTextPosition(): boolean

是否使用默认文本位置

Returns

boolean

是否使用默认文本位置

Example

ts
//设置 dim 为有效标注实体
const isUsing = dim.isUsingDefaultTextPosition;
if(isUsing){
   //使用默认文本位置
}else{
   //未使用默认文本位置
}

mirror

mirror(point1, point2): boolean

镜向对象

Parameters

NameTypeDescription
point1McGePoint3d镜像基点
point2McGePoint3d-

Returns

boolean

Example

ts
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.mirror(new McGePoint3d(0,0,0), new McGePoint3d(20,10,0))

Inherited from

McDbEntity.mirror


move

move(fromPoint, toPoint): boolean

移动对象

Parameters

NameTypeDescription
fromPointMcGePoint3d移动开始点
toPointMcGePoint3d移动结束点

Returns

boolean

Example

ts
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.move(new McGePoint3d(0,0,0), new McGePoint3d(20,0,0))

Inherited from

McDbEntity.move


moveGripPointsAt

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

移动对象的控制点

Parameters

NameTypeDescription
iIndexnumber索引
dXOffsetnumberX轴偏移量
dYOffsetnumberY轴偏移量
dZOffsetnumberZ轴偏移量

Returns

any

Example

ts
//假设obj为一个数据库对象
obj.moveGripPointsAt(1,10,10,10);

Inherited from

McDbEntity.moveGripPointsAt


recomputeDimBlock

recomputeDimBlock(): void

重新计算标注块

Returns

void

Example

ts
//设置 dim 为有效标注实体
dim.recomputeDimBlock()

rotate

rotate(basePoint, dRotationAngle): boolean

旋转对象

Parameters

NameTypeDescription
basePointMcGePoint3d旋转基点
dRotationAnglenumber旋转角度

Returns

boolean

Example

ts
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.rotate(new McGePoint3d(0,0,0), Math.PI)

Inherited from

McDbEntity.rotate


scaleEntity

scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Parameters

NameTypeDescription
basePointMcGePoint3d缩放基点
dScaleFactornumber缩放因子(<1 缩小; >1 放大)

Returns

boolean

Example

ts
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.scaleEntity(new McGePoint3d(0,0,0), 0.5)

Inherited from

McDbEntity.scaleEntity


setDimVarDouble

setDimVarDouble(iType, val): void

设置标注变量浮点数值

Parameters

NameTypeDescription
iTypenumber标注变量类型
valnumber标注变量浮点数值

Returns

void


setDimVarInt

setDimVarInt(iType, val): void

设置标注变量整数值

Parameters

NameTypeDescription
iTypenumber标注变量类型
valnumber标注变量整数值

Returns

void


setDimVarObjectId

setDimVarObjectId(iType, val): void

设置标注变量对象 ID

Parameters

NameTypeDescription
iTypenumber标注变量类型
valMcObjectId标注变量对象 ID

Returns

void


setDimVarString

setDimVarString(iType, val): void

设置标注变量字符串值

Parameters

NameTypeDescription
iTypenumber标注变量类型
valstring标注变量字符串值

Returns

void


setJson

setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

NameTypeDescription
strstringJSON 格式的字符串。

Returns

boolean

是否设置成功。

Example

ts
import { McRxObject } from 'mxcad';

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

Inherited from

McDbEntity.setJson


setxData

setxData(xdata): boolean

设置对象的扩展数据

Parameters

NameTypeDescription
xdataMxCADResbuf扩展数据链表

Returns

boolean

Example

ts
import { MxCADUiPrEntity, McDbEntity } from "mxcad";

//设置扩展数据
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
ent.setxData(new MxCADResbuf([{type:DxfCode.kExDataName,val:"DataName"},{type:DxfCode.kString,val:"yyyyy"}]));

Inherited from

McDbEntity.setxData


setxDataDouble

setxDataDouble(appName, val): boolean

设置实体的指定 XData 类型中的 double 值

Parameters

NameTypeDescription
appNamestring扩展数据名称
valnumberdouble 值

Returns

boolean

布尔值

Example

ts
import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.setxDataDouble("DataName", 0);
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbEntity.setxDataDouble


setxDataLong

setxDataLong(appName, val): boolean

设置实体的指定 XData 类型中的 long(整数)值

Parameters

NameTypeDescription
appNamestring扩展数据名称
valnumberlong 值

Returns

boolean

long 值

Example

ts
import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.setxDataLong("DataName", 123456);
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbEntity.setxDataLong


setxDataPoint

setxDataPoint(appName, val): boolean

设置实体的指定 XData 类型中的点对象

Parameters

NameTypeDescription
appNamestring扩展数据名称
valMcGePoint3d点对象

Returns

boolean

获取结果及三维点对象

Inherited from

McDbEntity.setxDataPoint


setxDataString

setxDataString(appName, val): boolean

设置与特定实体关联的 XData 信息,并以字符串形式设置

Parameters

NameTypeDescription
appNamestring扩展数据名称
valstring字符串值

Returns

boolean

是否设置成功

Example

ts
import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.setxDataString("DataName", "xxxxx");
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbEntity.setxDataString


syncData

syncData(_toCpp?): boolean

同步实体的数据。这个方法可能是在修改了实体的属性或者附加了新的数据之后调用的,以确保所有的改变都被正确地保存到实体的数据库记录中。

Parameters

NameTypeDefault valueDescription
_toCppbooleantrue是否同步数据

Returns

boolean

Example

ts
// 假设ent为有效实例对象
const res = ent.syncData(true);
if(res){
  //同步成功
}else{
  //同步失败
}

Inherited from

McDbEntity.syncData


tempRelationObject

tempRelationObject(): number

与对象相关的临时关系数

Returns

number

Inherited from

McDbEntity.tempRelationObject


transformBy

transformBy(transformationMatrix): boolean

变换对象

Parameters

NameTypeDescription
transformationMatrixMcGeMatrix3d变换矩阵

Returns

boolean

Example

ts
import { McGeMatrix3d, McDbEntity, McGeVector3d} from 'mxcad'
 const ent = new McDbEntity()
   let matrix = new McGeMatrix3d();
   matrix.setToTranslation(new McGeVector3d(20,0,0));//平移
   ent.transformBy(matrix);

Inherited from

McDbEntity.transformBy


unErase

unErase(): boolean

反删除对象。

Returns

boolean

Example

ts
//假设obj为一个数据库对象
const res = obj.unErase();
console.log(res);

Inherited from

McDbEntity.unErase


updateDisplay

updateDisplay(): void

显示调用对象更新显示.

Returns

void

Example

ts
// 假设ent为有效实例对象
ent.updateDisplay()

Inherited from

McDbEntity.updateDisplay


useDefaultTextPosition

useDefaultTextPosition(): void

使用默认文本位

Returns

void

Example

ts
//设置 dim 为有效标注实体
dim.useDefaultTextPosition();

useSetTextPosition

useSetTextPosition(): void

使用设置的文本位置

Returns

void

Example

ts
//设置 dim 为有效标注实体
dim.useSetTextPosition();