Question

mxcad API 文档 / 2d

Module: 2d

包含用于显示cad图纸的2d相关导出, 所有导出的内容都可以通过mxcad包导入直接使用

Example

import { createMxCad, McCmColor, McDbEntity } from "mxcad"

Table of contents

Namespaces

• McDb

Enumerations

• ColorIndexType
• ColorMethod
• FetchAttributes
• McObjectIdType
• MxCADResbufDataType
• MxCADSelectionSetStatus
• MxPropertiesWindowCustomValueType

Classes

• Color
• McAppType
• McCmColor
• McDbAlignedDimension
• McDbArc
• McDbAttribute
• McDbAttributeDefinition
• McDbBlockReference
• McDbBlockTable
• McDbBlockTableRecord
• McDbCircle
• McDbCurve
• McDbDatabase
• McDbDimension
• McDbEllipse
• McDbEntity
• McDbHatch
• McDbLayerTable
• McDbLayerTableRecord
• McDbLine
• McDbLinetypeTable
• McDbLinetypeTableRecord
• McDbMText
• McDbObject
• McDbObjectArray
• McDbPoint
• McDbPolyline
• McDbProxyEntity
• McDbRasterImage
• McDbRasterImageDef
• McDbRotatedDimension
• McDbText
• McDbTextStyleTable
• McDbTextStyleTableRecord
• McGeLongArray
• McGeMatrix3d
• McGePoint3d
• McGePoint3dArray
• McGeStringArray
• McGeVector3d
• McObject
• McObjectId
• McRxObject
• MdGeDoubleArray
• MxCADResbuf
• MxCADSelectionSet
• MxCADUiPrAngle
• MxCADUiPrBase
• MxCADUiPrDist
• MxCADUiPrEntity
• MxCADUiPrInt
• MxCADUiPrKeyWord
• MxCADUiPrPoint
• MxCADUiPrString
• MxCADUtilityClass
• MxCppType
• MxPropertiesWindowCustom
• MxPropertiesWindowCustomValue
• ObjectInheritance

Interfaces

• MxCADUI
• MxCadConfig

Type Aliases

• CreateColorArgs
• McCmColorJSON
• THREEColorArgs

Variables

• MxCADUtility
• MxCpp

Functions

• MxCheckTheBrowser
• Mx_Erase
• createMcCmColor
• createMxCad
• drawArc
• drawCircle
• drawEllipticalArc
• drawLine
• drawMText
• drawPolyLine
• drawPolygon
• drawRectang
• drawText
• getColorUtils
• getFilterImp
• getIndexColors
• getStyle
• loadMxCADassembly
• setMcCmColor

Type Aliases

CreateColorArgs

Ƭ CreateColorArgs: THREEColorArgs | [Partial<McCmColorJSON> | McCmColor]

---

McCmColorJSON

Ƭ McCmColorJSON: ExcludePropertiesContainingThisType<McCmColor, Function>

---

THREEColorArgs

Ƭ THREEColorArgs: [string | number | THREE.Color] | ConstructorArguments| []

Variables

MxCADUtility

• MxCADUtility: MxCADUtilityClass

---

MxCpp

• MxCpp: MxCppType

Functions

MxCheckTheBrowser

▸ MxCheckTheBrowser(): Object

Returns

Object

Name	Type
error	string
ok	boolean
var	any

---

Mx_Erase

▸ Mx_Erase(): Promise<void>

Returns

Promise<void>

---

createMcCmColor

▸ createMcCmColor(...ages): McCmColor

Parameters

Name	Type
...ages	CreateColorArgs

Returns

McCmColor

---

createMxCad

▸ createMxCad(config?): Promise<McObject>

创建MxCad实例

Example

通过创建实例实现图纸展示以下基于vite打包工具

createMxCad({
  canvas: "#myCanvas",
  locateFile: (fileName)=> new URL(`/node_modules/mxcad/dist/wasm/2d/${fileName}`, import.meta.url).href,
  fileUrl: new URL("/assets/test.mxweb", import.meta.url).href
})

Parameters

Name	Type
config?	MxCadConfig

Returns

Promise<McObject>

---

drawArc

▸ drawArc(): Promise<void>

Returns

Promise<void>

---

drawCircle

▸ drawCircle(): void

绘制圆

Returns

void

---

drawEllipticalArc

▸ drawEllipticalArc(): void

Returns

void

---

drawLine

▸ drawLine(): Promise<void>

Returns

Promise<void>

---

drawMText

▸ drawMText(): Promise<void>

Returns

Promise<void>

---

drawPolyLine

▸ drawPolyLine(): Promise<void>

Returns

Promise<void>

---

drawPolygon

▸ drawPolygon(): Promise<void>

Returns

Promise<void>

---

drawRectang

▸ drawRectang(): Promise<void>

Returns

Promise<void>

---

drawText

▸ drawText(): Promise<void>

绘制文字

Returns

Promise<void>

---

getColorUtils

▸ getColorUtils(...ages): Color

Parameters

Name	Type
...ages	THREEColorArgs

Returns

Color

---

getFilterImp

▸ getFilterImp(filter?): any

Parameters

Name	Type	Default value
filter	null \	MxCADResbuf	null

Returns

any

---

getIndexColors

▸ getIndexColors(): Color[]

Returns

Color[]

---

getStyle

▸ getStyle(mcCmColor): string

根据McCmColor颜色 生成css颜色值

Parameters

Name	Type
mcCmColor	McCmColor \	McCmColorJSON

Returns

string

---

loadMxCADassembly

▸ loadMxCADassembly(call?, locateFile?, wasmBinary?, fontspath?, networkFonts?): Promise<MxCppType>

Parameters

Name	Type
call?	(MxCpp: MxCppType) => void
locateFile	(fileName: string, base: string \	URL) => string
wasmBinary?	ArrayBuffer
fontspath?	string
networkFonts?	string[]

Returns

Promise<MxCppType>

---

setMcCmColor

▸ setMcCmColor(mcCmColor, ...ages): void

Parameters

Name	Type
mcCmColor	McCmColor
...ages	CreateColorArgs

Returns

void