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

Class: MxCADMText ​

2d.MxCADMText

Custom Editor Entity Class Used for rendering and managing rich text editors in CAD

Hierarchy ​

• McDbCustomEntity

  ↳ MxCADMText

Table of contents ​

Constructors ​

• constructor

Properties ​

• convertCadPointToSlatePoint
• convertSlatePointToCadPoint
• imp
• transformBy
• worldDraw
• elementTextManager
• fromMText
• toMText

Accessors ​

• angle
• colorIndex
• data
• drawOrder
• dxf0
• height
• isWordWrap
• layer
• layerId
• lineHeightRatio
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• pt1
• pt2
• textAlignment
• textStyle
• textStyleId
• trueColor
• visible

Methods ​

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

Constructors ​

constructor ​

• new MxCADMText(imp?)

Parameters ​

Overrides ​

McDbCustomEntity.constructor

Properties ​

convertCadPointToSlatePoint ​

• convertCadPointToSlatePoint: (this: MxCADMText, point: McGePoint3d) => { offset: number ; path: number[] } | null = convertCadPointToSlatePoint

Type declaration ​

▸ (this, point): { offset: number ; path: number[] } | null

Convert CAD coordinates to Slate's Point position

Parameters ​

Returns ​

{ offset: number ; path: number[] } | null

convertSlatePointToCadPoint ​

• convertSlatePointToCadPoint: (this: MxCADMText, point: IMxEditorPoint) => { lineIndex: number ; point: McGePoint3d } | null = convertSlatePointToCadPoint

Type declaration ​

▸ (this, point): { lineIndex: number ; point: McGePoint3d } | null

Convert Slate's Point position to CAD coordinates

Parameters ​

Returns ​

{ lineIndex: number ; point: McGePoint3d } | null

imp ​

• imp: any = 0

Internal implementation object.

Inherited from ​

McDbCustomEntity.imp

transformBy ​

• transformBy: (this: MxCADMText, met: McGeMatrix3d) => boolean = transformBy

Type declaration ​

▸ (this, met): boolean

Application of Matrix Transformation

Parameters ​

Returns ​

boolean

Overrides ​

McDbCustomEntity.transformBy

worldDraw ​

• worldDraw: (this: MxCADMText, draw: MxCADWorldDraw) => void = worldDraw

Type declaration ​

▸ (this, draw): void

Entity rendering function

Parameters ​

Returns ​

void

Overrides ​

McDbCustomEntity.worldDraw

elementTextManager ​

▪ Static elementTextManager: ElementTextManager

fromMText ​

▪ Static fromMText: (mtext: McDbMText) => MxCADMText = MultilineTextConverter.fromMText

Type declaration ​

▸ (mtext): MxCADMText

Convert McDbMText to MxCADMText

Parameters ​

Returns ​

MxCADMText

toMText ​

▪ Static toMText: (mtext: McDbMText, customEntity: MxCADMText) => McDbMText = MultilineTextConverter.toMText

Type declaration ​

▸ (mtext, customEntity): McDbMText

Convert MxCADMText to McDBMText

Parameters ​

Returns ​

McDbMText

Accessors ​

angle ​

• get angle(): number

Returns ​

number

• set angle(angle): void

Parameters ​

Returns ​

void

colorIndex ​

• get colorIndex(): number

Obtain object color index

Example

import { McDbEntity, ColorIndexType } from 'mxcad'
 const ent = new McDbEntity();
 ent.colorIndex = ColorIndexType.kByblock;
 console.log(ent.colorIndex)

Returns ​

number

Inherited from ​

McDbCustomEntity.colorIndex

• set colorIndex(val): void

Set object color index

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.colorIndex

data ​

• get data(): IMxEditorDescendant[]

Returns ​

IMxEditorDescendant[]

• set data(val): void

Parameters ​

Returns ​

void

drawOrder ​

• get drawOrder(): number

Display order of objects

Example

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

Returns ​

number

Inherited from ​

McDbCustomEntity.drawOrder

• set drawOrder(order): void

Display order of objects

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;
  }
})

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.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 ​

McDbCustomEntity.dxf0

height ​

• get height(): number

Returns ​

number

• set height(val): void

Parameters ​

Returns ​

void

isWordWrap ​

• get isWordWrap(): boolean

Returns ​

boolean

• set isWordWrap(value): void

Set auto wrap

Parameters ​

Returns ​

void

layer ​

• get layer(): string

Obtain the layer name of the object

Returns ​

string

Inherited from ​

McDbCustomEntity.layer

• set layer(val): void

Set object layer name

Example

import { McDbEntity } from 'mxcad'
 const ent = new McDbEntity();
 ent.layer = "newLayerName";
 console.log(ent.layer)

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.layer

layerId ​

• get layerId(): McObjectId

Get layer ID object

Example

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

Returns ​

McObjectId

Inherited from ​

McDbCustomEntity.layerId

• set layerId(id): void

Set Layer Id Object

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.layerId

lineHeightRatio ​

• get lineHeightRatio(): number

Returns ​

number

• set lineHeightRatio(ratio): void

Parameters ​

Returns ​

void

linetype ​

• get linetype(): string

Obtain the object line type name

Returns ​

string

Inherited from ​

McDbCustomEntity.linetype

• set linetype(val): void

Set object line type name

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.linetype

linetypeId ​

• get linetypeId(): McObjectId

Get entity object line type ID

Example

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

Returns ​

McObjectId

Inherited from ​

McDbCustomEntity.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.linetypeId

linetypeScale ​

• get linetypeScale(): number

Obtain the proportion of object line types

Returns ​

number

Inherited from ​

McDbCustomEntity.linetypeScale

• set linetypeScale(val): void

Set object line type scale

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.linetypeScale

lineweight ​

• get lineweight(): number

Obtain object line weight

Returns ​

number

Inherited from ​

McDbCustomEntity.lineweight

• set lineweight(val): void

Set object line weight

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.lineweight

normal ​

• get normal(): McGeVector3d

Return the normal of the object

Example

Returns ​

McGeVector3d

Inherited from ​

McDbCustomEntity.normal

• set normal(val): void

Set the normal of the object

Example

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.normal

objectName ​

• get objectName(): string

Get the object name.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

Return object name

Inherited from ​

McDbCustomEntity.objectName

pt1 ​

• get pt1(): McGePoint3d

Returns ​

McGePoint3d

• set pt1(val): void

Parameters ​

Returns ​

void

pt2 ​

• get pt2(): McGePoint3d

Returns ​

McGePoint3d

• set pt2(val): void

Parameters ​

Returns ​

void

textAlignment ​

• get textAlignment(): AttachmentPoint

Returns ​

AttachmentPoint

• set textAlignment(alignment): void

Parameters ​

Returns ​

void

textStyle ​

• get textStyle(): string

Obtain the text style of the object

Returns ​

string

Inherited from ​

McDbCustomEntity.textStyle

• set textStyle(val): void

Set object text style

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.textStyle

textStyleId ​

• get textStyleId(): McObjectId

Get entity text style

Example

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

Returns ​

McObjectId

Inherited from ​

McDbCustomEntity.textStyleId

• set textStyleId(id): void

Set the text style of the entity

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;

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.textStyleId

trueColor ​

• get trueColor(): McCmColor

Obtain the color of the object

Example

import { McDbEntity, McCmColor} from 'mxcad'
 const ent = new McDbEntity();
 ent.trueColor = new McCmColor(255, 0, 0);
 console.log(ent.trueColor)

Returns ​

McCmColor

Inherited from ​

McDbCustomEntity.trueColor

• set trueColor(val): void

Set object color

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.trueColor

visible ​

• get visible(): boolean

Is the object visible

Returns ​

boolean

Inherited from ​

McDbCustomEntity.visible

• set visible(val): void

Set whether it is visible

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.visible

Methods ​

IntersectWith ​

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Intersection with other entities to obtain the intersection point

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)

Parameters ​

Returns ​

McGePoint3dArray

Obtain all intersection points

Inherited from ​

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

Example

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

Parameters ​

Returns ​

number

Inherited from ​

McDbCustomEntity.assertObjectModification

clone ​

▸ clone(): null | McDbObject

Copy entity

Example

import { McDbCustomEntity } from "mxcad";

const customEnt = new McDbCustomEntity();//  Construct a new custom entity object
const cloneEnt = customEnt.clone();//  Copy entity

Returns ​

null | McDbObject

Inherited from ​

McDbCustomEntity.clone

create ​

▸ create(imp): MxCADMText

Create a new custom object (by default, call its constructor to create a new object)

Parameters ​

Returns ​

MxCADMText

Overrides ​

McDbCustomEntity.create

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Example

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

Returns ​

boolean

Inherited from ​

McDbCustomEntity.createExtensionDictionary

deleteXData ​

▸ deleteXData(appName): boolean

Delete data related to entity specified application name

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
}

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.deleteXData

disableDisplay ​

▸ disableDisplay(isDisable): void

Disable automatic update display of objects

Example

import { McDbLine } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
line1.disableDisplay(true)

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.disableDisplay

dwgInFields ​

▸ dwgInFields(filter): boolean

Read custom entity data fields from DWG files

Example

import { McDbCustomEntity, IMcDbDwgFiler } from 'mxcad'
//Create a new McDbTestLineCustomizing Entity class to inherit McDbCustomizing Entity
 class McDbTestLineCustomEntity extends McDbCustomEntity {
//Define the point object pt1 inside McDbtTestLineCustomizing Entity pt2
   private pt1: McGePoint3d = new McGePoint3d();
   private pt2: McGePoint3d = new McGePoint3d(); 
//Read the data field pt1 of the custom entity pt2
   public dwgInFields(filter: IMcDbDwgFiler): boolean {
   this.pt1 = filter.readPoint("pt1").val;
   this.pt2 = filter.readPoint("pt2").val;
   return true;
   }
 }

Parameters ​

Returns ​

boolean

Overrides ​

McDbCustomEntity.dwgInFields

dwgOutFields ​

▸ dwgOutFields(filter): boolean

Write the data fields of custom entities to a DWG file

Example

//Create a new McDbTestLineCustomizing Entity class to inherit McDbCustomizing Entity
 import { McDbCustomEntity, IMcDbDwgFiler } from 'mxcad'
 class McDbTestLineCustomEntity extends McDbCustomEntity {
//Define the point object pt1 inside McDbtTestLineCustomizing Entity pt2
   private pt1: McGePoint3d = new McGePoint3d();
   private pt2: McGePoint3d = new McGePoint3d();
//Write the data field pt1 to the custom entity pt2
   public dwgOutFields(filter: IMcDbDwgFiler): boolean {
       filter.writePoint("pt1", this.pt1);
       filter.writePoint("pt2", this.pt2);
       return true;
   }
   }

Parameters ​

Returns ​

boolean

Overrides ​

McDbCustomEntity.dwgOutFields

erase ​

▸ erase(): boolean

Delete object.

Example

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

Returns ​

boolean

Whether the deletion was successful.

Inherited from ​

McDbCustomEntity.erase

explode ​

▸ explode(): MxCADResbuf

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

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);
          }
      }

Returns ​

MxCADResbuf

Rebuf data

Inherited from ​

McDbCustomEntity.explode

getAllAppName ​

▸ getAllAppName(): McGeStringArray

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

Example

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

Returns ​

McGeStringArray

Inherited from ​

McDbCustomEntity.getAllAppName

getArea ​

▸ getArea(): Object

Calculate Area

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)

Returns ​

Object

Is the val area value | ret successfully obtained

Inherited from ​

McDbCustomEntity.getArea

getBoundingBox ​

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the 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()

Returns ​

Object

Inherited from ​

McDbCustomEntity.getBoundingBox

getDatabase ​

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Example

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

Returns ​

McDbDatabase

Return to database

Inherited from ​

McDbCustomEntity.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

Get the index ID of the object

Example

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

Returns ​

number

Inherited from ​

McDbCustomEntity.getDatabaseIndexId

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Example

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

Returns ​

McDbDictionary

Expand dictionary data

Inherited from ​

McDbCustomEntity.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

Get the grip of the custom object.

Returns ​

McGePoint3dArray

Pinch object array

Overrides ​

McDbCustomEntity.getGripPoints

getHandle ​

▸ getHandle(): string

Obtain object handle

Example

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

Returns ​

string

Return object handle

Inherited from ​

McDbCustomEntity.getHandle

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Internal implementation object.

Inherited from ​

McDbCustomEntity.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

A string in JSON format.

Inherited from ​

McDbCustomEntity.getJson

getMTextImp ​

▸ getMTextImp(): MxCADMTextImp

Returns ​

MxCADMTextImp

getName ​

▸ getName(): string

Get custom object name

Returns ​

string

Overrides ​

McDbCustomEntity.getName

getObjectID ​

▸ getObjectID(): McObjectId

Get the object ID.

Example

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

Returns ​

McObjectId

Object ID.

Inherited from ​

McDbCustomEntity.getObjectID

getOwnerID ​

▸ getOwnerID(): number

Obtain the ID of the object owner

Example

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

Returns ​

number

Inherited from ​

McDbCustomEntity.getOwnerID

getTypeName ​

▸ getTypeName(): string

Get the type name of the custom entity.

Returns ​

string

Custom entity type name

Overrides ​

McDbCustomEntity.getTypeName

getxData ​

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Example

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

Parameters ​

Returns ​

MxCADResbuf

Inherited from ​

McDbCustomEntity.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

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

Example

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

Parameters ​

Returns ​

Object

Double value

Inherited from ​

McDbCustomEntity.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

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

Example

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

Parameters ​

Returns ​

Object

Long value

Inherited from ​

McDbCustomEntity.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 ​

McDbCustomEntity.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

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

Example

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

Parameters ​

Returns ​

Object

Val XData information | whether ret returns success

Inherited from ​

McDbCustomEntity.getxDataString

highlight ​

▸ highlight(isHighlight): void

Set whether the object is highlighted

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.highlight

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCustomEntity.initTempObject

isErased ​

▸ isErased(): boolean

Has the object been deleted

Example

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

Returns ​

boolean

Inherited from ​

McDbCustomEntity.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Example

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

Returns ​

boolean

Inherited from ​

McDbCustomEntity.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

boolean

Return whether the object is of the target type

Inherited from ​

McDbCustomEntity.isKindOf

isNull ​

▸ isNull(): any

Determine if it is an empty object

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Inherited from ​

McDbCustomEntity.isNull

mirror ​

▸ mirror(point1, point2): boolean

Mirror oriented object

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.mirror(new McGePoint3d(0,0,0), new McGePoint3d(20,10,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.mirror

move ​

▸ move(fromPoint, toPoint): boolean

move objects

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.move(new McGePoint3d(0,0,0), new McGePoint3d(20,0,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.move

moveGripPointsAt ​

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

Move the grip of custom objects.

Example

import { McDbCustomEntity, MxCADWorldDraw, McDbLine } from 'mxcad';
//Create a new McDbTestLineCustomizing Entity class to inherit McDbCustomizing Entity
  class McDbTestLineCustomEntity extends McDbCustomEntity {
//Define the point object pt1 inside McDbtTestLineCustomizing Entity pt2
       private pt1: McGePoint3d = new McGePoint3d();
       private pt2: McGePoint3d = new McGePoint3d();
//Move the grip of custom objects.
       public moveGripPointsAt(iIndex: number, dXOffset: number, dYOffset: number, dZOffset: number) {
           this.assertWrite();
           if (iIndex == 0) {
           this.pt1.x += dXOffset;
           this.pt1.y += dYOffset;
           this.pt1.z += dZOffset;
           }
           else if (iIndex == 1) {
           this.pt2.x += dXOffset;
           this.pt2.y += dYOffset;
           this.pt2.z += dZOffset;
           }
       };
   }

Parameters ​

Returns ​

void

Overrides ​

McDbCustomEntity.moveGripPointsAt

rotate ​

▸ rotate(basePoint, dRotationAngle): boolean

Rotate object

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.rotate(new McGePoint3d(0,0,0), Math.PI)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.rotate

rxInit ​

▸ rxInit(): void

Custom Entity Registration

Example

import { MxFun } from 'mxdraw
//MxCAD created successfully
MxFun.on("mxcadApplicationCreatedMxCADObject", (param) => {
//McDbtTestLineCustomizing Entity Custom Entity
new McDbTestLineCustomEntity().rxInit();//  Custom Entity Registration
MxFun.addCommand("MxTest_DrawCustomEntity");//  Register drawing entity command
})

Returns ​

void

Inherited from ​

McDbCustomEntity.rxInit

scaleEntity ​

▸ scaleEntity(basePoint, dScaleFactor): boolean

Scaling objects

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.scaleEntity(new McGePoint3d(0,0,0), 0.5)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.scaleEntity

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)

Parameters ​

Returns ​

boolean

Is the setting successful.

Inherited from ​

McDbCustomEntity.setJson

setxData ​

▸ setxData(xdata): boolean

Set extended data for objects

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"}]));

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.setxData

setxDataDouble ​

▸ setxDataDouble(appName, val): boolean

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

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
}

Parameters ​

Returns ​

boolean

Boolean value

Inherited from ​

McDbCustomEntity.setxDataDouble

setxDataLong ​

▸ setxDataLong(appName, val): boolean

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

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
}

Parameters ​

Returns ​

boolean

Long value

Inherited from ​

McDbCustomEntity.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 ​

McDbCustomEntity.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

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

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
}

Parameters ​

Returns ​

boolean

Is the setting successful

Inherited from ​

McDbCustomEntity.setxDataString

syncData ​

▸ syncData(toCpp?): boolean

JS object data and McDbCCustoms Entity: Synchronization of m_mapData.

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCustomEntity.syncData

unErase ​

▸ unErase(): boolean

Anti delete object.

Example

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

Returns ​

boolean

Inherited from ​

McDbCustomEntity.unErase

updateDisplay ​

▸ updateDisplay(): void

Display the updated display of the calling object

Example

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

Returns ​

void

Inherited from ​

McDbCustomEntity.updateDisplay