mxcad_2d API 文档 / 2d / McDbDimension

Class: McDbDimension ​

2d.McDbDimension

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

Hierarchy ​

• McDbEntity

  ↳ McDbDimension

  ↳↳ McDbAlignedDimension

  ↳↳ McDbRotatedDimension

  ↳↳ McDb2LineAngularDimension

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• colorIndex
• dimensionStyle
• dimensionText
• drawOrder
• dxf0
• elevation
• horizontalRotation
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• textAttachment
• textPosition
• textRotation
• textStyle
• textStyleId
• trueColor
• visible

Methods ​

• GetAllText
• IntersectWith
• assertObjectModification
• clone
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getArea
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getDimVarDouble
• getDimVarInt
• getDimVarObjectId
• getDimVarString
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• isUsingDefaultTextPosition
• mirror
• move
• moveGripPointsAt
• recomputeDimBlock
• rotate
• scaleEntity
• setDimVarDouble
• setDimVarInt
• setDimVarObjectId
• setDimVarString
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• unErase
• updateDisplay
• useDefaultTextPosition
• useSetTextPosition

Constructors ​

constructor ​

• new McDbDimension(imp?)

构造函数

Parameters ​

Overrides ​

McDbEntity.constructor

Properties ​

imp ​

• imp: any = 0

内部实现对象。

Inherited from ​

McDbEntity.imp

Accessors ​

colorIndex ​

• get colorIndex(): number

得到对象颜色索引

Returns ​

number

Example

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 ​

Returns ​

void

Inherited from ​

McDbEntity.colorIndex

dimensionStyle ​

• get dimensionStyle(): McObjectId

设置标注样式id

Returns ​

McObjectId

Example

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 ​

Returns ​

void

dimensionText ​

• get dimensionText(): string

获取或设置标注文本

Returns ​

string

Example

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

• set dimensionText(val): void

Parameters ​

Returns ​

void

drawOrder ​

• get drawOrder(): number

对象的显示顺序

Returns ​

number

Example

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

Inherited from ​

McDbEntity.drawOrder

• set drawOrder(order): void

对象的显示顺序

Parameters ​

Returns ​

void

Example

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

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

• set elevation(val): void

Parameters ​

Returns ​

void

horizontalRotation ​

• get horizontalRotation(): number

获取或设置水平旋转角度

Returns ​

number

水平旋转角度

Example

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

• set horizontalRotation(val): void

Parameters ​

Returns ​

void

layer ​

• get layer(): string

得到对象图层名

Returns ​

string

Inherited from ​

McDbEntity.layer

• set layer(val): void

设置对象图层名

Parameters ​

Returns ​

void

Example

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

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

Inherited from ​

McDbEntity.layerId

• set layerId(id): void

设置图层Id对象

Parameters ​

Returns ​

void

Example

// 假设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 ​

Returns ​

void

Example

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

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

Inherited from ​

McDbEntity.linetypeId

• set linetypeId(id): void

设置实体对象线型ID

Parameters ​

Returns ​

void

Example

// 假设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 ​

Returns ​

void

Example

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 ​

Returns ​

void

Example

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

Inherited from ​

McDbEntity.lineweight

normal ​

• get normal(): McGeVector3d

返回对象的normal

Returns ​

McGeVector3d

Example

Inherited from ​

McDbEntity.normal

• set normal(val): void

设置对象的normal

Parameters ​

Returns ​

void

Example

Inherited from ​

McDbEntity.normal

objectName ​

• get objectName(): string

获取对象名称。

Returns ​

string

返回对象名

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.objectName

textAttachment ​

• get textAttachment(): AttachmentPoint

获取或设置文本附着点

Returns ​

AttachmentPoint

文本附着点

Example

import { McDb } from "mxcad";

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

• set textAttachment(val): void

Parameters ​

Returns ​

void

textPosition ​

• get textPosition(): McGePoint3d

获取文本位置

Returns ​

McGePoint3d

文本位置

Example

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

• set textPosition(pt): void

设置文本位置

Parameters ​

Returns ​

void

Example

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

textRotation ​

• get textRotation(): number

获取或设置文本旋转角度

Returns ​

number

Example

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

• set textRotation(val): void

Parameters ​

Returns ​

void

textStyle ​

• get textStyle(): string

得到对象文字样式

Returns ​

string

Inherited from ​

McDbEntity.textStyle

• set textStyle(val): void

设置对象文字样式

Parameters ​

Returns ​

void

Example

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

Inherited from ​

McDbEntity.textStyle

textStyleId ​

• get textStyleId(): McObjectId

获取实体文字样式

Returns ​

McObjectId

Example

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

Inherited from ​

McDbEntity.textStyleId

• set textStyleId(id): void

设置实体的文字样式

Parameters ​

Returns ​

void

Example

// 假设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

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 ​

Returns ​

void

Inherited from ​

McDbEntity.trueColor

visible ​

• get visible(): boolean

对象是否可见

Returns ​

boolean

Inherited from ​

McDbEntity.visible

• set visible(val): void

设置是否可见

Parameters ​

Returns ​

void

Example

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

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

IntersectWith ​

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

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

Parameters ​

Returns ​

McGePoint3dArray

得到所有交点

Example

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 ​

Returns ​

number

Example

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

Inherited from ​

McDbEntity.assertObjectModification

clone ​

▸ clone(): null | McDbObject

克隆对象。

Returns ​

null | McDbObject

克隆出的对象。

Example

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

Inherited from ​

McDbEntity.clone

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

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

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.createExtensionDictionary

deleteXData ​

▸ deleteXData(appName): boolean

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

Parameters ​

Returns ​

boolean

Example

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 ​

Returns ​

void

Example

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

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

Inherited from ​

McDbEntity.erase

explode ​

▸ explode(): MxCADResbuf

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

Returns ​

MxCADResbuf

resbuf 数据

Example

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

getAllAppName ​

▸ getAllAppName(): McGeStringArray

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

Returns ​

McGeStringArray

Example

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

Inherited from ​

McDbEntity.getAllAppName

getArea ​

▸ getArea(): Object

计算面积

Returns ​

Object

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

Example

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

Example

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

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

Inherited from ​

McDbEntity.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns ​

number

Example

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

Inherited from ​

McDbEntity.getDatabaseIndexId

getDimVarDouble ​

▸ getDimVarDouble(iType): number

获取标注变量浮点数值

Parameters ​

Returns ​

number

标注变量浮点数值

getDimVarInt ​

▸ getDimVarInt(iType): number

获取标注变量整数值

Parameters ​

Returns ​

number

标注变量整数值

getDimVarObjectId ​

▸ getDimVarObjectId(iType): McObjectId

获取标注变量对象 ID

Parameters ​

Returns ​

McObjectId

标注变量对象 ID

getDimVarString ​

▸ getDimVarString(iType): string

获取标注变量字符串值

Parameters ​

Returns ​

string

标注变量字符串值

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

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

Returns ​

McDbDictionary

扩展字典数据

Example

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

Inherited from ​

McDbEntity.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

获取对象的控制点

Returns ​

McGePoint3dArray

Example

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

Inherited from ​

McDbEntity.getGripPoints

getHandle ​

▸ getHandle(): string

得到对象句柄

Returns ​

string

返回对象句柄

Example

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

Inherited from ​

McDbEntity.getHandle

getImp ​

▸ getImp(): any

获取内部实现对象。

Returns ​

any

内部实现对象。

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.getImp

getJson ​

▸ getJson(): string

获取 JSON 格式的字符串。

Returns ​

string

JSON 格式的字符串。

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.getJson

getObjectID ​

▸ getObjectID(): McObjectId

获取对象 ID。

Returns ​

McObjectId

对象 ID。

Example

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

Inherited from ​

McDbEntity.getObjectID

getOwnerID ​

▸ getOwnerID(): number

得到对象拥用者的id

Returns ​

number

Example

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

Inherited from ​

McDbEntity.getOwnerID

getxData ​

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters ​

Returns ​

MxCADResbuf

Example

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

Inherited from ​

McDbEntity.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

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

Parameters ​

Returns ​

Object

double 值

Example

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

Inherited from ​

McDbEntity.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

获取实体的指定 XData 类型中的 long（整数）值

Parameters ​

Returns ​

Object

long 值

Example

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

Inherited from ​

McDbEntity.getxDataLong

getxDataPoint ​

▸ getxDataPoint(appName): Object

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

Parameters ​

Returns ​

Object

获取结果及三维点对象

Inherited from ​

McDbEntity.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

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

Parameters ​

Returns ​

Object

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

Example

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

Inherited from ​

McDbEntity.getxDataString

highlight ​

▸ highlight(isHighlight): void

设置对象是否高亮

Parameters ​

Returns ​

void

Example

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

Inherited from ​

McDbEntity.highlight

initTempObject ​

▸ initTempObject(imp): void

初始化临时对象。

Parameters ​

Returns ​

void

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.initTempObject

isErased ​

▸ isErased(): boolean

对象是否已经删除

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters ​

Returns ​

boolean

返回对象是否是目标类型

Example

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

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.isNull

isUsingDefaultTextPosition ​

▸ isUsingDefaultTextPosition(): boolean

是否使用默认文本位置

Returns ​

boolean

是否使用默认文本位置

Example

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

mirror ​

▸ mirror(point1, point2): boolean

镜向对象

Parameters ​

Returns ​

boolean

Example

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 ​

Returns ​

boolean

Example

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 ​

Returns ​

any

Example

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

Inherited from ​

McDbEntity.moveGripPointsAt

recomputeDimBlock ​

▸ recomputeDimBlock(): void

重新计算标注块

Returns ​

void

Example

dim.recomputeDimBlock()

rotate ​

▸ rotate(basePoint, dRotationAngle): boolean

旋转对象

Parameters ​

Returns ​

boolean

Example

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 ​

Returns ​

boolean

Example

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 ​

Returns ​

void

setDimVarInt ​

▸ setDimVarInt(iType, val): void

设置标注变量整数值

Parameters ​

Returns ​

void

setDimVarObjectId ​

▸ setDimVarObjectId(iType, val): void

设置标注变量对象 ID

Parameters ​

Returns ​

void

setDimVarString ​

▸ setDimVarString(iType, val): void

设置标注变量字符串值

Parameters ​

Returns ​

void

setJson ​

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters ​

Returns ​

boolean

是否设置成功。

Example

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 ​

Returns ​

boolean

Example

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 ​

Returns ​

boolean

布尔值

Example

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 ​

Returns ​

boolean

long 值

Example

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 ​

Returns ​

boolean

获取结果及三维点对象

Inherited from ​

McDbEntity.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

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

Parameters ​

Returns ​

boolean

是否设置成功

Example

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 ​

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.syncData

transformBy ​

▸ transformBy(transformationMatrix): boolean

变换对象

Parameters ​

Returns ​

boolean

Example

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

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

Inherited from ​

McDbEntity.unErase

updateDisplay ​

▸ updateDisplay(): void

显示调用对象更新显示.

Returns ​

void

Example

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

Inherited from ​

McDbEntity.updateDisplay

useDefaultTextPosition ​

▸ useDefaultTextPosition(): void

使用默认文本位

Returns ​

void

Example

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

useSetTextPosition ​

▸ useSetTextPosition(): void

使用设置的文本位置

Returns ​

void

Example

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