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

Class: McObject ​

2d.McObject

The McObject class encapsulates the functionality related to MxCAD objects and provides methods to manipulate and manage these functionalities

Table of contents ​

Constructors ​

• constructor

Accessors ​

• database
• drawColor
• drawColorIndex
• drawDimStyle
• drawLayer
• drawLineTypeScale
• drawLineWeight
• drawLineWidth
• drawLinetype
• drawPatternDefinition
• drawTextStyle
• drawUseDefaultProperties
• mxdraw

Methods ​

• AddTureTypeTextStyle
• addCurrentSelect
• addDimStyle
• addImageDefine
• addLayer
• addLinetype
• addLinetypeEx
• addPatternDefinition
• addSystemVarNameForEvent
• addTextStyle
• callEvent
• clearDwgBackground
• clearMxCurrentSelect
• create
• destroyObject
• drawArc
• drawArc2
• drawArc3
• drawBlockReference
• drawCircle
• drawDimAligned
• drawDimAngular
• drawDimDiametric
• drawDimOrdinate
• drawDimRadial
• drawDimRotated
• drawEllipse
• drawEllipseArc
• drawEntity
• drawHatch
• drawImage
• drawLine
• drawLine3d
• drawMText
• drawPathToHatch
• drawPathToPolyline
• drawPathToSpline
• drawPoint
• drawSolid
• drawText
• getAllLayoutName
• getBackgroundEntity
• getCurrentDatabaseDrawColor
• getCurrentFileName
• getCurrentOriginaFileName
• getDatabase
• getImp
• getMxCpp
• getMxDrawObject
• getSysVarDouble
• getSysVarLong
• getSysVarPoint
• getSysVarString
• getViewCADCoord
• iniAuthorizedService
• init
• initMxObject
• initRegist
• insertBlock
• isTryVersion
• loadDwgBackground
• loadImage
• newFile
• objectIdToObject
• off
• on
• openWebFile
• pathCircle
• pathLineTo
• pathLineToEx
• pathMakeClosed
• pathMakeExclude
• pathMoveTo
• pathMoveToEx
• redo
• regen
• saveFile
• saveFileToUrl
• setAttribute
• setBrowse
• setCurrentFileName
• setCurrentLayout
• setCurrentOriginaFileName
• setSysVarDouble
• setSysVarLong
• setSysVarPoint
• setSysVarPoint2d
• setSysVarString
• setViewBackgroundColor
• showLineWeight
• undo
• undoMark
• updateDisplay
• updateLayerDisplayStatus
• zoomAll
• zoomAngle
• zoomCenter
• zoomScale
• zoomW

Constructors ​

constructor ​

• new McObject(imp?)

Constructor function

Example

import { McObject } from 'mxcad'

const mxcad = new McObject;

Parameters ​

Accessors ​

database ​

• get database(): McDbDatabase

Return database object

Returns ​

McDbDatabase

drawColor ​

• get drawColor(): McCmColor

Get drawing colors

Returns ​

McCmColor

Return to drawing color

• set drawColor(val): void

Set drawing color

Example

import { MxCpp, McObject } from 'mxcad';
const mxcad:McObject = MxCpp.App.getCurrentMxCAD();
mxcad.drawColor = new McCmColor(0, 0, 255);

Parameters ​

Returns ​

void

drawColorIndex ​

• get drawColorIndex(): number

Set color index for drawing

Returns ​

number

Val color index type

• set drawColorIndex(val): void

Set color index for drawing

Example

import { MxCpp, ColorIndexType, McObject } from "mxcad" ;
const mxcad:McObject = MxCpp.App.getCurrentMxCAD();
mxcad.drawColorIndex = ColorIndexType.kMagenta;

Parameters ​

Returns ​

void

drawDimStyle ​

• get drawDimStyle(): string

Get the currently drawn annotation style

Returns ​

string

• set drawDimStyle(val): void

Set the annotation style for the current drawing

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimStyle = "MyDimStyle2"

Parameters ​

Returns ​

void

drawLayer ​

• get drawLayer(): string

Get drawing layers

Returns ​

string

Return to drawing layer

• set drawLayer(val): void

Set drawing layer

Example

import { MxCpp, McObject } from 'mxcad'
  const mxcad:McObject = MxCpp.getCurrentMxCAD();
   mxcad.drawLayer = "MtextLayer";

Parameters ​

Returns ​

void

drawLineTypeScale ​

• get drawLineTypeScale(): number

Obtain the scale of the drawn line type

Returns ​

number

Return to drawing line type scale

• set drawLineTypeScale(val): void

Set the drawing line scale

Parameters ​

Returns ​

void

drawLineWeight ​

• get drawLineWeight(): LineWeight

Get drawing line width

Returns ​

LineWeight

Return to drawing line width

• set drawLineWeight(val): void

Set drawing line width

Example

import { MxCpp, McDb, McObject } from "mxcad" ;

const mxcad: McObject = MxCpp.App.getCurrentMxCAD();
mxcad.drawLineWeight(McDb.LineWeight.kLnWtByLayer)

Parameters ​

Returns ​

void

drawLineWidth ​

• get drawLineWidth(): number

Get the current drawn line width

Example

import { MxCpp, McObject } from "mxcad"
const mxcad: McObject = MxCpp.getCurrentMxCAD()
mxcad.drawLineWidth = 4;

Returns ​

number

• set drawLineWidth(val): void

Set the current drawn line width

Parameters ​

Returns ​

void

drawLinetype ​

• get drawLinetype(): string

Obtain the drawing line type

Returns ​

string

Return to drawing line type

• set drawLinetype(val): void

Set drawing line type

Example

import { MxCpp, McObject } from "mxcad" ;

const mxcad: McObject = MxCpp.App.getCurrentMxCAD();
mxcad.addLinetype("MyLineType3", "30,-10");
mxcad.drawLinetype = "MyLineType3";

Parameters ​

Returns ​

void

drawPatternDefinition ​

• get drawPatternDefinition(): string

Get the current line type definition drawn

Example

import { MxCpp, McObject } from "mxcad"
const mxcad: McObject = MxCpp.getCurrentMxCAD()
mxcad.drawPatternDefinition = "MyHatchPattern1";

Returns ​

string

• set drawPatternDefinition(val): void

Set the line type definition for the current drawing

Parameters ​

Returns ​

void

drawTextStyle ​

• get drawTextStyle(): string

Get the style of drawing text

Returns ​

string

Return to drawing text style

• set drawTextStyle(val): void

Set the style for drawing text

Example

import { MxCpp, McObject } from "mxcad" ;

const mxcad: McObject = MxCpp.App.getCurrentMxCAD();
mxcad.addTextStyle("MyTextStyle", "italicc.shx", "gbcbig.shx", 0.7);
mxcad.drawTextStyle = "MyTextStyle";

Parameters ​

Returns ​

void

drawUseDefaultProperties ​

• get drawUseDefaultProperties(): boolean

Return the number of drawings starting with the call 'draw', using the current default properties of the database.

Returns ​

boolean

• set drawUseDefaultProperties(val): void

Set the number of drawings starting with 'draw' when calling, using the current default properties of the database

Parameters ​

Returns ​

void

mxdraw ​

• get mxdraw(): MxDrawObject

Return the MxDraw object bound to the MxCAD object.

Example

import { McObject } from 'mxcad'

const mxcad = new McObject()
const mxdraw = mxcad.mxdraw

Returns ​

MxDrawObject

MxDraw object

Methods ​

AddTureTypeTextStyle ​

▸ AddTureTypeTextStyle(sName, sTrueTypeFontName?, dXScale?): McObjectId

Add text styles using TrueType fonts

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.AddTureTypeTextStyle("MyTrueTypeTextStyle");

Parameters ​

Returns ​

McObjectId

addCurrentSelect ​

▸ addCurrentSelect(id, isDisplayGrid?): void

Add the object to the current selection

Example

import { MxCpp, McObject } from "mxcad"
let mxcad:McObject = MxCpp.getCurrentMxCAD();
let id = mxcad.drawLine(0,0,1000,1000);
mxcad.addCurrentSelect(id);

Parameters ​

Returns ​

void

void

addDimStyle ​

▸ addDimStyle(pszName, pszDoubleData, pszIntData, pszStringData, pszIdData): McObjectId

Add annotation style

Description

PszDoubleData Double Precision Data

Description

PszIntData integer data

Description

PszStringData string type data

Description

PszIdData ID type data

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD();

//MyDimStyle2: Style Name
//41, 0.18141, 0.09, 40200 ": Double precision data
//77,1271,3 ": integer data
//Among them, the values are set in pairs, such as "41,0.18": the value of the dimasz system variable is set to 0.18; 77,1 ": The value of the dimtad system variable is set to 1
mxcad.addDimStyle("MyDimStyle2", "41,0.18,141,0.09,40,200", "77,1,271,3", "", "");
Add a%% c prefix '3, "%%c<>"'
mxcad.addDimStyle("MyDimStyle", "41,0.18,141,0.09,40,200", "77,1,271,3", '3,"%%c<>"', `340,${textId.id}`);

Parameters ​

Returns ​

McObjectId

addImageDefine ​

▸ addImageDefine(imageUrl, sName?, isConvertBase64?): McObjectId

Add an image definition to the CAD database.

Example

import { MxCpp, McObject } from "mxcad"
   let mxcad:McObject = MxCpp.getCurrentMxCAD();
   let imagUrl = "https://cdn.pixabay.com/photo/2022/11/15/12/23/winter-7593872_960_720.jpg";
   mxcad.loadImage(imagUrl, (imagedata) => {
       if (!imagedata) {
           console.log("loadImage failed");
           return;
       }
       let imagedefid = mxcad.addImageDefine(imagUrl,"winter-7593872_960_720.jpg",true);
       mxcad.updateDisplay();
   });

Parameters ​

Returns ​

McObjectId

addLayer ​

▸ addLayer(string): McObjectId

Add Layer

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
Mxcad. addLayer ("Layer Name")

Parameters ​

Returns ​

McObjectId

addLinetype ​

▸ addLinetype(sName, sLineDefine): McObjectId

Add line type

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
//Define dashed data, "MyLineType" is the line name, "6, -8" is a unit definition of the dashed line, 6 is the length of the solid line, and -8 is the length of the space.
mxcad.addLinetype("MyLineType", "6,-10");

Parameters ​

Returns ​

McObjectId

addLinetypeEx ​

▸ addLinetypeEx(sName, sLineDefine, sTextStyle?): McObjectId

Add line type

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
let lintype = mxcad.addLinetypeEx("TestMyLine", '.5,-.2,["HW",STANDARD,S=.1,R=0.0,X=-0.1,Y=-.05],-.2', "");

Parameters ​

Returns ​

McObjectId

addPatternDefinition ​

▸ addPatternDefinition(sName, sDefinitionData): void

Add a pattern definition

Example

import { MxCpp, McObject } from "mxcad"
   const mxcad:McObject = MxCpp.getCurrentMxCAD()
   //angle, x-origin,y-origin, delta-x,delta-y,dash-1,dash-2, …
//45=angle is the angle of the pattern line
//0=x-origin is the X-coordinate of the point where the first fill line passes through
//0=y-origin is the Y coordinate of the point where the first fill line passes through
//0=delta-x is the X-direction offset of the next fill line relative to the previous line
//0.125=delta-y is the Y-direction offset of the next fill line relative to the previous line
   mxcad.addPatternDefinition("MyHatchPattern1", "((45, 0,0, 0,0.125))");

Parameters ​

Returns ​

void

addSystemVarNameForEvent ​

▸ addSystemVarNameForEvent(aryVarName): void

Add a system variable name for event notification after variable object modification Variable object modification event name: sysVarChanged

Parameters ​

Returns ​

void

addTextStyle ​

▸ addTextStyle(sName, sFileName, sBigFontFileName, dXScale?): McObjectId

Add Text Style

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD() 
mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);

Parameters ​

Returns ​

McObjectId

callEvent ​

▸ callEvent(sEventName, param?): boolean

Call to trigger a system event

Example

import { MxCpp, McObject } from "mxcad"

const mxcad:McObject = MxCpp.getCurrentMxCAD();
mxcad.callEvent("init");

Parameters ​

Returns ​

boolean

clearDwgBackground ​

▸ clearDwgBackground(): void

Clear background drawing objects

Returns ​

void

clearMxCurrentSelect ​

▸ clearMxCurrentSelect(): void

Clear all current selections

Example

import { MxCpp, McObject } from "mxcad"

const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.clearCurrentSelect();

Returns ​

void

create ​

▸ create(config): void

Create an MXCAD object.

Example

import { McObject } from "mxcad"

//Create an MXCAD sample object
 const mxcad = new McObject()
mxcad.create({
//The ID of the canvas element
canvas: "#myCanvas",
//Retrieve the path location for loading wasm related files (wasm/js/worker. js)
locateFile: (fileName)=> new URL(`/node_modules/mxcad/dist/wasm/2d/${fileName}`, import.meta.url).href,
//Need to initialize the URL path of the opened file
fileUrl: new URL("../src/assets/test.mxweb", import.meta.url).href,
//Provide the directory path for loading fonts
fontspath:  new URL("node_modules/mxcad/dist/fonts", import.meta.url).href,
})

Parameters ​

Returns ​

void

destroyObject ​

▸ destroyObject(pObjectImp): void

Destroy the specified McRxObject Imp object

Parameters ​

Returns ​

void

drawArc ​

▸ drawArc(dCenterX, dCenterY, dRadius, dStartAng, dEndAng): McObjectId

Draw an arc

Example

import { MxCpp, McObject } from "mxcad"
const mxcad: McObject = MxCpp.getCurrentMxCAD()
mxcad.drawArc(300, 1000, 100, 30, 200);

Parameters ​

Returns ​

McObjectId

Success returns 1, failure returns 0

drawArc2 ​

▸ drawArc2(dStartPointX, dStartPointY, dMidPointX, dMidPointY, dEndPointX, dEndPointY): McObjectId

Draw an arc

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
//Draw an arc from three points on the arc
mxcad.drawArc2(800, 1000, 900, 1200, 1000, 900);

Parameters ​

Returns ​

McObjectId

drawArc3 ​

▸ drawArc3(dStartPointX, dStartPointY, dEndPointX, dEndPointY, dBulge): McObjectId

Draw an arc

Example

import { MxCpp, McObject } from "mxcad"
  const mxcad:McObject = MxCpp.getCurrentMxCAD()
//The starting point, ending degree, and convexity on the arc will form an arc
  mxcad.drawLineWidth = 40;
  mxcad.drawArc3(1200, 1000, 1400, 1000, 0.6);

Parameters ​

Returns ​

McObjectId

drawBlockReference ​

▸ drawBlockReference(dPosX, dPosY, sBlkName, dScale, dAng): McObjectId

Draw block reference

Parameters ​

Returns ​

McObjectId

Block object ID

drawCircle ​

▸ drawCircle(dCenterX, dCenterY, dRadius): McObjectId

Draw a circle

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD(
mxcad.drawCircle(0, 0, 120);

Parameters ​

Returns ​

McObjectId

drawDimAligned ​

▸ drawDimAligned(dExtLine1PointX, dExtLine1PointY, dExtLine2PointX, dExtLine2PointY, dTextPositionX, dTextPositionY): McObjectId

Draw alignment annotations

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimAligned(0, 4000, 300, 4500, 150, 4600);

Parameters ​

Returns ​

McObjectId

Success returns 1, failure returns 0

drawDimAngular ​

▸ drawDimAngular(dAngleVertexX, dAngleVertexY, dFirstEndPointX, dFirstEndPointY, dSecondEndPointX, dSecondEndPointY, dTextPointX, dTextPointY): McObjectId

Draw angle annotation

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimAngular(500, 5000, 0, 5500, 1000, 5500, 500, 5500);

Parameters ​

Returns ​

McObjectId

Success returns 1, failure returns 0

drawDimDiametric ​

▸ drawDimDiametric(dChordPointX, dChordPointY, dFarChordPointX, dFarChordPointY, dLeaderLength): McObjectId

Draw diameter annotation

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimDiametric(500, 0, -500, 0, 20);

Parameters ​

Returns ​

McObjectId

Diameter annotation object ID

drawDimOrdinate ​

▸ drawDimOrdinate(dDefinitionPointX, dDefinitionPointY, dDeaderEndPointX, dDeaderEndPointY, isUseXAxis): McObjectId

Draw linear dimensions for annotation

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimOrdinate(500, 0, -500, 0, true);

Parameters ​

Returns ​

McObjectId

Linear size object ID

drawDimRadial ​

▸ drawDimRadial(dCenterX, dCenterY, dChordPointX, dChordPointY, dLeaderLength): McObjectId

Draw radial dimensions for annotation

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawDimOrdinate(0, 0, 0, 500, 20);

Parameters ​

Returns ​

McObjectId

Radial dimension object ID

drawDimRotated ​

▸ drawDimRotated(dExtLine1PointX, dExtLine1PointY, dExtLine2PointX, dExtLine2PointY, dDimLineLocationX, dDimLineLocationY, dRotationAngle): McObjectId

Draw rotation annotation

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD() 
mxcad.drawDimRotated(0, 7000, 600, 7000, 250, 7050, 0);

Parameters ​

Returns ​

McObjectId

Rotate annotation object ID

drawEllipse ​

▸ drawEllipse(dCenterX, dCenterY, dMajorAxisX, dMajorAxisY, dRadiusRatio): McObjectId

Draw an ellipse

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawEllipse(0, 1400, 100, 0, 0.7);

Parameters ​

Returns ​

McObjectId

Success returns 1, failure returns 0

drawEllipseArc ​

▸ drawEllipseArc(dCenterX, dCenterY, dMajorAxisX, dMajorAxisY, dRadiusRatio, dStartAng, dEndAng): McObjectId

Draw an elliptical arc

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawEllipseArc(0, 1600, 80, 30, 0.4, 30, 200);

Parameters ​

Returns ​

McObjectId

drawEntity ​

▸ drawEntity(entity, isUseDatabaseCurrentProperties?): McObjectId

Draw entities

Example

import { McDbPolyline, MxCpp } from
let pl = new McDbPolyline();
  pl.addVertexAt(new McGePoint3d(100, 100, 100));
  pl.addVertexAt(new McGePoint3d(200, 100, 500));
  pl.addVertexAt(new McGePoint3d(300, 400, 200));
  MxCpp.getCurrentCAD().drawEntity(pl);

Parameters ​

Returns ​

McObjectId

Draw Results

drawHatch ​

▸ drawHatch(hatch, dPatternScale?): McObjectId

Draw Fill Object

Parameters ​

Returns ​

McObjectId

Draw object ID

drawImage ​

▸ drawImage(dPosX, dPosY, dWidth, dHeight, dAng, imageUrl, isConvertBase64?, dwgImageSizeWidth?, dwgImageSizeHeight?): McObjectId

Draw an image

Parameters ​

Returns ​

McObjectId

drawLine ​

▸ drawLine(dX1, dY1, dX2, dY2): McObjectId

draw a straight line

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawLine(0, 60, 100, 60);

Parameters ​

Returns ​

McObjectId

drawLine3d ​

▸ drawLine3d(dX1, dY1, dZ1, dX2, dY2, dZ2): McObjectId

Parameters ​

Returns ​

McObjectId

drawMText ​

▸ drawMText(dPosX, dPosY, sContents, dHeight, dWidth, dRotation, iAttachment): McObjectId

Draw multiple lines of text

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
Mxcad.drawMText (0, -100, "Control:\ \P Multi line Text Test ", 50, 400, 0, 1);

Parameters ​

Returns ​

McObjectId

Multi line text object ID

drawPathToHatch ​

▸ drawPathToHatch(dPatternScale?): McObjectId

Convert the path to a fill pattern

Example

import { MxCADUiPrPoint, MxCADUiPrDist, MxCpp } from "mxcad";
//Solid circle
   async function Mx_SolidCircle() {
       const getCenter = new MxCADUiPrPoint();
GetCenter.setMessage ('Please confirm the center position ');
       const center = await getCenter.go();
       if (!center) return;
       const getRadius = new MxCADUiPrDist();
getRadius.setBasePt(center);//  Set the distance base point as the center of the circle
GetRadius.setMessage ('Please enter circle radius');
       getRadius.setUserDraw((pt, pw) => {
           const r = pt.distanceTo(center);
           const circle = new McDbCircle();
           circle.center = center;
           circle.radius = r;
           pw.drawMcDbEntity(circle)
       })
       const radiusVal = await getRadius.go();
       if (!radiusVal) return;
       const radius = getRadius.value();
       const mxcad = MxCpp.getCurrentMxCAD();
mxcad.pathCircle(center.x, center.y, radius);// Set circular path
mxcad.drawPathToHatch();//  Draw a solid circle
   }

Parameters ​

Returns ​

McObjectId

Conversion results

drawPathToPolyline ​

▸ drawPathToPolyline(): McObjectId

Convert the path to a polyline

Returns ​

McObjectId

Conversion results

drawPathToSpline ​

▸ drawPathToSpline(): McObjectId

Convert the path to a spline curve

Returns ​

McObjectId

Conversion results

drawPoint ​

▸ drawPoint(dX, dY): McObjectId

Draw points

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawPoint(0,0);

Parameters ​

Returns ​

McObjectId

drawSolid ​

▸ drawSolid(dX1, dY1, dX2, dY2, dX3, dY3, dX4, dY4): McObjectId

Draw entities

Parameters ​

Returns ​

McObjectId

Entity Object ID

drawText ​

▸ drawText(dPosX, dPosY, pszText, dHeight, dRotation, horizontalMode, verticalMode): McObjectId

Draw a single line of text

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
Mxcad.drawText (0, 1900, "Drawing Control Text Test", 100, 0, 0, 1);

Parameters ​

Returns ​

McObjectId

Success returns 1, failure returns 0

getAllLayoutName ​

▸ getAllLayoutName(): McGeStringArray

Get all layout names

Returns ​

McGeStringArray

getBackgroundEntity ​

▸ getBackgroundEntity(): McDbBackgroundEntity

Return the current background object

Returns ​

McDbBackgroundEntity

getCurrentDatabaseDrawColor ​

▸ getCurrentDatabaseDrawColor(): Color

Returns the drawing color set in the current database, which will automatically convert black and white based on the background color.

Returns ​

Color

getCurrentFileName ​

▸ getCurrentFileName(): string

Get the current file name

Returns ​

string

Current file name

getCurrentOriginaFileName ​

▸ getCurrentOriginaFileName(): string

Get the current file name

Returns ​

string

Current file name

getDatabase ​

▸ getDatabase(): McDbDatabase

Retrieve database objects

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.App.getCurrentMxCAD()
let layerTable = mxcad.getDatabase().getLayerTable();

Returns ​

McDbDatabase

Database objects

getImp ​

▸ getImp(): any

Retrieve internal implementation objects

Returns ​

any

Internal implementation object

getMxCpp ​

▸ getMxCpp(): any

Add back the MxCpp object, which will be called in the MxDraw module.

Returns ​

any

getMxDrawObject ​

▸ getMxDrawObject(): MxDrawObject

Return the MxDraw object bound to the MxCAD object.

Example

import { McObject } from 'mxcad'

const mxcad = new McObject()
const mxdraw = mxcad.getMxDrawObject()

Returns ​

MxDrawObject

MxDraw object

getSysVarDouble ​

▸ getSysVarDouble(varName): number

Get floating-point values of system variables

Parameters ​

Returns ​

number

Floating point values of variables

getSysVarLong ​

▸ getSysVarLong(varName): number

Get the integer value of a system variable

Parameters ​

Returns ​

number

The integer value of a variable

getSysVarPoint ​

▸ getSysVarPoint(varName): McGePoint3d

Obtain the point values of system variables

Parameters ​

Returns ​

McGePoint3d

Point values of variables

getSysVarString ​

▸ getSysVarString(varName): string

Retrieve the string value of a system variable

Parameters ​

Returns ​

string

The string value of a variable

getViewCADCoord ​

▸ getViewCADCoord(): Object

Return the display range and CAD coordinates of the current viewport.

Returns ​

Object

Current viewport display range

iniAuthorizedService ​

▸ iniAuthorizedService(sUrl): void

Initialize user authorization service url

Parameters ​

Returns ​

void

init ​

▸ init(imp): void

Initial object

Parameters ​

Returns ​

void

initMxObject ​

▸ initMxObject(mxObject): void

Initialize object model

Description

Parameters ​

Returns ​

void

initRegist ​

▸ initRegist(sRegist): void

Initialize user registration data

Parameters ​

Returns ​

void

insertBlock ​

▸ insertBlock(sFileUrl, sBlkName, isWorkThread?, fetchAttributes?, isUpdataInsertBlock?, isUpdataSameNameBlock?): Promise<McObjectId>

Plugin block file

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
const blkrecId = await mxcad.insertBlock("./blkrec.mxweb", "sBlkName");

Parameters ​

Returns ​

Promise<McObjectId>

isTryVersion ​

▸ isTryVersion(): boolean

Is the current program a trial version

Returns ​

boolean

loadDwgBackground ​

▸ loadDwgBackground(sFileUrl, call, color?, isShow?): void

Load another DWG file to draw the current background object

Parameters ​

Returns ​

void

loadImage ​

▸ loadImage(imageUrl, call, imageFileName?): void

Load an external image into the current context for future use.

Example

import { MxCpp, McObject } from "mxcad"
 const mxcad: McObject = MxCpp.getCurrentMxCAD()
 mxcad.loadImage(imagUrl, (image) => {
   if (!image) {
       console.log("loadImage failed");
       return;
   }
   let width = mxcad.mxdraw.viewCoordLong2Cad(100);
   let height = (image.height / image.width) * width;
   idImage = mxcad.drawImage((pt as any).x, (pt as any).y, width, height, 0, imagUrl,true);
   mxcad.updateDisplay();
});

Parameters ​

Returns ​

void

newFile ​

▸ newFile(): boolean

Clear the content of the current image and create a new file

Example

import { MxCpp, McObject } from "mxcad" ;

let mxcad:McObject = MxCpp.getCurrentMxCAD();
mxcad.newFile();

Returns ​

boolean

objectIdToObject ​

▸ objectIdToObject(lIdIndex): null | McDbObject

Convert lIdInDex to McDbObject object

Parameters ​

Returns ​

null | McDbObject

McDbObject object corresponding to ID, returns null if the object does not exist

off ​

▸ off(name, fun?): void

Turn off event monitoring

Example

import { MxCpp, McObject } from "mxcad"

const mxcad:McObject = MxCpp.getCurrentMxCAD();
//E: Event function, referring to the function registered in mxcad. on ("selectChange", e)
mxcad.off("selectChange", e);

Parameters ​

Returns ​

void

on ​

▸ on(name, fun): void

Monitor object selection event

Example

import { MxCpp, McObject, McObjectId } from "mxcad"

const mxcad:McObject = MxCpp.getCurrentMxCAD();
mxcad.on("selectChange", (ids: McObjectId[])=> {
     if (ids.length == 0) return;
     let id = ids[0]
     let ent = id.getMcDbEntity()
     if(!ent) return
     console.log(ent.objectName)
})

Parameters ​

Returns ​

void

▸ on(name, fun): void

Monitor file fully open

Parameters ​

Returns ​

void

▸ on(name, fun): void

The mxdraw mxcad program has been loaded and triggered when preparing to create an mxdraw object

Parameters ​

Returns ​

void

▸ on(name, fun): void

MXdraw object created, triggered when preparing initial related parameters

Parameters ​

Returns ​

void

▸ on(name, fun): void

Triggered after mxdraw object creation

Parameters ​

Returns ​

void

▸ on(name, fun): void

Triggered when the MXCAD object is ready to be created

Parameters ​

Returns ​

void

▸ on(name, fun): void

Monitor database modification events

Parameters ​

Returns ​

void

▸ on(name, fun): void

System variables have been modified

Parameters ​

Returns ​

void

▸ on(name, fun): void

Graphic database initialization

Parameters ​

Returns ​

void

▸ on(name, fun): void

The layer data has changed

Parameters ​

Returns ​

void

▸ on(name, fun): void

The line type data has changed

Parameters ​

Returns ​

void

▸ on(name, fun): void

Object modification event will not be notified by default. Configure the Enable Object Modification Event variable to enable it

Parameters ​

Returns ​

void

openWebFile ​

▸ openWebFile(sFileUrl, retCall?, isWorkThread?, initialParameter?, fetchAttributes?, isFetchTzFile?): boolean

Open network files

Example

import { MxCpp } from "mxcad";
const mxcad = MxCpp.getCurrentMxCAD();
mxcad.openWebFile("http://localhost:1337/mxcad/file/a9cbed3d3a351b79f24484e87bd78338.DWG.mxweb");

Parameters ​

Returns ​

boolean

Did you successfully open the file

pathCircle ​

▸ pathCircle(dCenX, dCenY, dR, dPrecision?, dWidth?): boolean

Create a path based on a circular object

Example

import { MxCpp, McObject } from "mxcad"
  const mxcad:McObject = MxCpp.getCurrentMxCAD()
  mxcad.pathCircle(0, 0, 20);

Parameters ​

Returns ​

boolean

pathLineTo ​

▸ pathLineTo(dX, dY): void

Draw a straight line from the current position to the specified location

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.pathLineTo(100, 300);

Parameters ​

Returns ​

void

pathLineToEx ​

▸ pathLineToEx(dX, dY, dStartWidth, dEndWidth, dBulge): void

Draw a straight line from the current position to the specified position, while specifying the starting width, ending width, and convexity

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.pathLineToEx(1000, 500, 30, 0, 0);

Parameters ​

Returns ​

void

pathMakeClosed ​

▸ pathMakeClosed(): void

Closed path

Returns ​

void

pathMakeExclude ​

▸ pathMakeExclude(isExclude): void

Mark the current path as an exclusion marker, mainly used for filling and drawing. Dig out the closed area composed of this path in the filling process

Example

import { MxCpp, McObject } from "mxcad"
   const mxcad:McObject = MxCpp.getCurrentMxCAD()
//Draw a solid object with a curved boundary filling, and cut a piece in the middle
   mxcad.pathMoveToEx(440, 3310, 0, 0, 0);
   mxcad.pathLineTo(480, 3310);
   mxcad.pathLineTo(480, 3360);
   mxcad.pathLineTo(450, 3340);
//Fill in the exclusion area with the path definition defined above
   mxcad.pathMakeExclude(true);

Parameters ​

Returns ​

void

pathMoveTo ​

▸ pathMoveTo(dX, dY): void

Move the path to the specified location

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.pathMoveTo(0, 300);

Parameters ​

Returns ​

void

pathMoveToEx ​

▸ pathMoveToEx(dX, dY, dStartWidth, dEndWidth, dBulge): void

Move the path to the specified location, while specifying the starting width, ending width, and convexity

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.pathMoveToEx(1000, 300, 10, 10, 0);

Parameters ​

Returns ​

void

redo ​

▸ redo(): void

Reverse rollback, redo.

Returns ​

void

regen ​

▸ regen(delayTime?): void

After redrawing all objects on the graph and calling ZoomAll and ZoomW, it may be necessary to delay the call to Regen before it takes effect due to asynchronous execution.

Example

import { MxCpp, McObject } from 'mxcad'
 const mxcad:McObject = MxCpp.getCurrentMxCAD()
//Draw a circle with width
   mxcad.addLinetype("CircleLineType", "30,-5,7,-7");

//Design the current line type as' CircleLineType '
   mxcad.drawLinetype = ("CircleLineType");

   mxcad.drawLineWidth = 40;

   mxcad.drawCircle(600, 800, 120);

   mxcad.zoomAll();
   mxcad.regen();
   mxcad.updateDisplay();

Parameters ​

Returns ​

void

saveFile ​

▸ saveFile(filename?, call?, isDownland?, isShowSaveFileDialog?, parameter?): boolean

Save file

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.App.getCurrentMxCAD()
const fileName =  mxcad.getCurrentFileName()
mxcad.saveFile("test", (data)=> {
  const blob = new Blob([data.buffer], { type: "application/octet-stream" });
}, false, false)

Parameters ​

Returns ​

boolean

Has the file been successfully saved

saveFileToUrl ​

▸ saveFileToUrl(sSaveProgramUrl, call, filename?, param?): boolean

Save and convert the file to a network path for download

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
 MxCpp.getCurrentMxCAD().saveFileToUrl("http://localhost:1337/mxcad/savefiledwg", (iResult, sserverResult) => {
   let ret = JSON.parse(sserverResult);
   if (ret.ret == "ok") {
       console.log(ret.file)
   }
})
//Save the PDF file.
import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
 MxCpp.getCurrentMxCAD().saveFileToUrl("http://localhost:1337/mxcad/savepdf", (iResult, sserverResult) => {
   let ret = JSON.parse(sserverResult);
   if (ret.ret == "ok") {
       console.log(ret.file)
       let saveFileUrl = "http://localhost:1337/mxcad/file/" + ret.file;
       MxTools.downloadFileFromUrl(saveFileUrl, ret.file);
   }
},"",JSON.stringify({ width: "2000", height: "2000" }));