mxcad_2d API 文档 / 2d / McObject

Class: McObject ​

2d.McObject

McObject 类, 封装了与 MxCAD 对象相关的功能，并提供了一些方法来操作和管理这些功能

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?)

构造函数

Parameters ​

Example

import { McObject } from 'mxcad'

const mxcad = new McObject;

Accessors ​

database ​

• get database(): McDbDatabase

返回数据库对象

Returns ​

McDbDatabase

drawColor ​

• get drawColor(): McCmColor

获取绘制颜色

Returns ​

McCmColor

返回绘制颜色

• set drawColor(val): void

设置绘制颜色

Parameters ​

Returns ​

void

Example

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

drawColorIndex ​

• get drawColorIndex(): number

设置绘制颜色索引

Returns ​

number

val 颜色索引类型

• set drawColorIndex(val): void

设置绘制颜色索引

Parameters ​

Returns ​

void

Example

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

drawDimStyle ​

• get drawDimStyle(): string

获取当前绘制的标注样式

Returns ​

string

• set drawDimStyle(val): void

设置当前绘制的标注样式

Parameters ​

Returns ​

void

Example

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

drawLayer ​

• get drawLayer(): string

获取绘制图层

Returns ​

string

返回绘制图层

• set drawLayer(val): void

设置绘制图层

Parameters ​

Returns ​

void

Example

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

drawLineTypeScale ​

• get drawLineTypeScale(): number

获取绘制线型比例

Returns ​

number

返回绘制线型比例

• set drawLineTypeScale(val): void

设置绘制线型比例

Parameters ​

Returns ​

void

drawLineWeight ​

• get drawLineWeight(): LineWeight

获取绘制线宽

Returns ​

LineWeight

返回绘制线宽

• set drawLineWeight(val): void

设置绘制线宽

Parameters ​

Returns ​

void

Example

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

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

drawLineWidth ​

• get drawLineWidth(): number

获取当前绘制的线宽

Returns ​

number

Example

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

• set drawLineWidth(val): void

设置当前绘制的线宽

Parameters ​

Returns ​

void

drawLinetype ​

• get drawLinetype(): string

获取绘制线型

Returns ​

string

返回绘制线型

• set drawLinetype(val): void

设置绘制线型

Parameters ​

Returns ​

void

Example

import { MxCpp, McObject } from "mxcad" ;

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

drawPatternDefinition ​

• get drawPatternDefinition(): string

获取当前绘制的线型定义

Returns ​

string

Example

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

• set drawPatternDefinition(val): void

设置当前绘制的线型定义

Parameters ​

Returns ​

void

drawTextStyle ​

• get drawTextStyle(): string

获取绘制文字样式

Returns ​

string

返回绘制文字样式

• set drawTextStyle(val): void

设置绘制文字样式

Parameters ​

Returns ​

void

Example

import { MxCpp, McObject } from "mxcad" ;

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

drawUseDefaultProperties ​

• get drawUseDefaultProperties(): boolean

返回调用draw开头的绘图数，使用数据库的当前默认属性。

Returns ​

boolean

• set drawUseDefaultProperties(val): void

设置调用draw开头的绘图数，使用数据库的当前默认属性

Parameters ​

Returns ​

void

mxdraw ​

• get mxdraw(): MxDrawObject

返回与MxCAD对象绑定的MxDraw对象。

Returns ​

MxDrawObject

MxDraw对象 *

Example

• ts

  * import { McObject } from 'mxcad'
  * 
  * const mxcad = new McObject()
  * const mxdraw = mxcad.mxdraw
  * ```

Methods ​

AddTureTypeTextStyle ​

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

添加使用TrueType字体的文字样式

Parameters ​

Returns ​

McObjectId

Example

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

addCurrentSelect ​

▸ addCurrentSelect(id, isDisplayGrid?): void

把对象添加当前选择中

Parameters ​

Returns ​

void

void

Example

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

addDimStyle ​

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

添加标注样式

Parameters ​

Returns ​

McObjectId

Description

pszDoubleData 双精度型数据

Description

pszIntData 整型数据

Description

pszStringData 字符串型数据

Description

pszIdData ID 型数据

Example

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

// MyDimStyle2：样式名称
// "41,0.18,141,0.09,40,200"：双精度型数据
// "77,1,271,3": 整型数据
// 其中数值两两一组，如 "41,0.18"：dimasz系统变量值设置为0.18；"77,1"：dimtad系统变量值设置为1
mxcad.addDimStyle("MyDimStyle2", "41,0.18,141,0.09,40,200", "77,1,271,3", "", "");
增加一个%%c前缀 '3,"%%c<>"'
mxcad.addDimStyle("MyDimStyle", "41,0.18,141,0.09,40,200", "77,1,271,3", '3,"%%c<>"', `340,${textId.id}`);

addImageDefine ​

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

添加一个图片定义到cad数据库中 。

Parameters ​

Returns ​

McObjectId

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

addLayer ​

▸ addLayer(string): McObjectId

添加图层

Parameters ​

Returns ​

McObjectId

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.addLayer("图层名称")

addLinetype ​

▸ addLinetype(sName, sLineDefine): McObjectId

添加线型

Parameters ​

Returns ​

McObjectId

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
//定义虚线数据据,"MyLineType"是线型名，"6,-8"是虚线的一个单位定义，6是实线长，-8是空格长。
mxcad.addLinetype("MyLineType", "6,-10");

addLinetypeEx ​

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

添加线型

Parameters ​

Returns ​

McObjectId

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', "");

addPatternDefinition ​

▸ addPatternDefinition(sName, sDefinitionData): void

增加一个图案定义

Parameters ​

Returns ​

void

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 是图案线角度.
   //0 = x-origin 是第一个填充线经过的点位置X坐标
   //0 = y-origin 是第一个填充线经过的点位置Y坐标
   //0 = delta-x   是下一个填充线相对前一个线的X方向偏移
   //0.125 = delta-y   是下一个填充线相对前一个线的Y方向偏移
   mxcad.addPatternDefinition("MyHatchPattern1", "((45, 0,0, 0,0.125))");

addSystemVarNameForEvent ​

▸ addSystemVarNameForEvent(aryVarName): void

添加一个系统变量名，用于变量对像修改后，事件通知. 变量对像修改事件名：sysVarChanged

Parameters ​

Returns ​

void

addTextStyle ​

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

添加文字样式

Parameters ​

Returns ​

McObjectId

Example

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

callEvent ​

▸ callEvent(sEventName, param?): boolean

触发一个系统事件的调用

Parameters ​

Returns ​

boolean

Example

import { MxCpp, McObject } from "mxcad"

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

clearDwgBackground ​

▸ clearDwgBackground(): void

清除背景绘制对象

Returns ​

void

clearMxCurrentSelect ​

▸ clearMxCurrentSelect(): void

清除当前所有选择

#### Returns

`void`

___

### create

▸ **create**(`config`): `void`

创建mxcad对象 。

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`MxCadConfig`](../interfaces/2d.MxCadConfig.md) | createMxCad 的参数配置 |

#### Returns

`void`

**`Example`**

```ts
import { McObject } from "mxcad"

   // 创建mxcad示例对象
   const mxcad = new McObject()
   mxcad.create({
       // canvas元素的id
       canvas: "#myCanvas",
       // 获取加载wasm相关文件(wasm/js/worker.js)路径位置
       locateFile: (fileName)=> new URL(`/node_modules/mxcad/dist/wasm/2d/${fileName}`, import.meta.url).href,
       // 需要初始化打开的文件url路径
       fileUrl: new URL("../src/assets/test.mxweb", import.meta.url).href,
       // 提供加载字体的目录路径
       fontspath:  new URL("node_modules/mxcad/dist/fonts", import.meta.url).href,
   })

destroyObject ​

▸ destroyObject(pObjectImp): void

销毁指定的 McRxObjectImp 对象

Parameters ​

Returns ​

void

drawArc ​

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

绘制圆弧

Parameters ​

Returns ​

McObjectId

成功返回 1，失败返回 0

Example

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

drawArc2 ​

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

绘制圆弧

Parameters ​

Returns ​

McObjectId

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
//由圆弧上三个点绘制圆弧
mxcad.drawArc2(800, 1000, 900, 1200, 1000, 900);

drawArc3 ​

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

绘制圆弧

Parameters ​

Returns ​

McObjectId

Example

import { MxCpp, McObject } from "mxcad"
  const mxcad:McObject = MxCpp.getCurrentMxCAD()
  //由圆弧上的开始点，结束度和凸度会圆弧
  mxcad.drawLineWidth = 40;
  mxcad.drawArc3(1200, 1000, 1400, 1000, 0.6);

drawBlockReference ​

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

绘制块参照

Parameters ​

Returns ​

McObjectId

块对象id

drawCircle ​

▸ drawCircle(dCenterX, dCenterY, dRadius): McObjectId

绘制圆

Parameters ​

Returns ​

McObjectId

Example

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

drawDimAligned ​

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

绘制对齐标注

Parameters ​

Returns ​

McObjectId

成功返回 1，失败返回 0

Example

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

drawDimAngular ​

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

绘制角度标注

Parameters ​

Returns ​

McObjectId

成功返回 1，失败返回 0

Example

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

drawDimDiametric ​

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

绘制直径标注

Parameters ​

Returns ​

McObjectId

直径标注对象id

Example

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

drawDimOrdinate ​

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

绘制标注线性尺寸

Parameters ​

Returns ​

McObjectId

线性尺寸对象id

Example

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

drawDimRadial ​

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

绘制标注径向尺寸

Parameters ​

Returns ​

McObjectId

径向尺寸对象id

Example

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

drawDimRotated ​

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

绘制旋转标注

Parameters ​

Returns ​

McObjectId

旋转标注对象id

Example

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

drawEllipse ​

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

绘制椭圆

Parameters ​

Returns ​

McObjectId

成功返回 1，失败返回 0

Example

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

drawEllipseArc ​

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

绘制椭圆弧

Parameters ​

Returns ​

McObjectId

Example

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

drawEntity ​

▸ drawEntity(entity, isUseDatabaseCurrentProperties?): McObjectId

绘制实体

Parameters ​

Returns ​

McObjectId

绘制结果

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

drawHatch ​

▸ drawHatch(hatch, dPatternScale?): McObjectId

绘制填充对象

Parameters ​

Returns ​

McObjectId

绘制对象id

drawImage ​

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

绘制一个图片

Parameters ​

Returns ​

McObjectId

drawLine ​

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

绘制直线

Parameters ​

Returns ​

McObjectId

Example

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

drawLine3d ​

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

Parameters ​

Returns ​

McObjectId

drawMText ​

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

绘制多行文本

Parameters ​

Returns ​

McObjectId

多行文本对象id

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawMText(0, -100, "控件:\\P多行文字测试", 50, 400, 0, 1);

drawPathToHatch ​

▸ drawPathToHatch(dPatternScale?): McObjectId

将路径转换为填充图案

Parameters ​

Returns ​

McObjectId

转换结果

Example

import { MxCADUiPrPoint, MxCADUiPrDist, MxCpp } from "mxcad";
   // 实心圆
   async function Mx_SolidCircle() {
       const getCenter = new MxCADUiPrPoint();
       getCenter.setMessage('请确定圆心位置\n');
       const center = await getCenter.go();
       if (!center) return;
       const getRadius = new MxCADUiPrDist();
       getRadius.setBasePt(center);// 设置距离基点为圆心
       getRadius.setMessage('请输入圆半径');
       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);//设置圆路径
       mxcad.drawPathToHatch();// 绘制实心圆
   }

drawPathToPolyline ​

▸ drawPathToPolyline(): McObjectId

将路径转换为折线

Returns ​

McObjectId

转换结果

drawPathToSpline ​

▸ drawPathToSpline(): McObjectId

将路径转换为样条曲线

Returns ​

McObjectId

转换结果

drawPoint ​

▸ drawPoint(dX, dY): McObjectId

绘制点

Parameters ​

Returns ​

McObjectId

Example

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

drawSolid ​

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

绘制实体

Parameters ​

Returns ​

McObjectId

实体对象id

drawText ​

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

绘制单行文本

Parameters ​

Returns ​

McObjectId

成功返回 1，失败返回 0

Example

import { MxCpp, McObject } from "mxcad"
const mxcad:McObject = MxCpp.getCurrentMxCAD()
mxcad.drawText(0, 1900, "绘图控件文字测试", 100, 0, 0, 1);

getAllLayoutName ​

▸ getAllLayoutName(): McGeStringArray

得到所有布局名

Returns ​

McGeStringArray

getBackgroundEntity ​

▸ getBackgroundEntity(): McDbBackgroundEntity

返回当前背景对象

Returns ​

McDbBackgroundEntity

getCurrentDatabaseDrawColor ​

▸ getCurrentDatabaseDrawColor(): Color

返回当前数据库中设置的绘制颜色，它会自动依据背景色，把黑白色转换。

Returns ​

Color

getCurrentFileName ​

▸ getCurrentFileName(): string

获取当前文件名

Returns ​

string

当前文件名

getCurrentOriginaFileName ​

▸ getCurrentOriginaFileName(): string

获取当前文件名

Returns ​

string

当前文件名

getDatabase ​

▸ getDatabase(): McDbDatabase

获取数据库对象

Returns ​

McDbDatabase

数据库对象

Example

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

getImp ​

▸ getImp(): any

获取内部实现对象

Returns ​

any

内部实现对象

getMxCpp ​

▸ getMxCpp(): any

返加MxCpp对象，它会在MxDraw模块中调用。

Returns ​

any

getMxDrawObject ​

▸ getMxDrawObject(): MxDrawObject

返回与MxCAD对象绑定的MxDraw对象。

Returns ​

MxDrawObject

MxDraw对象

Example

import { McObject } from 'mxcad'

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

getSysVarDouble ​

▸ getSysVarDouble(varName): number

获取系统变量的浮点数值

Parameters ​

Returns ​

number

变量的浮点数值

getSysVarLong ​

▸ getSysVarLong(varName): number

获取系统变量的整数值

Parameters ​

Returns ​

number

变量的整数值

getSysVarPoint ​

▸ getSysVarPoint(varName): McGePoint3d

获取系统变量的点数值

Parameters ​

Returns ​

McGePoint3d

变量的点数值

getSysVarString ​

▸ getSysVarString(varName): string

获取系统变量的字符串值

Parameters ​

Returns ​

string

变量的字符串值

getViewCADCoord ​

▸ getViewCADCoord(): Object

返回当前视区的显示范围,cad坐标。

Returns ​

Object

当前视区显示范围

iniAuthorizedService ​

▸ iniAuthorizedService(sUrl): void

初始化用户授权服务url.

Parameters ​

Returns ​

void

init ​

▸ init(imp): void

初始对象

Parameters ​

Returns ​

void

initMxObject ​

▸ initMxObject(mxObject): void

初始化对象模型

Parameters ​

Returns ​

void

Description

initRegist ​

▸ initRegist(sRegist): void

初始化用户注册数据.

Parameters ​

Returns ​

void

insertBlock ​

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

插件图块文件

Parameters ​

Returns ​

Promise<McObjectId>

Example

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

isTryVersion ​

▸ isTryVersion(): boolean

当前程序是否是试用版本.

Returns ​

boolean

loadDwgBackground ​

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

加载另一个dwg文件当前背景对象绘制.

Parameters ​

Returns ​

void

loadImage ​

▸ loadImage(imageUrl, call): void

加载一个外部图片到当前上下文，方便后面使用。

Parameters ​

Returns ​

void

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

newFile ​

▸ newFile(): boolean

清空当前图上内容，新建一个文件

Returns ​

boolean

Example

import { MxCpp, McObject } from "mxcad" ;

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

objectIdToObject ​

▸ objectIdToObject(lIdIndex): null | McDbObject

将 lIdIndex 转换成 McDbObject 对象

Parameters ​

Returns ​

null | McDbObject

与 ID 对应的 McDbObject 对象，如果对象不存在则返回 null

off ​

▸ off(name, fun?): void

关闭事件监听

Parameters ​

Returns ​

void

Example

import { MxCpp, McObject } from "mxcad"

const mxcad:McObject = MxCpp.getCurrentMxCAD();
mxcad.off("selectChange");

on ​

▸ on(name, fun): void

监听对象选择事件

Parameters ​

Returns ​

void

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

▸ on(name, fun): void

监听文件完全打开

Parameters ​

Returns ​

void

▸ on(name, fun): void

监听项目初始化

Parameters ​

Returns ​

void

▸ on(name, fun): void

监听 mxdraw 初始化

Parameters ​

Returns ​

void

▸ on(name, fun): void

监听 mxdraw 初始化前的事件

Parameters ​

Returns ​

void

▸ on(name, fun): void

监听 mxcad 初始化

Parameters ​

Returns ​

void

▸ on(name, fun): void

监听数据库修改事件

Parameters ​

Returns ​

void

▸ on(name, fun): void

系统变量被修改

Parameters ​

Returns ​

void

▸ on(name, fun): void

图形数据库初始化

Parameters ​

Returns ​

void

▸ on(name, fun): void

图层数据发生了变化

Parameters ​

Returns ​

void

▸ on(name, fun): void

线型数据发生了变化

Parameters ​

Returns ​

void

openWebFile ​

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

打开网络文件

Parameters ​

Returns ​

boolean

是否成功打开文件

Example

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

pathCircle ​

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

根据圆对象创建一个路径

Parameters ​

Returns ​

boolean

Example

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

pathLineTo ​

▸ pathLineTo(dX, dY): void

从当前位置画一条直线到指定位置

Parameters ​

Returns ​

void

Example

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

pathLineToEx ​

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

从当前位置画一条直线到指定位置，同时指定起始宽度、终止宽度和凸度

Parameters ​

Returns ​

void

Example

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

pathMakeClosed ​

▸ pathMakeClosed(): void

闭合路径

Returns ​

void

pathMakeExclude ​

▸ pathMakeExclude(isExclude): void

把当前路径做上排除标记，主要用于填充的绘制，把这个路径组成的闭合区域在填充中挖去

Parameters ​

Returns ​

void

Example

import { MxCpp, McObject } from "mxcad"
   const mxcad:McObject = MxCpp.getCurrentMxCAD()
  //绘制一个实心有圆弧边界填充,中间挖去一块.
   mxcad.pathMoveToEx(440, 3310, 0, 0, 0);
   mxcad.pathLineTo(480, 3310);
   mxcad.pathLineTo(480, 3360);
   mxcad.pathLineTo(450, 3340);
  // 把上面定义的路径定义填充排除区域.
   mxcad.pathMakeExclude(true);

pathMoveTo ​

▸ pathMoveTo(dX, dY): void

将路径移动到指定位置

Parameters ​

Returns ​

void

Example

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

pathMoveToEx ​

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

移动路径到指定位置，同时指定起始宽度、终止宽度和凸度

Parameters ​

Returns ​

void

Example

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

redo ​

▸ redo(): void

反回退，重做。

Returns ​

void

regen ​

▸ regen(delayTime?): void

重绘图上所有对象，在调用ZoomAll,ZoomW后，因为是异步执行，可能需要延迟调用Regen才会启作用。

Parameters ​

Returns ​

void

Example

import { MxCpp, McObject } from 'mxcad'
 const mxcad:McObject = MxCpp.getCurrentMxCAD()
  //绘制一个带有宽度的圆
   mxcad.addLinetype("CircleLineType", "30,-5,7,-7");

   //设计当前线型为"CircleLineType"
   mxcad.drawLinetype = ("CircleLineType");

   mxcad.drawLineWidth = 40;

   mxcad.drawCircle(600, 800, 120);

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

saveFile ​

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

保存文件

Parameters ​