mxcad_2d API 文档 / 2d / MxCadConfig

Interface: MxCadConfig ​

2d.MxCadConfig

createMxCad 的参数配置

Example

createMxCad({
    canvas: "#mxcad",
    locateFile: (fileName) => new URL(`/node_modules/mxcad/dist/wasm/2d/${fileName}`, import.meta.url).href,
    // 提供要打开的文件 注意../assets/test.mxweb 是相对路径下的文件地址, 
    // 在vite中可用通过这样的方式得到该文件正确的的网络地址
    fileUrl: new URL("../assets/test.mxweb", import.meta.url).href,
    // 提供加载字体的目录路径
    fontspath: new URL("node_modules/mxcad/dist/fonts", import.meta.url).href, 
    viewBackgroundColor:{red:0,green:0,blue:0}, //黑色背景
    middlePan:false, //禁用鼠标中间键操作
    multipleSelect: true, // 开启多选
    onOpenFileComplete:()=>{
      console.log("成功打开文件！")
    }
  })

Table of contents ​

Properties ​

• browse
• canvas
• enableIntelliSelect
• enableUndo
• fileUrl
• fontspath
• locateFile
• map
• middlePan
• mouseMiddlePan
• multipleSelect
• networkFonts
• onInit
• onOpenFileComplete
• openParameter
• registdata
• registfile
• viewBackgroundColor
• wasmBinary
• webgl1

Properties ​

browse ​

• Optional browse: boolean

是否启用浏览模式，默认是编辑模式

canvas ​

• Optional canvas: string | HTMLCanvasElement

当通过 MxFun.getCurrentDraw 未发现当前mxDraw实例时， 会通过 canvas属性(值可以是css选择器字符串也可以是一个canvas元素)来创建mxdraw实例 如果想要获得这个mxDraw实例 只需要调用mxdraw包中导出的 MxFun.getCurrentDraw方法即可 如果gis模式下，canvas变量不会使用，会自动使用mapbox的canvas.

enableIntelliSelect ​

• Optional enableIntelliSelect: boolean

是否启用选择功能，默认是使用

enableUndo ​

• Optional enableUndo: boolean

是否启用Undo

fileUrl ​

• Optional fileUrl: string

需要初始化打开的文件url路径

fontspath ​

• Optional fontspath: string

字体文件加载路径，默认是fonts

locateFile ​

• Optional locateFile: (fileName: string, base?: string | URL) => string

Type declaration ​

▸ (fileName, base?): string

获取加载wasm相关文件(wasm/js/worker.js)路径位置

Abstract

本质上locateFile配置函数就是返回wasm相关文件在自己的服务器上的位置 在npm包中node_modules/mxcad/dist/wasm/2d/下的文件就是支持2d的相关wasm文件

Parameters ​

Returns ​

string

filePath 默认采用base + fileName

map ​

• Optional map: any

地图模块

middlePan ​

• Optional middlePan: number | boolean

鼠标中间键操作设置,默认为鼠标中间移动视区

mouseMiddlePan ​

• Optional mouseMiddlePan: number

使用鼠标中键移动视区，默认是使用

multipleSelect ​

• Optional multipleSelect: boolean

多选模式

networkFonts ​

• Optional networkFonts: string[]

服务器上可供加载的字体列表

onInit ​

• Optional onInit: Function

mxdraw和mxcad 核心代码加载完成初始化的回调 onInit默认值函数如下实例所示（请根据你的业务需求自行修改）

Example

import { MxFun } from "mxdraw"
onInit() {
 MxFun.setIniset({
      // 启用对象选择功能.
     EnableIntelliSelect: true,
      // 选择类型
     IntelliSelectType: 1,
      // 是否开启多个选择
     multipleSelect: false,
  });
}

onOpenFileComplete ​

• Optional onOpenFileComplete: Function

监听打开文件成功回调事件

openParameter ​

• Optional openParameter: object

打开文件参数设置，如，打开文件不使用缓存：

registdata ​

• Optional registdata: string

注册数据

registfile ​

• Optional registfile: string

注册文件

viewBackgroundColor ​

• Optional viewBackgroundColor: Object

视区背景颜色

Type declaration ​

wasmBinary ​

• Optional wasmBinary: ArrayBuffer

WebAssembly 模块二进制文件 默认情况无需配置 *

webgl1 ​

• Optional webgl1: boolean

是否使用webgl1方式启动