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

Class: McDbAttributeDefinition

2d.McDbAttributeDefinition

Representing block attribute definition entities, used to define attribute labels and default text in block definitions.

Description

McDbAttributeDefinition is a text attribute entity used for block definition, which supports setting labels, displaying text, position, alignment, and visibility. It is usually saved along with the block definition, and after inserting the block, it can prompt the user to enter the attribute value and display the attribute text in the graphic. Instructions:

1. Create an instance of 'McDbAttributeDefinition' and set attributes such as' tag ',' textString ',' position ', etc.
2. Append the attribute definition to the block definition object. After inserting the block reference, the system will prompt the user to fill in the attribute value and display the attribute text according to the definition.

Example

import { McDbAttributeDefinition, McGePoint3d, McCmColor, McDbBlockTableRecord, McDbBlockReference, MxCpp } from "mxcad";

const blockRecord = new McDbBlockTableRecord();
blockRecord.name = "TEST_BLOCK";
blockRecord.origin = new McGePoint3d(0, 0, 0);

const attribDef = new McDbAttributeDefinition();
attribDef.tag = "MY_TAG";
AttribDef.textString="default attribute value";
attribDef.position = new McGePoint3d(10, 10, 0);
attribDef.alignmentPoint = new McGePoint3d(10, 10, 0);
attribDef.height = 12;
attribDef.widthFactor = 1;
attribDef.trueColor = new McCmColor(255, 0, 0);
attribDef.isInvisible = false;

blockRecord.appendAcDbEntity(attribDef);

const blockRef = new McDbBlockReference();
blockRef.blockTableRecordId = blockRecord.objectId;
blockRef.position = new McGePoint3d(0, 0, 0);
MxCpp.getCurrentMxCAD().drawEntity(blockRef);

Hierarchy

• McDbText

  ↳ McDbAttributeDefinition

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• alignmentPoint
• colorIndex
• drawOrder
• dxf0
• height
• horizontalMode
• isConstant
• isInvisible
• isPreset
• isVerifiable
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• oblique
• position
• prompt
• rotation
• tag
• textString
• textStyle
• textStyleId
• thickness
• trueColor
• verticalMode
• visible
• widthFactor

Methods

• IntersectWith
• adjustAlignment
• assertObjectModification
• clone
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getArea
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• rotate
• scaleEntity
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• unErase
• updateDisplay

Constructors

constructor

• new McDbAttributeDefinition(imp?)

Constructor.

Parameters

Name	Type	Description
imp?	Any	Implement object

Overrides

McDbText.constructor

Properties

imp

• imp: any = 0

Internal implementation object.

Inherited from

McDbText.imp

Accessors

alignmentPoint

• get alignmentPoint(): McGePoint3d

Get the alignment point of the text.

Returns

McGePoint3d

Inherited from

McDbText.alignmentPoint

• set alignmentPoint(pt): void

Set the alignment point of the text.

Parameters

Name	Type	Description
Pt	McGePoint3d (2d. McGePoint3d. md)	3D point vector

Returns

void

Inherited from

McDbText.alignmentPoint

---

colorIndex

• get colorIndex(): number

Obtain object color index

Returns

number

Inherited from

McDbText.colorIndex

• set colorIndex(val): void

Set object color index

Parameters

Name	Type	Description
Val	number	ColorIndexType

Returns

void

Inherited from

McDbText.colorIndex

---

drawOrder

• get drawOrder(): number

Display order of objects

Returns

number

Inherited from

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

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

McDbText.dxf0

---

height

• get height(): number

Get the height of the text.

Returns

number

Inherited from

McDbText.height

• set height(val): void

Set text height

Parameters

Name	Type	Description
Val	number	height

Returns

void

Inherited from

McDbText.height

---

horizontalMode

• get horizontalMode(): TextHorzMode

Obtain the horizontal alignment of the text.

Returns

TextHorzMode

Inherited from

McDbText.horizontalMode

• set horizontalMode(val): void

Set the horizontal alignment of text.

Parameters

Name	Type	Description
Val	[TextHorzMode] (../enums/2d. McDb. TextHorzMode. md)	Horizontal alignment of text

Returns

void

Example

import { McDbText, McDb } from "mxcad";

const text = new McDbText();
text.horizontalMode = McDb.TextHorzMode.kTextAlign;
console.log(text.horizontalMode)//3

Inherited from

McDbText.horizontalMode

---

isConstant

• get isConstant(): boolean

Get whether the indicator property is a constant

Returns

boolean

• set isConstant(val): void

Set whether the indicator property is a constant

Parameters

Name	Type
val	boolean

Returns

void

---

isInvisible

• get isInvisible(): boolean

Get whether it is visible or not

Returns

boolean

• set isInvisible(val): void

Set whether it is visible

Parameters

Name	Type
val	boolean

Returns

void

---

isPreset

• get isPreset(): boolean

Get whether the attribute is preset

Returns

boolean

• set isPreset(val): void

Set whether the attribute is preset or not

Parameters

Name	Type
val	boolean

Returns

void

---

isVerifiable

• get isVerifiable(): boolean

Is the attribute verifiable

Returns

boolean

• set isVerifiable(val): void

Is the property verifiable

Parameters

Name	Type
val	boolean

Returns

void

---

layer

• get layer(): string

Obtain the layer name of the object

Returns

string

Inherited from

McDbText.layer

• set layer(val): void

Set object layer name

Parameters

Name	Type	Description
Val	string	Layer Name

Returns

void

Inherited from

McDbText.layer

---

layerId

• get layerId(): McObjectId

Get layer ID object

Returns

McObjectId

Inherited from

McDbText.layerId

• set layerId(id): void

Set Layer Id Object

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbText.layerId

---

linetype

• get linetype(): string

Obtain the object line type name

Returns

string

Inherited from

McDbText.linetype

• set linetype(val): void

Set object line type name

Parameters

Name	Type	Description
Val	string	Line type name

Returns

void

Inherited from

McDbText.linetype

---

linetypeId

• get linetypeId(): McObjectId

Get entity object line type ID

Returns

McObjectId

Inherited from

McDbText.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbText.linetypeId

---

linetypeScale

• get linetypeScale(): number

Obtain the proportion of object line types

Returns

number

Inherited from

McDbText.linetypeScale

• set linetypeScale(val): void

Set object line type scale

Parameters

Name	Type	Description
Val	number	Line type ratio

Returns

void

Inherited from

McDbText.linetypeScale

---

lineweight

• get lineweight(): number

Obtain object line weight

Returns

number

Inherited from

McDbText.lineweight

• set lineweight(val): void

Set object line weight

Parameters

Name	Type	Description
Val	number	line weight

Returns

void

Inherited from

McDbText.lineweight

---

normal

• get normal(): McGeVector3d

Return the normal of the object

Returns

McGeVector3d

Inherited from

McDbText.normal

• set normal(val): void

Set the normal of the object

Parameters

Name	Type
val	McGeVector3d

Returns

void

Inherited from

McDbText.normal

---

objectName

• get objectName(): string

Get the object name.

Returns

string

Return object name

Inherited from

McDbText.objectName

---

oblique

• get oblique(): number

Obtain the tilt angle of the text.

Returns

number

Inherited from

McDbText.oblique

• set oblique(val): void

Set the tilt angle of the text.

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbText.oblique

---

position

• get position(): McGePoint3d

Retrieve the location of the text.

Returns

McGePoint3d

Inherited from

McDbText.position

• set position(pt): void

Set the position of the text.

Parameters

Name	Type	Description
Pt	McGePoint3d (2d. McGePoint3d. md)	3D point vector

Returns

void

Inherited from

McDbText.position

---

prompt

• get prompt(): string

When obtaining an inserted block instance, prompt the user to enter the text of the value

Returns

string

• set prompt(val): void

When setting the insertion block instance, prompt the user to enter the text of the value

Parameters

Name	Type
val	string

Returns

void

---

rotation

• get rotation(): number

Get the rotation angle of the text.

Returns

number

Inherited from

McDbText.rotation

• set rotation(pt): void

Set the rotation angle of the text.

Parameters

Name	Type
pt	number

Returns

void

Inherited from

McDbText.rotation

---

tag

• get tag(): string

Retrieve a string of text.

Returns

string

• set tag(val): void

Set the string of text

Parameters

Name	Type
val	string

Returns

void

---

textString

• get textString(): string

Retrieve a string of text.

Returns

string

Inherited from

McDbText.textString

• set textString(val): void

Set the string of text.

Parameters

Name	Type	Description
Val	string	string

Returns

void

Inherited from

McDbText.textString

---

textStyle

• get textStyle(): string

Obtain the text style of the object

Returns

string

Inherited from

McDbText.textStyle

• set textStyle(val): void

Set object text style

Parameters

Name	Type	Description
Val	string	Text style name

Returns

void

Inherited from

McDbText.textStyle

---

textStyleId

• get textStyleId(): McObjectId

Get entity text style

Returns

McObjectId

Inherited from

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

McDbText.textStyleId

---

thickness

• get thickness(): number

Obtain the thickness of the object

Returns

number

Inherited from

McDbText.thickness

• set thickness(val): void

Set object thickness

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbText.thickness

---

trueColor

• get trueColor(): McCmColor

Obtain the color of the object

Returns

McCmColor

Inherited from

McDbText.trueColor

• set trueColor(val): void

Set object color

Parameters

Name	Type
val	McCmColor

Returns

void

Inherited from

McDbText.trueColor

---

verticalMode

• get verticalMode(): TextVertMode

Get the vertical alignment of the text.

Returns

TextVertMode

Inherited from

McDbText.verticalMode

• set verticalMode(val): void

Set the vertical alignment of text.

Parameters

Name	Type	Description
Val	[TextVertMode] (../enums/2d. McDb. TextVertMode. md)	Vertical alignment of text

Returns

void

Example

import { McDbText, McDb } from "mxcad";

const text = new McDbText();
text.verticalMode = McDb.TextVertMode.kTextVertMid;
console.log(text.verticalMode)//2

Inherited from

McDbText.verticalMode

---

visible

• get visible(): boolean

Is the object visible

Returns

boolean

Inherited from

McDbText.visible

• set visible(val): void

Set whether it is visible

Parameters

Name	Type	Description
Val	boolean	Boolean value

Returns

void

Inherited from

McDbText.visible

---

widthFactor

• get widthFactor(): number

Get the width factor of the text.

Returns

number

Inherited from

McDbText.widthFactor

• set widthFactor(val): void

Set the width factor of the text.

Parameters

Name	Type	Description
Val	number	width factor

Returns

void

Inherited from

McDbText.widthFactor

Methods

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

McDbText.IntersectWith

---

adjustAlignment

▸ adjustAlignment(): void

Calculate the text position based on the current text alignment method and alignment point.

Returns

void

Inherited from

McDbText.adjustAlignment

---

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

McDbText.assertObjectModification

---

clone

▸ clone(): null | McDbObject

Clone objects.

Returns

null | McDbObject

The cloned object.

Inherited from

McDbText.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

Inherited from

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

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

McDbText.disableDisplay

---

erase

▸ erase(): boolean

Delete object.

Returns

boolean

Whether the deletion was successful.

Inherited from

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

McDbText.explode

---

getAllAppName

▸ getAllAppName(): McGeStringArray

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

Returns

McGeStringArray

Inherited from

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

McDbText.getArea

---

getBoundingBox

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the object

Returns

Object

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

Inherited from

McDbText.getBoundingBox

---

getDatabase

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Returns

McDbDatabase

Return to database

Inherited from

McDbText.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

Inherited from

McDbText.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns

McDbDictionary

Expand dictionary data

Inherited from

McDbText.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

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

Returns

number[]

Inherited from

McDbText.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

Get the grip array of the object

Returns

McGePoint3dArray

Inherited from

McDbText.getGripPoints

---

getHandle

▸ getHandle(): string

Obtain object handle

Returns

string

Return object handle

Inherited from

McDbText.getHandle

---

getImp

▸ getImp(): any

Retrieve internal implementation objects.

Returns

any

Internal implementation object.

Inherited from

McDbText.getImp

---

getJson

▸ getJson(): string

Retrieve a string in JSON format.

Returns

string

A string in JSON format.

Inherited from

McDbText.getJson

---

getObjectID

▸ getObjectID(): McObjectId

Get the object ID.

Returns

McObjectId

Object ID.

Inherited from

McDbText.getObjectID

---

getOwnerID

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns

number

Inherited from

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

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

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

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

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

McDbText.getxDataString

---

highlight

▸ highlight(isHighlight): void

Set whether the object is highlighted

Parameters

Name	Type	Description
IsHighlight	boolean	Is it highlighted

Returns

void

Inherited from

McDbText.highlight

---

initTempObject

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters

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

Returns

void

Inherited from

McDbText.initTempObject

---

isErased

▸ isErased(): boolean

Has the object been deleted

Returns

boolean

Inherited from

McDbText.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns

boolean

Inherited from

McDbText.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

Determine object type

Parameters

Name	Type	Description
SOrtName	string	Type Name

Returns

boolean

Return whether the object is of the target type

Inherited from

McDbText.isKindOf

---

isNull

▸ isNull(): any

Determine if it is an empty object

Returns

any

Inherited from

McDbText.isNull

---

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

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

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

McDbText.moveGripPointsAt

---

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

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

McDbText.scaleEntity

---

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

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

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

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

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

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

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

McDbText.syncData

---

transformBy

▸ transformBy(transformationMatrix): boolean

Transform object

Parameters

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

Returns

boolean

Inherited from

McDbText.transformBy

---

unErase

▸ unErase(): boolean

Anti delete object.

Returns

boolean

Inherited from

McDbText.unErase

---

updateDisplay

▸ updateDisplay(): void

Display the updated display of the calling object

Returns

void

Inherited from

McDbText.updateDisplay