[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/McDbAttribute
Class: McDbAttribute
2d.McDbAttribute
Attribute definition text class in block reference
Example
import { McDbBlockReference, McDbAttribute } from "mxcad"
//Traverse the attribute text ent in the block: block entity
let blkRef: McDbBlockReference = ent;
let aryId = blkRef.getAllAttribute();
aryId.forEach((id) => {
let attribt: McDbAttribute = id.getMcDbEntity() as any;
console.log(attribt.textString);
console.log(attribt.tag);
})
//Insert attribute text ent: block entity in the block
let blkRef: McDbBlockReference = ent;
const blkrecId = blkRef.blockTableRecordId; // Retrieve the block table record ID
let blkRecord: any = blkrecId.getMcDbBlockTableRecord();// Retrieve block table record object
let ids = blkRecord.getAllEntityId(); // Retrieve all instance object IDs from the block table record
ids.forEach((id: any, index: any) => {
//Filter McDbAttributeDefinition objects
if (!id.isKindOf("McDbAttributeDefinition")) return;
let attribDef = id.getMcDbEntity() as McDbAttributeDefinition;
let tag = attribDef.tag; // Get attribute labels
let txt = attribDef.textString; // Retrieve the string of text
let attrib = new McDbAttribute(); // Construct a new attribute definition text object
attrib.position = attribDef.position; // Set object position
Attribution. alignmentPoint=attribution Def. alignmentPoint//Set object alignment position
attrib.height = attribDef.height ; // Set object font height
Attributes. trueColor=attributes Def. trueColor//Set object color
attrib.widthFactor = attribDef.widthFactor; // Set object width factor
//Set the string of text
if (txt.length > 0) attrib.textString = txt;
else attrib.textString = "test" + index;
attrib.tag = tag;// Set attribute labels
attrib.isInvisible = attribDef.isInvisible;
attrib.transformBy(blkRef.blockTransform); // Block conversion
attrib = blkRef.appendAttribute(attrib).getMcDbEntity() as McDbAttribute;
attrib.textStyle = attribDef.textStyle
attrib.layer = attribDef.layer
})
Hierarchy
↳
McDbAttribute
Table of contents
Constructors
Properties
Accessors
- alignmentPoint
- colorIndex
- drawOrder
- dxf0
- height
- horizontalMode
- isInvisible
- layer
- layerId
- linetype
- linetypeId
- linetypeScale
- lineweight
- normal
- objectName
- oblique
- position
- rotation
- tag
- textString
- textStyle
- textStyleId
- trueColor
- verticalMode
- visible
- widthFactor
Methods
- IntersectWith
- assertObjectModification
- clone
- createExtensionDictionary
- deleteXData
- disableDisplay
- erase
- explode
- getAllAppName
- getArea
- getBoundingBox
- getDatabase
- getDatabaseIndexId
- getExtensionDictionary
- 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 McDbAttribute(imp?
)
Constructor.
Parameters
Name | Type | Description |
---|---|---|
imp? | Any | Implement object |
Example
import { McDbAttribute } from "mxcad";
const attrib = new McDbAttribute();
Overrides
Properties
imp
• imp: any
= 0
Internal implementation object.
Inherited from
Accessors
alignmentPoint
• get
alignmentPoint(): McGePoint3d
Get the alignment point of the text.
Returns
Example
//Assuming text is a valid text entity
const alignmentPoint = text.alignmentPoint;
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
Example
import { McDbText, McGePoint3d } from "mxcad";
const text = new McDbText();
text.alignmentPoint = new McGePoint3d(0,0,0);
console.log(text.alignmentPoint)//(0,0,0)
Inherited from
McDbText.alignmentPoint
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
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
Example
//Assuming ent is a valid instance object
const order = ent.drawOrder();
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
Example
//Assuming text is a valid text entity
const height = text.height;
Inherited from
McDbText.height
• set
height(val
): void
Set text height
Parameters
Name | Type | Description |
---|---|---|
Val | number | height |
Returns
void
Example
import { McDbText } from "mxcad";
const text = new McDbText();
text.height = 20;
console.log(text.height)//20
Inherited from
McDbText.height
horizontalMode
• get
horizontalMode(): TextHorzMode
Obtain the horizontal alignment of the text.
Returns
Example
//Assuming text is a valid text entity
const horizontalMode = text.horizontalMode;
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
isInvisible
• get
isInvisible(): boolean
Obtain whether the block attribute text is visible
Returns
boolean
Example
import { McDbAttribute } from "mxcad";
const attrib = new McDbAttribute();
const isV = attrib.isInvisible;
if(isV){
//Visible attributes
}else{
//Attribute is not visible
}
• set
isInvisible(val
): void
Set whether block attribute text is invisible
Parameters
Name | Type |
---|---|
val | boolean |
Returns
void
Example
import { McDbAttribute } from "mxcad";
const attrib = new McDbAttribute();
attrib.isInvisible = false;// Set attribute visibility
attrib.isInvisible = true;// Setting attributes to be invisible
___
### 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`
**`Example`**
```ts
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity();
ent.layer = "newLayerName";
console.log(ent.layer)
Inherited from
McDbText.layer
layerId
• get
layerId(): McObjectId
Get layer ID object
Returns
Example
//Assuming ent is a valid instance object
const layerId = ent.layerId;
Inherited from
McDbText.layerId
• set
layerId(id
): void
Set Layer Id Object
Parameters
Name | Type |
---|---|
id | McObjectId |
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
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
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)
Inherited from
McDbText.linetype
linetypeId
• get
linetypeId(): McObjectId
Get entity object line type ID
Returns
Example
//Assuming ent is a valid instance object
const linetypeId = ent.linetypeId;
Inherited from
McDbText.linetypeId
• set
linetypeId(id
): void
Set entity object line type ID
Parameters
Name | Type |
---|---|
id | McObjectId |
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
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
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetypeScale = 0.8;
console.log(ent.linetypeScale)
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
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.lineweight = 20;
console.log(ent.lineweight)
Inherited from
McDbText.lineweight
normal
• get
normal(): McGeVector3d
Return the normal of the object
Returns
Example
Inherited from
McDbText.normal
• set
normal(val
): void
Set the normal of the object
Parameters
Name | Type |
---|---|
val | McGeVector3d |
Returns
void
Example
Inherited from
McDbText.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
McDbText.objectName
oblique
• get
oblique(): number
Obtain the tilt angle of the text.
Returns
number
Example
//Assuming text is a valid text entity
const oblique = text.oblique;
Inherited from
McDbText.oblique
• set
oblique(val
): void
Set the tilt angle of the text.
Parameters
Name | Type |
---|---|
val | number |
Returns
void
Example
import { McDbText } from "mxcad";
const text = new McDbText();
text.oblique = Math.PI/4;
console.log(text.oblique)//45
Inherited from
McDbText.oblique
position
• get
position(): McGePoint3d
Retrieve the location of the text.
Returns
Example
//Assuming text is a valid text entity
const position = text.position;
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
Example
import { McDbText, McGePoint3d } from "mxcad";
const text = new McDbText();
text.position = new McGePoint3d(0,0,0);
console.log(text.position)//(0,0,0)
Inherited from
McDbText.position
rotation
• get
rotation(): number
Get the rotation angle of the text.
Returns
number
Example
//Assuming text is a valid text entity
const rotation = text.rotation;
Inherited from
McDbText.rotation
• set
rotation(pt
): void
Set the rotation angle of the text.
Parameters
Name | Type |
---|---|
pt | number |
Returns
void
Example
import { McDbText } from "mxcad";
const text = new McDbText();
text.rotation = Math.PI/4;
console.log(text.rotation)//45
Inherited from
McDbText.rotation
tag
• get
tag(): string
Retrieve a string of text.
Returns
string
Example
import { McDbAttribute } from "mxcad";
const attrib = new McDbAttribute();
const tag = attrib.tag;
• set
tag(val
): void
Set the string of text.
Parameters
Name | Type |
---|---|
val | string |
Returns
void
Example
import { McDbAttribute } from "mxcad";
const attrib = new McDbAttribute();
attrib.tag = "example_tag"
textString
• get
textString(): string
Retrieve a string of text.
Returns
string
Example
//Assuming text is a valid text entity
const textString = text.textString;
Inherited from
McDbText.textString
• set
textString(val
): void
Set the string of text.
Parameters
Name | Type | Description |
---|---|---|
Val | string | string |
Returns
void
Example
import { McDbText } from "mxcad";
const text = new McDbText();
Text.textString="Test Text";
Console. log (text. textString)//Test Text
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
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.textStyle = "st_style";
Inherited from
McDbText.textStyle
textStyleId
• get
textStyleId(): McObjectId
Get entity text style
Returns
Example
//Assuming ent is a valid instance object
const textStyleId = ent.textStyleId;
Inherited from
McDbText.textStyleId
• set
textStyleId(id
): void
Set the text style of the entity
Parameters
Name | Type |
---|---|
id | McObjectId |
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
McDbText.textStyleId
trueColor
• get
trueColor(): McCmColor
Obtain the color of the object
Returns
Example
import { McDbEntity, McCmColor} from 'mxcad'
const ent = new McDbEntity();
ent.trueColor = new McCmColor(255, 0, 0);
console.log(ent.trueColor)
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
Example
//Assuming text is a valid text entity
const verticalMode = text.verticalMode;
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
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.visible = true;
console.log(ent.visible)
Inherited from
McDbText.visible
widthFactor
• get
widthFactor(): number
Get the width factor of the text.
Returns
number
Example
//Assuming text is a valid text entity
const widthFactor = text.widthFactor;
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
Example
import { McDbText } from "mxcad";
const text = new McDbText();
text.height = 0.8;
console.log(text.height)//0.8
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
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
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 |
---|---|---|
autoUndo | boolean | false |
Returns
number
Example
//Assuming obj is a database object
obj.assertObjectModification()
Inherited from
McDbText.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
createExtensionDictionary
▸ createExtensionDictionary(): boolean
Create extended dictionary data for objects
Returns
boolean
Example
//Assuming obj is a database object
const res = obj.createExtensionDictionary();
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
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
Example
import { McDbLine } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
line1.disableDisplay(true)
Inherited from
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
explode
▸ explode(): MxCADResbuf
Break the object and return the linked list of the object's data after being broken
Returns
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
getAllAppName
▸ getAllAppName(): McGeStringArray
Get the application name (AppName) of all XData records contained in the entity
Returns
Example
//Assuming ent is a valid instance object
const appNames = ent.getAllAppName();
console.log(appNames);
Inherited from
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 center = new McGePoint3d(0,0,0);
const circle = new McDbCircle(center, 20);
const area = circle.getArea();
Console.log ("Circle area: ", area)
Inherited from
getBoundingBox
▸ getBoundingBox(): Object
Obtain the minimum outsourcing of the object
Returns
Object
Name | Type |
---|---|
maxPt | McGePoint3d |
minPt | McGePoint3d |
ret | boolean |
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
getDatabase
▸ getDatabase(): McDbDatabase
Get the database where the object is located
Returns
Return to database
Example
//Assuming obj is a database object
const data = obj.getDatabase();
Inherited from
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
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
Obtain the extended dictionary data of the object
Returns
Expand dictionary data
Example
//Assuming obj is a database object
const id = obj.getOwnerID();
Inherited from
McDbText.getExtensionDictionary
getGripPoints
▸ getGripPoints(): McGePoint3dArray
Get the control points of the object
Returns
Example
//Assuming obj is a database object
const ptArr = obj.getGripPoints();
Inherited from
getHandle
▸ getHandle(): string
Obtain object handle
Returns
string
Return object handle
Example
//Assuming obj is a database object
const handle = obj.getHandle();
Inherited from
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
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
getObjectID
▸ getObjectID(): McObjectId
Get the object ID.
Returns
Object ID.
Example
import { McDbObject } from "mxcad";
const id = obj.getObjectID();
Inherited from
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
getxData
▸ getxData(appName?
): MxCADResbuf
Obtain the extended data of the object
Parameters
Name | Type | Default value | Description |
---|---|---|---|
AppName | string | "" | Extended Data Name |
Returns
Example
//Assuming ent is a valid instance object
const xData = ent.getXData();
Inherited from
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 |
Example
//Assuming ent is a valid instance object
let data = ent.getxDataDouble("DataName");
if(data.ret){
console.log(data.val)
}
Inherited from
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 |
Example
//Assuming ent is a valid instance object
let data = ent.getxDataLong("DataName");
if(data.ret){
console.log(data.val)
}
Inherited from
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
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 |
Example
//Assuming ent is a valid instance object
let data = ent.getxDataString("DataName");
if(data.ret){
console.log(data.val)
}
Inherited from
highlight
▸ highlight(isHighlight
): void
Set whether the object is highlighted
Parameters
Name | Type | Description |
---|---|---|
IsHighlight | boolean | Is it highlighted |
Returns
void
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.highlight(true);
Inherited from
initTempObject
▸ initTempObject(imp
): void
Initialize temporary objects.
Parameters
Name | Type | Description |
---|---|---|
'imp' | 'any' | Internal implementation object |
Returns
void
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
obj.initTempObject()
Inherited from
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
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
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
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // Output: True or false
Inherited from
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
mirror
▸ mirror(point1
, point2
): boolean
Mirror oriented object
Parameters
Name | Type | Description |
---|---|---|
Point1 | [McGePoint3d] (2d. McGePoint3d. md) | Mirror Base Point |
point2 | McGePoint3d | - |
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
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
Example
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.move(new McGePoint3d(0,0,0), new McGePoint3d(20,0,0))
Inherited from
moveGripPointsAt
▸ moveGripPointsAt(iIndex
, dXOffset
, dYOffset
, dZOffset
): any
Control points 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
Example
//Assuming obj is a database object
obj.moveGripPointsAt(1,10,10,10);
Inherited from
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
Example
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.rotate(new McGePoint3d(0,0,0), Math.PI)
Inherited from
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
Example
import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.scaleEntity(new McGePoint3d(0,0,0), 0.5)
Inherited from
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.
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)
Inherited from
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
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
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
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
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
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
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
Example
//Assuming ent is a valid instance object
const res = ent.syncData(true);
if(res){
//Synchronization successful
}else{
//Synchronization failed
}
Inherited from
transformBy
▸ transformBy(transformationMatrix
): boolean
Transform object
Parameters
Name | Type | Description |
---|---|---|
TransformationMatrix | [McGeMatrix3d] (2d. McGeMatrix3d. md) | Transformation Matrix |
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
unErase
▸ unErase(): boolean
Anti delete object.
Returns
boolean
Example
//Assuming obj is a database object
const res = obj.unErase();
console.log(res);
Inherited from
updateDisplay
▸ updateDisplay(): void
Display the updated display of the calling object
Returns
void
Example
//Assuming ent is a valid instance object
ent.updateDisplay()