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

Class: McDbDimension ​

2d.McDbDimension

The base class representing all annotated entity types in 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
• needToUpdateDimBlock
• recomputeDimBlock
• rotate
• scaleEntity
• setDimVarDouble
• setDimVarInt
• setDimVarObjectId
• setDimVarString
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• unErase
• updateDisplay
• useDefaultTextPosition
• useSetTextPosition

Constructors ​

constructor ​

• new McDbDimension(imp?)

Constructor function

Parameters ​

Overrides ​

McDbEntity.constructor

Properties ​

imp ​

• imp: any = 0

Internal implementation object.

Inherited from ​

McDbEntity.imp

Accessors ​

colorIndex ​

• get colorIndex(): number

Obtain object color index

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

Set object color index

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.colorIndex

dimensionStyle ​

• get dimensionStyle(): McObjectId

Set annotation style ID

Returns ​

McObjectId

Example

import { MxCpp } from "mxcad";

//Set dim as a valid annotation entity
const dimStyleId = MxCpp.getCurrentMxCAD().addDimStyle("MyDimStyle2", "41,0.18,141,0.09,40,200", "77,1,271,3", "", "");
dim.dimensionStyle = dimStyleId;
Console.log ("Annotation Style ID: ", dim.dimensionStyle)

• set dimensionStyle(val): void

Parameters ​

Returns ​

void

dimensionText ​

• get dimensionText(): string

Get or set annotation text

Returns ​

string

Example

//Set dim as a valid annotation entity
Dim.dimensionText="Test Text";
Console.log ("Annotation Text:", dim. dimensionText)//Test Text

• set dimensionText(val): void

Parameters ​

Returns ​

void

drawOrder ​

• get drawOrder(): number

Display order of objects

Returns ​

number

Example

//Assuming ent is a valid instance object
const order = ent.drawOrder();

Inherited from ​

McDbEntity.drawOrder

• set drawOrder(order): void

Display order of objects

Parameters ​

Returns ​

void

Example

import { MxCpp, MxCADSelectionSet } from "mxcad";

let ss = new MxCADSelectionSet();
If (! Await ss.userSelect) return;
//Obtain the maximum and minimum display order of objects on the current graph
let minmaxOrder = MxCpp.getCurrentDatabase().currentSpace.getMinMaxDrawOrder();
//Place the object at the top.
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

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 ​

McDbEntity.dxf0

elevation ​

• get elevation(): number

Get or set height

Returns ​

number

Example

//Set dim as a valid annotation entity
dim.elevation = 10;
Console.log ("Get height: ", dim.elevation)

• set elevation(val): void

Parameters ​

Returns ​

void

horizontalRotation ​

• get horizontalRotation(): number

Get or set the horizontal rotation angle

Returns ​

number

Horizontal rotation angle

Example

//Set dim as a valid annotation entity
dim.horizontalRotation = Math.PI/4
Console.log ("Horizontal rotation angle: ", dim.horizontalRotation)// 45

• set horizontalRotation(val): void

Parameters ​

Returns ​

void

layer ​

• get layer(): string

Obtain the layer name of the object

Returns ​

string

Inherited from ​

McDbEntity.layer

• set layer(val): void

Set object layer name

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

Get layer ID object

Returns ​

McObjectId

Example

//Assuming ent is a valid instance object
const layerId = ent.layerId;

Inherited from ​

McDbEntity.layerId

• set layerId(id): void

Set Layer Id Object

Parameters ​

Returns ​

void

Example

//Assuming ent is a valid instance object
const mxcad = MxCpp.getCurrentMxCAD();
Const layerId=mxcad. addLayer (Test Layer)
ent.layerId = layerId;

Inherited from ​

McDbEntity.layerId

linetype ​

• get linetype(): string

Obtain the object line type name

Returns ​

string

Inherited from ​

McDbEntity.linetype

• set linetype(val): void

Set object line type name

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

Get entity object line type ID

Returns ​

McObjectId

Example

//Assuming ent is a valid instance object
const linetypeId = ent.linetypeId;

Inherited from ​

McDbEntity.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Parameters ​

Returns ​

void

Example

//Assuming ent is a valid instance object
const mxcad = MxCpp.getCurrentMxCAD();
const lineId = mxcad.addLinetypeEx("TestMyLine", '25,-5');
ent.linetypeId = lineId;

Inherited from ​

McDbEntity.linetypeId

linetypeScale ​

• get linetypeScale(): number

Obtain the proportion of object line types

Returns ​

number

Inherited from ​

McDbEntity.linetypeScale

• set linetypeScale(val): void

Set object line type scale

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

Obtain object line weight

Returns ​

number

Inherited from ​

McDbEntity.lineweight

• set lineweight(val): void

Set object line weight

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

Return the normal of the object

Returns ​

McGeVector3d

Example

Inherited from ​

McDbEntity.normal

• set normal(val): void

Set the normal of the object

Parameters ​

Returns ​

void

Example

Inherited from ​

McDbEntity.normal

objectName ​

• get objectName(): string

Get the object name.

Returns ​

string

Return object name

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.objectName

textAttachment ​

• get textAttachment(): AttachmentPoint

Get or set text attachment point

Returns ​

AttachmentPoint

Text attachment point

Example

import { McDb } from "mxcad";

//Set dim as a valid annotation entity
Dim.textAttachment=McDb. AttachmentPoin.kMiddleCenter//Set center point alignment
Console.log ("Text attachment point: ", dim.textAttachment)// 5

• set textAttachment(val): void

Parameters ​

Returns ​

void

textPosition ​

• get textPosition(): McGePoint3d

Get text location

Returns ​

McGePoint3d

Text location

Example

//Set dim as a valid annotation entity
const position = dim.textPosition;
console.log(position);

• set textPosition(pt): void

Set text position

Parameters ​

Returns ​

void

Example

//Set dim as a valid annotation entity
dim.textPosition = new McGePoint3(0,0,0);

textRotation ​

• get textRotation(): number

Get or set text rotation angle

Returns ​

number

Example

//Set dim as a valid annotation entity
dim.textRotation = Math.PI/4;
Console.log ("Rotation angle: ", dim.textRotation)

• set textRotation(val): void

Parameters ​

Returns ​

void

textStyle ​

• get textStyle(): string

Obtain the text style of the object

Returns ​

string

Inherited from ​

McDbEntity.textStyle

• set textStyle(val): void

Set object text style

Parameters ​

Returns ​

void

Example

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

Inherited from ​

McDbEntity.textStyle

textStyleId ​

• get textStyleId(): McObjectId

Get entity text style

Returns ​

McObjectId

Example

//Assuming ent is a valid instance object
const textStyleId = ent.textStyleId;

Inherited from ​

McDbEntity.textStyleId

• set textStyleId(id): void

Set the text style of the entity

Parameters ​

Returns ​

void

Example

//Assuming ent is a valid instance object
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

Obtain the color of the object

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

Set object color

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.trueColor

visible ​

• get visible(): boolean

Is the object visible

Returns ​

boolean

Inherited from ​

McDbEntity.visible

• set visible(val): void

Set whether it is visible

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

Obtain all textual content in the annotated object

Returns ​

McGeStringArray

Example

//Traverse all the text in dim
//Set dim as a valid annotation entity
let txts = dim.GetAllText();
txts.forEach((val, index) => {
  console.log(val)
});

IntersectWith ​

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Intersection with other entities to obtain the intersection point

Parameters ​

Returns ​

McGePoint3dArray

Obtain all intersection points

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

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.

Parameters ​

Returns ​

number

Example

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

Inherited from ​

McDbEntity.assertObjectModification

clone ​

▸ clone(): null | McDbObject

Clone objects.

Returns ​

null | McDbObject

The cloned object.

Example

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

Inherited from ​

McDbEntity.clone

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.createExtensionDictionary

deleteXData ​

▸ deleteXData(appName): boolean

Delete data related to entity specified application name

Parameters ​

Returns ​

boolean

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Delete successfully
}else
//Delete failed
}

Inherited from ​

McDbEntity.deleteXData

disableDisplay ​

▸ disableDisplay(isDisable): void

Disable automatic update display of objects

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

Delete object.

Returns ​

boolean

Whether the deletion was successful.

Example

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

Inherited from ​

McDbEntity.erase

explode ​

▸ explode(): MxCADResbuf

Break the object and return the linked list of the object's data after being broken

Returns ​

MxCADResbuf

Rebuf data

Example

import { McDbEntity, MxCADResbuf } from "mxcad";
//Obtain the target object
let getEnt = new MxCADUiPrEntity();
GetEnt.setMessage ("Select object to break: ");
let id = await getEnt.go();
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
//Smash objects
      let retExplode: MxCADResbuf = ent.explode();
      if (retExplode.GetCount() == 0) return;
      let iExplodeConut = retExplode.GetCount();
      for (let j = 0; j < iExplodeConut; j++) {
          let tmpobj = retExplode.AtObject(j).val;
          if(tmpobj instanceof McDbEntity ){
              mxcad.drawEntity(tmpobj);
          }
      }

Inherited from ​

McDbEntity.explode

getAllAppName ​

▸ getAllAppName(): McGeStringArray

Get the application name (AppName) of all XData records contained in the entity

Returns ​

McGeStringArray

Example

//Assuming ent is a valid instance object
const appNames = ent.getAllAppName();
console.log(appNames);

Inherited from ​

McDbEntity.getAllAppName

getArea ​

▸ getArea(): Object

Calculate Area

Returns ​

Object

Is the val area value | ret successfully obtained

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 ("Circle area: ", area)

Inherited from ​

McDbEntity.getArea

getBoundingBox ​

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the object

Returns ​

Object

Example

import { McDbText, McGePoint3d } from 'mxcad'
const text = new McDbText();
Text.textString="Test 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

Get the database where the object is located

Returns ​

McDbDatabase

Return to database

Example

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

Inherited from ​

McDbEntity.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns ​

number

Example

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

Inherited from ​

McDbEntity.getDatabaseIndexId

getDimVarDouble ​

▸ getDimVarDouble(iType): number

Get floating-point values of annotated variables

Parameters ​

Returns ​

number

Annotate variable floating-point values

getDimVarInt ​

▸ getDimVarInt(iType): number

Obtain integer values of annotated variables

Parameters ​

Returns ​

number

Annotate the integer value of the variable

getDimVarObjectId ​

▸ getDimVarObjectId(iType): McObjectId

Obtain the ID of the annotated variable object

Parameters ​

Returns ​

McObjectId

Annotate variable object ID

getDimVarString ​

▸ getDimVarString(iType): string

Get the string value of the annotation variable

Parameters ​

Returns ​

string

Annotate variable string values

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns ​

McDbDictionary

Expand dictionary data

Example

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

Inherited from ​

McDbEntity.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Returns ​

McGePoint3dArray

Example

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

Inherited from ​

McDbEntity.getGripPoints

getHandle ​

▸ getHandle(): string

Obtain object handle

Returns ​

string

Return object handle

Example

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

Inherited from ​

McDbEntity.getHandle

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Returns ​

any

Internal implementation object.

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Returns ​

string

A string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.getJson

getObjectID ​

▸ getObjectID(): McObjectId

Get the object ID.

Returns ​

McObjectId

Object ID.

Example

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

Inherited from ​

McDbEntity.getObjectID

getOwnerID ​

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns ​

number

Example

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

Inherited from ​

McDbEntity.getOwnerID

getxData ​

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Parameters ​

Returns ​

MxCADResbuf

Example

//Assuming ent is a valid instance object
const xData = ent.getXData();

Inherited from ​

McDbEntity.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

Retrieve the double value from the specified XData type of the entity

Parameters ​

Returns ​

Object

Double value

Example

//Assuming ent is a valid instance object
let data = ent.getxDataDouble("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from ​

McDbEntity.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

Retrieve the long (integer) value from the specified XData type of the entity

Parameters ​

Returns ​

Object

Long value

Example

//Assuming ent is a valid instance object
let data = ent.getxDataLong("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from ​

McDbEntity.getxDataLong

getxDataPoint ​

▸ getxDataPoint(appName): Object

Retrieve point objects from the specified XData type of entity

Parameters ​

Returns ​

Object

Obtain results and 3D point objects

Inherited from ​

McDbEntity.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

Retrieve XData information associated with a specific entity and return it in string form

Parameters ​

Returns ​

Object

Val XData information | whether ret returns success

Example

//Assuming ent is a valid instance object
let data = ent.getxDataString("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from ​

McDbEntity.getxDataString

highlight ​

▸ highlight(isHighlight): void

Set whether the object is highlighted

Parameters ​

Returns ​

void

Example

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

Inherited from ​

McDbEntity.highlight

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters ​

Returns ​

void

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.initTempObject

isErased ​

▸ isErased(): boolean

Has the object been deleted

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Parameters ​

Returns ​

boolean

Return whether the object is of the target type

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.isKindOf

isNull ​

▸ isNull(): any

Determine if it is an empty object

Returns ​

any

Example

import { McRxObject } from 'mxcad';

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

Inherited from ​

McDbEntity.isNull

isUsingDefaultTextPosition ​

▸ isUsingDefaultTextPosition(): boolean

Do you want to use the default text position

Returns ​

boolean

Do you want to use the default text position

Example

//Set dim as a valid annotation entity
const isUsing = dim.isUsingDefaultTextPosition;
if(isUsing){
//Use default text location
}else{
//Default text position not used
}

mirror ​

▸ mirror(point1, point2): boolean

Mirror oriented object

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

move objects

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

Control points for moving objects

Parameters ​

Returns ​

any

Example

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

Inherited from ​

McDbEntity.moveGripPointsAt

needToUpdateDimBlock ​

▸ needToUpdateDimBlock(need): void

Need to update annotation block

Parameters ​

Returns ​

void

recomputeDimBlock ​

▸ recomputeDimBlock(): void

Recalculate annotation blocks

Returns ​

void

Example

dim.recomputeDimBlock()

rotate ​

▸ rotate(basePoint, dRotationAngle): boolean

Rotate object

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

Scaling objects

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

Set floating-point values for annotation variables

Parameters ​

Returns ​

void

setDimVarInt ​

▸ setDimVarInt(iType, val): void

Set integer values for annotation variables

Parameters ​

Returns ​

void

setDimVarObjectId ​

▸ setDimVarObjectId(iType, val): void

Set annotation variable object ID

Parameters ​

Returns ​

void

setDimVarString ​

▸ setDimVarString(iType, val): void

Set annotation variable string value

Parameters ​

Returns ​

void

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Parameters ​

Returns ​

boolean

Is the setting successful.

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

Set extended data for objects

Parameters ​

Returns ​

boolean

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

//Set extended data
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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

Set the double value in the specified XData type of the entity

Parameters ​

Returns ​

boolean

Boolean value

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Inherited from ​

McDbEntity.setxDataDouble

setxDataLong ​

▸ setxDataLong(appName, val): boolean

Set the long (integer) value in the specified XData type of the entity

Parameters ​

Returns ​

boolean

Long value

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Inherited from ​

McDbEntity.setxDataLong

setxDataPoint ​

▸ setxDataPoint(appName, val): boolean

Set the point object in the specified XData type of the entity

Parameters ​

Returns ​

boolean

Obtain results and 3D point objects

Inherited from ​

McDbEntity.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

Set XData information associated with a specific entity and set it in string form

Parameters ​

Returns ​

boolean

Is the setting successful

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Inherited from ​

McDbEntity.setxDataString

syncData ​

▸ syncData(_toCpp?): boolean

Synchronize entity data. This method may be called after modifying the entity's attributes or attaching new data to ensure that all changes are correctly saved to the entity's database records.

Parameters ​

Returns ​

boolean

Example

//Assuming ent is a valid instance object
const res = ent.syncData(true);
if(res){
//Synchronization successful
}else{
//Synchronization failed
}

Inherited from ​

McDbEntity.syncData

transformBy ​

▸ transformBy(transformationMatrix): boolean

Transform object

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));// translation
   ent.transformBy(matrix);

Inherited from ​

McDbEntity.transformBy

unErase ​

▸ unErase(): boolean

Anti delete object.

Returns ​

boolean

Example

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

Inherited from ​

McDbEntity.unErase

updateDisplay ​

▸ updateDisplay(): void

Display the updated display of the calling object

Returns ​

void

Example

//Assuming ent is a valid instance object
ent.updateDisplay()

Inherited from ​

McDbEntity.updateDisplay

useDefaultTextPosition ​

▸ useDefaultTextPosition(): void

Use default text bits

Returns ​

void

Example

//Set dim as a valid annotation entity
dim.useDefaultTextPosition();

useSetTextPosition ​

▸ useSetTextPosition(): void

Use the set text position

Returns ​

void

Example

//Set dim as a valid annotation entity
dim.useSetTextPosition();