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

Class: McDbDiametricDimension

2d.McDbDiametricDimension

Represents a diameter annotation entity used to annotate the diameter of arcs or circles.

Description

McDbDiametricDimension provides diameter dimension annotation capability, defining diameter endpoints through chordPoint and farChordPoint, and supporting lead length and angle parameters. It can generate diameter dimensions that cross the center of the circle, suitable for diameter dimensions of circles, arcs, and other circular curves. Instructions:

Create an instance of McDbDiametricDimension and set chordPoint, farChordPoint, and leaderLength.
Call compute() to pass in the target entity and pick point.
Add the annotated object to the current drawing context for display.

Example

//Draw diameter annotation dimensions
import { MxCpp, MxCADResbuf, DxfCode, MxCADUiPrEntity, McDbRadialDimension, MxCADUiPrPoint } from "mxcad";

   async function _DrawDiametricDimension() {
       const mxcad = MxCpp.getCurrentMxCAD()
       const getEnt = new MxCADUiPrEntity();
       getEnt.setFilter(new MxCADResbuf([DxfCode.kEntityType, "ARC,CIRCLE"]));
GetEnt. setMessage ("Select Arc or Circle")
       const entId = await getEnt.go()
       if (entId.isNull()) return;
       const ent = entId.getMcDbEntity();
       if(!ent) return;

       let pick_pt = getEnt.pickPoint();

       let dim = new McDbDiametricDimension();
       dim.dimensionStyle = mxcad.database.getCurrentlyDimStyleId();
       dim.compute(ent,pick_pt);

       let getPoint = new MxCADUiPrPoint();
       getPoint.setUserDraw((currentPoint,pWorldDraw)=>{
           dim.compute(ent,currentPoint);
           pWorldDraw.drawMcDbEntity(dim,true);
       });
       if(!await getPoint.go() ) return;
       mxcad.drawEntity(dim);
   }

Hierarchy

McDbDimension
↳ McDbDiametricDimension

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new McDbDiametricDimension(imp?)

Constructor function

Parameters

Name	Type	Description
`imp?`	`Any`	Internal implementation object

Overrides

McDbDimension.constructor

Properties

imp

• imp: any = 0

Internal implementation object.

Inherited from

McDbDimension.imp

Accessors

chordPoint

• get chordPoint(): McGePoint3d

Return to the first point on the annotated curve

Returns

McGePoint3d

• set chordPoint(pt): void

Parameters

Name	Type
`pt`	`McGePoint3d`

Returns

void

colorIndex

• get colorIndex(): number

Obtain object color index

Returns

number

Inherited from

McDbDimension.colorIndex

• set colorIndex(val): void

Set object color index

Parameters

Name	Type	Description
Val	number	ColorIndexType

Returns

void

Inherited from

McDbDimension.colorIndex

dimensionStyle

• get dimensionStyle(): McObjectId

Set annotation style ID

Returns

McObjectId

Inherited from

McDbDimension.dimensionStyle

• set dimensionStyle(val): void

Parameters

Name	Type
`val`	`McObjectId`

Returns

void

Inherited from

McDbDimension.dimensionStyle

dimensionText

• get dimensionText(): string

Get or set annotation text

Returns

string

Inherited from

McDbDimension.dimensionText

• set dimensionText(val): void

Parameters

Name	Type
`val`	`string`

Returns

void

Inherited from

McDbDimension.dimensionText

drawOrder

• get drawOrder(): number

Display order of objects

Returns

number

Inherited from

McDbDimension.drawOrder

• set drawOrder(order): void

Display order of objects

Parameters

Name	Type	Description
Order	number	sequential value

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

McDbDimension.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

McDbDimension.dxf0

elevation

• get elevation(): number

Get or set height

Returns

number

Inherited from

McDbDimension.elevation

• set elevation(val): void

Parameters

Name	Type
`val`	`number`

Returns

void

Inherited from

McDbDimension.elevation

extArcEndAngle

• get extArcEndAngle(): number

Annotate the end angle of the arc

Returns

number

• set extArcEndAngle(val): void

Annotate the end angle of the arc

Parameters

Name	Type
`val`	`number`

Returns

void

extArcStartAngle

• get extArcStartAngle(): number

Annotate the starting angle of the arc

Returns

number

• set extArcStartAngle(val): void

Annotate the starting angle of the arc

Parameters

Name	Type
`val`	`number`

Returns

void

farChordPoint

• get farChordPoint(): McGePoint3d

Return the second point on the annotated curve, which is opposite to the chordPoint diameter

Returns

McGePoint3d

• set farChordPoint(pt): void

Parameters

Name	Type
`pt`	`McGePoint3d`

Returns

void

horizontalRotation

• get horizontalRotation(): number

Get or set the horizontal rotation angle

Returns

number

Horizontal rotation angle

Inherited from

McDbDimension.horizontalRotation

• set horizontalRotation(val): void

Parameters

Name	Type
`val`	`number`

Returns

void

Inherited from

McDbDimension.horizontalRotation

layer

• get layer(): string

Obtain the layer name of the object

Returns

string

Inherited from

McDbDimension.layer

• set layer(val): void

Set object layer name

Parameters

Name	Type	Description
Val	string	Layer Name

Returns

void

Inherited from

McDbDimension.layer

layerId

• get layerId(): McObjectId

Get layer ID object

Returns

McObjectId

Inherited from

McDbDimension.layerId

• set layerId(id): void

Set Layer Id Object

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

Inherited from

McDbDimension.layerId

leaderLength

• get leaderLength(): number

Label lead length

Returns

number

Label lead length

• set leaderLength(val): void

Set annotation leader length

Parameters

Name	Type	Description
Val	number	Label leader length

Returns

void

linetype

• get linetype(): string

Obtain the object line type name

Returns

string

Inherited from

McDbDimension.linetype

• set linetype(val): void

Set object line type name

Parameters

Name	Type	Description
Val	string	Line type name

Returns

void

Inherited from

McDbDimension.linetype

linetypeId

• get linetypeId(): McObjectId

Get entity object line type ID

Returns

McObjectId

Inherited from

McDbDimension.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

Inherited from

McDbDimension.linetypeId

linetypeScale

• get linetypeScale(): number

Obtain the proportion of object line types

Returns

number

Inherited from

McDbDimension.linetypeScale

• set linetypeScale(val): void

Set object line type scale

Parameters

Name	Type	Description
Val	number	Line type ratio

Returns

void

Inherited from

McDbDimension.linetypeScale

lineweight

• get lineweight(): number

Obtain object line weight

Returns

number

Inherited from

McDbDimension.lineweight

• set lineweight(val): void

Set object line weight

Parameters

Name	Type	Description
Val	number	line weight

Returns

void

Inherited from

McDbDimension.lineweight

normal

• get normal(): McGeVector3d

Return the normal of the object

Returns

McGeVector3d

Inherited from

McDbDimension.normal

• set normal(val): void

Set the normal of the object

Parameters

Name	Type
`val`	`McGeVector3d`

Returns

void

Inherited from

McDbDimension.normal

objectName

• get objectName(): string

Get the object name.

Returns

string

Return object name

Inherited from

McDbDimension.objectName

textAttachment

• get textAttachment(): AttachmentPoint

Get or set text attachment point

Returns

AttachmentPoint

Text attachment point

Inherited from

McDbDimension.textAttachment

• set textAttachment(val): void

Parameters

Name	Type
`val`	`AttachmentPoint`

Returns

void

Inherited from

McDbDimension.textAttachment

textPosition

• get textPosition(): McGePoint3d

Get text location

Returns

McGePoint3d

Text location

Inherited from

McDbDimension.textPosition

• set textPosition(pt): void

Set text position

Parameters

Name	Type	Description
Pt	McGePoint3d (2d. McGePoint3d. md)	Text Position

Returns

void

Inherited from

McDbDimension.textPosition

textRotation

• get textRotation(): number

Get or set text rotation angle

Returns

number

Inherited from

McDbDimension.textRotation

• set textRotation(val): void

Parameters

Name	Type
`val`	`number`

Returns

void

Inherited from

McDbDimension.textRotation

textStyle

• get textStyle(): string

Obtain the text style of the object

Returns

string

Inherited from

McDbDimension.textStyle

• set textStyle(val): void

Set object text style

Parameters

Name	Type	Description
Val	string	Text style name

Returns

void

Inherited from

McDbDimension.textStyle

textStyleId

• get textStyleId(): McObjectId

Get entity text style

Returns

McObjectId

Inherited from

McDbDimension.textStyleId

• set textStyleId(id): void

Set the text style of the entity

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

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 mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Inherited from

McDbDimension.textStyleId

thickness

• get thickness(): number

Obtain the thickness of the object

Returns

number

Inherited from

McDbDimension.thickness

• set thickness(val): void

Set object thickness

Parameters

Name	Type
`val`	`number`

Returns

void

Inherited from

McDbDimension.thickness

trueColor

• get trueColor(): McCmColor

Obtain the color of the object

Returns

McCmColor

Inherited from

McDbDimension.trueColor

• set trueColor(val): void

Set object color

Parameters

Name	Type
`val`	`McCmColor`

Returns

void

Inherited from

McDbDimension.trueColor

visible

• get visible(): boolean

Is the object visible

Returns

boolean

Inherited from

McDbDimension.visible

• set visible(val): void

Set whether it is visible

Parameters

Name	Type	Description
Val	boolean	Boolean value

Returns

void

Inherited from

McDbDimension.visible

Methods

GetAllText

▸ GetAllText(): McGeStringArray

Obtain all textual content in the annotated object

Returns

McGeStringArray

McGeSringArray string array

Inherited from

McDbDimension.GetAllText

IntersectWith

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Intersection with other entities to obtain the intersection point

Parameters

Name	Type	Description
IntersectObject	[McDbEntity] (2d. McDbEntity. md)	The entity object that needs to intersect is the entity object
ExOption	Intersection (../enums/2d. McDb. Intersect. md)	Intersection options

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

McDbDimension.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

Name	Type	Default value	Description
AutoUndo	boolean	false	Should this modification automatically support undo? Default is false

Returns

number

Inherited from

McDbDimension.assertObjectModification

clone

▸ clone(): null | McDbObject

Clone objects.

Returns

null | McDbObject

The cloned object.

Inherited from

McDbDimension.clone

compute

▸ compute(ent, pickPoint): boolean

Calculate annotation parameters based on the annotated object and annotation points.

Parameters

Name	Type
`ent`	`McDbEntity`
`pickPoint`	`McGePoint3d`

Returns

boolean

createExtensionDictionary

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

Inherited from

McDbDimension.createExtensionDictionary

deleteXData

▸ deleteXData(appName): boolean

Delete data related to entity specified application name

Parameters

Name	Type	Description
AppName	string	Extended Data Name

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

McDbDimension.deleteXData

disableDisplay

▸ disableDisplay(isDisable): void

Disable automatic update display of objects

Parameters

Name	Type	Description
IsDisable	boolean	Do you want to disable automatic object update display

Returns

void

Inherited from

McDbDimension.disableDisplay

erase

▸ erase(): boolean

Delete object.

Returns

boolean

Whether the deletion was successful.

Inherited from

McDbDimension.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

McDbDimension.explode

getAllAppName

▸ getAllAppName(): McGeStringArray

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

Returns

McGeStringArray

Inherited from

McDbDimension.getAllAppName

getArea

▸ getArea(): Object

Calculate Area

Returns

Object

Is the val area value | ret successfully obtained

Name	Type
`ret`	`boolean`
`val`	`number`

Example

import { McGePoint3d, McDbCircle } from "mxcad"

const circle = new McDbCircle(0,0,0, 20);
const area = circle.getArea();
Console.log ("Circle area: ", area)

Inherited from

McDbDimension.getArea

getBoundingBox

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the object

Returns

Object

Name	Type
`maxPt`	`McGePoint3d`
`minPt`	`McGePoint3d`
`ret`	`boolean`

Inherited from

McDbDimension.getBoundingBox

getDatabase

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Returns

McDbDatabase

Return to database

Inherited from

McDbDimension.getDatabase

getDatabaseIndexId

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

Inherited from

McDbDimension.getDatabaseIndexId

getDimVarDouble

▸ getDimVarDouble(iType): number

Get floating-point values of annotated variables

Parameters

Name	Type	Description
IType	Number	Annotate variable types

Returns

number

Annotate variable floating-point values

Inherited from

McDbDimension.getDimVarDouble

getDimVarInt

▸ getDimVarInt(iType): number

Obtain integer values of annotated variables

Parameters

Name	Type	Description
IType	Number	Annotate variable types

Returns

number

Annotate the integer value of the variable

Inherited from

McDbDimension.getDimVarInt

getDimVarObjectId

▸ getDimVarObjectId(iType): McObjectId

Obtain the ID of the annotated variable object

Parameters

Name	Type	Description
IType	Number	Annotate variable types

Returns

McObjectId

Annotate variable object ID

Inherited from

McDbDimension.getDimVarObjectId

getDimVarString

▸ getDimVarString(iType): string

Get the string value of the annotation variable

Parameters

Name	Type	Description
IType	Number	Annotate variable types

Returns

string

Annotate variable string values

Inherited from

McDbDimension.getDimVarString

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns

McDbDictionary

Expand dictionary data

Inherited from

McDbDimension.getExtensionDictionary

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

Retrieve the edit base point index corresponding to the grip of the object.

Returns

number[]

Inherited from

McDbDimension.getGripEditBasePointsIndex

getGripPoints

▸ getGripPoints(): McGePoint3dArray

Get the grip array of the object

number

Inherited from

McDbDimension.getOwnerID

getxData

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Parameters

Name	Type	Default value	Description
AppName	string	""	Extended Data Name

Returns

MxCADResbuf

Inherited from

McDbDimension.getxData

getxDataDouble

▸ getxDataDouble(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Double value

Name	Type
`ret`	`boolean`
`val`	`number`

Inherited from

McDbDimension.getxDataDouble

getxDataLong

▸ getxDataLong(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Long value

Name	Type
`ret`	`boolean`
`val`	`number`

Inherited from

McDbDimension.getxDataLong

getxDataPoint

▸ getxDataPoint(appName): Object

Retrieve point objects from the specified XData type of entity

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Obtain results and 3D point objects

Name	Type
`ret`	`boolean`
`val`	`McGePoint3d`

Inherited from

McDbDimension.getxDataPoint

getxDataString

▸ getxDataString(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Val XData information | whether ret returns success

Name	Type
`ret`	`boolean`
`val`	`string`

Inherited from

McDbDimension.getxDataString

highlight

▸ highlight(isHighlight): void

Set whether the object is highlighted

Parameters

Name	Type	Description
IsHighlight	boolean	Is it highlighted

Returns

void

Inherited from

McDbDimension.highlight

initTempObject

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters

Name	Type	Description
'imp'	'any'	Internal implementation object

Parameters

Name	Type	Description
SOrtName	string	Type Name

Returns

boolean

Return whether the object is of the target type

Inherited from

McDbDimension.isKindOf

isNull

▸ isNull(): any

Determine if it is an empty object

Returns

any

Inherited from

McDbDimension.isNull

isUsingDefaultTextPosition

▸ isUsingDefaultTextPosition(): boolean

Do you want to use the default text position

Returns

boolean

Do you want to use the default text position

Inherited from

McDbDimension.isUsingDefaultTextPosition

mirror

▸ mirror(point1, point2): boolean

Mirror oriented object

Parameters

Name	Type	Description
Point1	[McGePoint3d] (2d. McGePoint3d. md)	Mirror Base Point
`point2`	`McGePoint3d`	-

Returns

boolean

Inherited from

McDbDimension.mirror

move

▸ move(fromPoint, toPoint): boolean

move objects

Parameters

Name	Type	Description
From Point	[McGePoint3d] (2d. McGePoint3d. md)	Move the starting point
ToPoint	[McGePoint3d] (2d. McGePoint3d. md)	Move End Point

Returns

boolean

Inherited from

McDbDimension.move

moveGripPointsAt

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

Grips for moving objects

Parameters

Name	Type	Description
IIndex	Number	Index
DXOffset	number	X-axis offset
DYOffset	number	Y-axis offset
DZOffset	number	Z-axis offset

Returns

any

Inherited from

McDbDimension.moveGripPointsAt

needToUpdateDimBlock

▸ needToUpdateDimBlock(need): void

Need to update annotation block

Parameters

Name	Type
`need`	`boolean`

Returns

void

Inherited from

McDbDimension.needToUpdateDimBlock

recomputeDimBlock

▸ recomputeDimBlock(forceUpdate?, onlyCloneDimBlockRecord?): void

Recalculate annotation blocks

Parameters

Name	Type	Default value
`forceUpdate`	`boolean`	`true`
`onlyCloneDimBlockRecord`	`boolean`	`false`

Returns

void

Inherited from

McDbDimension.recomputeDimBlock

rotate

▸ rotate(basePoint, dRotationAngle): boolean

Rotate object

Parameters

Name	Type	Description
BasePoint	[McGePoint3d] (2d. McGePoint3d. md)	Rotate the base point
DRotationAngle	number	Rotation angle

Returns

boolean

Inherited from

McDbDimension.rotate

scaleEntity

▸ scaleEntity(basePoint, dScaleFactor): boolean

Scaling objects

Parameters

Name	Type	Description
BasePoint	[McGePoint3d] (2d. McGePoint3d. md)	Scale Base Point
DScaleFactor	number	scaling factor (<1 zoom out;>1 zoom in)

Returns

boolean

Inherited from

McDbDimension.scaleEntity

setDimVarDouble

▸ setDimVarDouble(iType, val): void

Set floating-point values for annotation variables

Parameters

Name	Type	Description
IType	Number	Annotate variable types
Val	number	Annotation variable floating-point value

Returns

void

Inherited from

McDbDimension.setDimVarDouble

setDimVarInt

▸ setDimVarInt(iType, val): void

Set integer values for annotation variables

Parameters

Name	Type	Description
IType	Number	Annotate variable types
Val	number	Annotate the integer value of the variable

Returns

void

Inherited from

McDbDimension.setDimVarInt

setDimVarObjectId

▸ setDimVarObjectId(iType, val): void

Set annotation variable object ID

Parameters

Name	Type	Description
IType	Number	Annotate variable types
Val	[McObjectid] (2d. McObjectid. md)	Annotate variable object ID

Returns

void

Inherited from

McDbDimension.setDimVarObjectId

setDimVarString

▸ setDimVarString(iType, val): void

Set annotation variable string value

Parameters

Name	Type	Description
IType	Number	Annotate variable types
Val	string	Annotate variable string value

Returns

void

Inherited from

McDbDimension.setDimVarString

setJson

▸ setJson(str): boolean

Set a string in JSON format.

Parameters

Name	Type	Description
Str	string	JSON formatted string

Returns

boolean

Is the setting successful.

Inherited from

McDbDimension.setJson

setxData

▸ setxData(xdata): boolean

Set extended data for objects

Parameters

Name	Type	Description
Xdata	[MxCADResbuf] (2d. MxCADResbuf. md)	Extended data linked list

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

McDbDimension.setxData

setxDataDouble

▸ setxDataDouble(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	number	double value

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

McDbDimension.setxDataDouble

setxDataLong

▸ setxDataLong(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	number	long value

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

McDbDimension.setxDataLong

setxDataPoint

▸ setxDataPoint(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	[McGePoint3d] (2d. McGePoint3d. md)	Point Object

Returns

boolean

Obtain results and 3D point objects

Inherited from

McDbDimension.setxDataPoint

setxDataString

▸ setxDataString(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	string	string value

Returns

boolean

Is the setting successful

Inherited from

McDbDimension.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

Name	Type	Default value	Description
_toCpp	boolean	true	Whether to synchronize data

Returns

boolean

Inherited from

McDbDimension.syncData

transformBy

▸ transformBy(transformationMatrix): boolean

Transform object

Parameters

Name	Type	Description
TransformationMatrix	[McGeMatrix3d] (2d. McGeMatrix3d. md)	Transformation Matrix

Returns

void

Inherited from

McDbDimension.useSetTextPosition

Class: McDbDiametricDimension ​

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

Parameters ​

Overrides ​

Properties ​

imp ​

Inherited from ​

Accessors ​

chordPoint ​

Returns ​

Parameters ​

Returns ​

colorIndex ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

dimensionStyle ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

dimensionText ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

drawOrder ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

dxf0 ​

Returns ​

Inherited from ​

elevation ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

extArcEndAngle ​

Returns ​

Parameters ​

Returns ​

extArcStartAngle ​

Returns ​

Parameters ​

Returns ​

farChordPoint ​

Returns ​

Parameters ​

Returns ​

horizontalRotation ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

layer ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

layerId ​

Returns ​

Inherited from ​

Parameters ​

Class: McDbDiametricDimension

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Overrides

Properties

imp

Inherited from

Accessors

chordPoint

Returns

Parameters

Returns

colorIndex

Returns

Inherited from

Parameters

Returns

Inherited from

dimensionStyle

Returns

Inherited from

Parameters

Returns

Inherited from

dimensionText

Returns

Inherited from

Parameters

Returns

Inherited from

drawOrder

Returns

Inherited from

Parameters

Returns

Inherited from

dxf0

Returns

Inherited from

elevation

Returns

Inherited from

Parameters

Returns

Inherited from

extArcEndAngle

Returns

Parameters

Returns

extArcStartAngle

Returns

Parameters

Returns

farChordPoint

Returns

Parameters

Returns

horizontalRotation

Returns

Inherited from

Parameters

Returns

Inherited from

layer

Returns

Inherited from

Parameters

Returns

Inherited from

layerId

Returns

Inherited from

Parameters