mxcad-app 1.0.18 → 1.0.20

package/README.md

@@ -1,253 +1,253 @@
-# mxcad-app
-
-[![npm version](https://badge.fury.io/js/mxcad-app.svg)](https://badge.fury.io/js/mxcad-app)
-
-`mxcad-app` 是一个在线 CAD 项目, 用户可以直接集成它。
-
-## 🎯 一句话理解
-**mxcad-app = 一个开箱即用的在线CAD软件**，集成到你的网页就像搭积木一样简单，3分钟就能让你的网站拥有专业CAD功能。
-
-## 📦 安装
-
-使用 npm 或 yarn 安装 `mxcad-app`：
-
-```bash
-npm install mxcad-app --save
-```
-
-或者
-
-```bash
-yarn add mxcad-app
-```
-
-## 🚀 使用方法（3分钟搞定）
-
-### 基于 vite
-
-main.js
-
-```js
-import "mxcad-app/style";
-import { MxCADView } from "mxcad-app";
-new MxCADView().create();
-```
-
-vite.config.js
-
-```js
-import { defineConfig } from "vite";
-import { mxcadAssetsPlugin } from "mxcad-app/vite";
-
-export default defineConfig({
-  plugins: [mxcadAssetsPlugin()],
-});
-```
-
-### 基于 webpack
-
-webpack.config.js
-
-```js
-const { MxCadAssetsWebpackPlugin } = require("mxcad-app/webpack");
-// webpack.config.js
-const webpack = require("webpack");
-
-module.exports = {
-  // ...
-  mode: "development",
-  module: {
-    rules: [
-      {
-        test: /\.css$/, // 匹配所有 .css 文件
-        use: [
-          "style-loader", // 第二步：将 CSS 代码注入到 DOM 的 <style> 标签中
-          "css-loader", // 第一步：解析 CSS 文件，处理 @import 和 url()
-        ],
-        include: [path.resolve(__dirname, "src"), path.resolve(__dirname, "node_modules/mxcad-app")], // 可选：只处理 src 下的 css
-      },
-    ],
-  },
-  plugins: [
-    new webpack.ContextReplacementPlugin(
-      /mxcad-app/, // 匹配包含 mxcad-app 的模块路径
-      path.resolve(__dirname, "src") // 限制上下文查找范围
-    ),
-    new MxCadAssetsWebpackPlugin(),
-  ],
-  // ...
-  devServer: {
-    static: "./dist",
-    port: 3000,
-  },
-};
-```
-
-main.js
-
-```js
-import "mxcad-app/style";
-import { MxCADView } from "mxcad-app";
-new MxCADView().create();
-```
-
-## 🛠️ 进阶配置
-
-### 自定义容器
-
-```html
-<div id="app"></div>
-```
-
-```js
-import { MxCADView, mxcadApp } from "mxcad-app";
-new MxCADView({
-  openFile: new URL("test.mxweb", mxcadApp.getStaticAssetPath()).toString(),
-  rootContainer: "#app",
-});
-```
-
-### 静态资源设置
-
-静态资源设置可以通过调用`setStaticAssetPath`
-
-```js
-import { mxcadApp } from "mxcad-app";
-mxcadApp.setStaticAssetPath("https://unpkg.com/mxcad-app/dist/mxcadAppAssets");
-```
-
-## 核心依赖库
-
-`mxcad-app`内置了[`mxcad`](https://www.mxdraw3d.com/mxcad_docs/zh/1.%E5%BC%80%E5%A7%8B/2.%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8.html) 核心库，你可以直接使用`mxcad` 不需要安装`mxcad`。
-
-
-```js
-import { MxCpp } from 'mxcad'
-```
-
-如果不是模块化的方式使用,`mxcad`在`window.MxCAD`挂载你可以直接使用`MxCAD`访问到需要的方法和类。
-
-`mxcad`依赖`mxdraw`, 你也可以使用`mxdraw`
-
-```js
-import * as Mx from 'mxdraw'
-```
-
-如果不是模块化的方式使用, `mxdraw` 在 `window.Mx` 挂载。你可以直接使用`Mx`访问到需要的方法和类。
-
-直接引入`mxcad`和`mxdraw`模块的前提是要使用构建工具构建。我们提供给了webpack和vite的插件, 用于支持模块化开发。
-
-只要使用了插件就可以直接使用`import`引入`mxcad`和`mxdraw`模块。
-
-### 使用 mxcad-app 依赖映射
-
-你可以直接引入使用mxcad-app内部使用的mxcad和mxdraw模块。同时你也可以添加配置`libraryNames`使用其他的外部依赖的npm库。
-目前支持的依赖映射的库有`vue`, `axios`, `vuetify`, `vuetify/components`, `mapboxgl`, `pinia` 你也可以访问`window.MXCADAPP_EXTERNALLIBRARIES`获取到所有提供的依赖库，从而不依赖与构建工具的使用。
-比如`vue`框架,只需要添加依赖映射配置， 如:
-vite.config.js
-
-```js
-import { mxcadAssetsPlugin } from "mxcad-app/vite";
-// vite.config.js
-export default {
-  plugins: [
-    mxcadAssetsPlugin({
-      libraryNames: ["vue"],
-    }),
-  ],
-};
-```
-
-webpack.config.js
-
-```js
-import { MxCadAssetsWebpackPlugin } from "mxcad-app/webpack";
-// webpack.config.js
-module.exports = {
-  // 其他配置...
-  plugins: [
-    new MxCadAssetsWebpackPlugin({
-      libraryNames: ["vue"]
-    }),
-  ],
-};
-```
-
-就可以正常使用mxcad-app中的vue模块（mxcad-app打包的内部vue模块）
-```js
-import { ref } from "vue";
-const n = ref(1)
-```
-
-## 🛠️ 运行时配置修改
-
-在构建时修改配置文件：
-
-### vite
-```js
-import { mxcadAssetsPlugin } from "mxcad-app/vite";
-
-export default {
-  plugins: [
-    mxcadAssetsPlugin({
-      // 修改UI配置
-      transformMxcadUiConfig: (config) => {
-        config.title = "我的CAD"; // 修改标题
-        return config;
-      },
-      // 修改服务器配置  
-      transformMxServerConfig: (config) => {
-        config.serverUrl = "/api/cad"; // 修改API地址
-        return config;
-      },
-      // 修改快捷命令(命令别名)
-      // transformMxQuickCommand: (config) => config
-
-      // 修改草图与注释UI模式的配置
-      // transformMxSketchesAndNotesUiConfig: (config) => config
-
-      // 修改UI配置
-      // transformMxUiConfig: (config) => config,
-
-      // 修改Vuetify主题配置
-      // transformVuetifyThemeConfig: (config) => config
-    })
-  ]
-};
-```
-
-### webpack
-```js
-import { MxCadAssetsWebpackPlugin } from "mxcad-app/webpack";
-
-module.exports = {
-  plugins: [
-    new MxCadAssetsWebpackPlugin({
-      transformMxServerConfig: (config) => {
-        if (process.env.NODE_ENV === 'production') {
-          config.serverUrl = 'https://api.prod.com/cad';
-        }
-        return config;
-      }
-    })
-  ]
-};
-```
-
-## 📚 常见问题速查
-
-**Q: 支持哪些CAD格式？**
-A: DWG、DXF等主流格式以及自定义文件格式(mxweb)
-
-**Q: 是否需要安装CAD软件？**
-A: 不需要！纯Web方案，浏览器就能用
-
-**Q: 能否集成到现有系统？**
-A: 可以！直接使用mxcad-app就可以无缝集成
-
-## 📄 许可证
-
-`mxcad-app` 是自定义许可证。更多信息，请参阅 [LICENSE](./LICENSE) 文件。
-
----
-如果有任何问题或建议，请随时联系我们。
+# mxcad-app
+
+[![npm version](https://badge.fury.io/js/mxcad-app.svg)](https://badge.fury.io/js/mxcad-app)
+
+`mxcad-app` 是一个在线 CAD 项目, 用户可以直接集成它。
+
+## 🎯 一句话理解
+**mxcad-app = 一个开箱即用的在线CAD软件**，集成到你的网页就像搭积木一样简单，3分钟就能让你的网站拥有专业CAD功能。
+
+## 📦 安装
+
+使用 npm 或 yarn 安装 `mxcad-app`：
+
+```bash
+npm install mxcad-app --save
+```
+
+或者
+
+```bash
+yarn add mxcad-app
+```
+
+## 🚀 使用方法（3分钟搞定）
+
+### 基于 vite
+
+main.js
+
+```js
+import "mxcad-app/style";
+import { MxCADView } from "mxcad-app";
+new MxCADView().create();
+```
+
+vite.config.js
+
+```js
+import { defineConfig } from "vite";
+import { mxcadAssetsPlugin } from "mxcad-app/vite";
+
+export default defineConfig({
+  plugins: [mxcadAssetsPlugin()],
+});
+```
+
+### 基于 webpack
+
+webpack.config.js
+
+```js
+const { MxCadAssetsWebpackPlugin } = require("mxcad-app/webpack");
+// webpack.config.js
+const webpack = require("webpack");
+
+module.exports = {
+  // ...
+  mode: "development",
+  module: {
+    rules: [
+      {
+        test: /\.css$/, // 匹配所有 .css 文件
+        use: [
+          "style-loader", // 第二步：将 CSS 代码注入到 DOM 的 <style> 标签中
+          "css-loader", // 第一步：解析 CSS 文件，处理 @import 和 url()
+        ],
+        include: [path.resolve(__dirname, "src"), path.resolve(__dirname, "node_modules/mxcad-app")], // 可选：只处理 src 下的 css
+      },
+    ],
+  },
+  plugins: [
+    new webpack.ContextReplacementPlugin(
+      /mxcad-app/, // 匹配包含 mxcad-app 的模块路径
+      path.resolve(__dirname, "src") // 限制上下文查找范围
+    ),
+    new MxCadAssetsWebpackPlugin(),
+  ],
+  // ...
+  devServer: {
+    static: "./dist",
+    port: 3000,
+  },
+};
+```
+
+main.js
+
+```js
+import "mxcad-app/style";
+import { MxCADView } from "mxcad-app";
+new MxCADView().create();
+```
+
+## 🛠️ 进阶配置
+
+### 自定义容器
+
+```html
+<div id="app"></div>
+```
+
+```js
+import { MxCADView, mxcadApp } from "mxcad-app";
+new MxCADView({
+  openFile: new URL("test.mxweb", mxcadApp.getStaticAssetPath()).toString(),
+  rootContainer: "#app",
+});
+```
+
+### 静态资源设置
+
+静态资源设置可以通过调用`setStaticAssetPath`
+
+```js
+import { mxcadApp } from "mxcad-app";
+mxcadApp.setStaticAssetPath("https://unpkg.com/mxcad-app/dist/mxcadAppAssets");
+```
+
+## 核心依赖库
+
+`mxcad-app`内置了[`mxcad`](https://www.mxdraw3d.com/mxcad_docs/zh/1.%E5%BC%80%E5%A7%8B/2.%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8.html) 核心库，你可以直接使用`mxcad` 不需要安装`mxcad`。
+
+
+```js
+import { MxCpp } from 'mxcad'
+```
+
+如果不是模块化的方式使用,`mxcad`在`window.MxCAD`挂载你可以直接使用`MxCAD`访问到需要的方法和类。
+
+`mxcad`依赖`mxdraw`, 你也可以使用`mxdraw`
+
+```js
+import * as Mx from 'mxdraw'
+```
+
+如果不是模块化的方式使用, `mxdraw` 在 `window.Mx` 挂载。你可以直接使用`Mx`访问到需要的方法和类。
+
+直接引入`mxcad`和`mxdraw`模块的前提是要使用构建工具构建。我们提供给了webpack和vite的插件, 用于支持模块化开发。
+
+只要使用了插件就可以直接使用`import`引入`mxcad`和`mxdraw`模块。
+
+### 使用 mxcad-app 依赖映射
+
+你可以直接引入使用mxcad-app内部使用的mxcad和mxdraw模块。同时你也可以添加配置`libraryNames`使用其他的外部依赖的npm库。
+目前支持的依赖映射的库有`vue`, `axios`, `vuetify`, `vuetify/components`, `mapboxgl`, `pinia` 你也可以访问`window.MXCADAPP_EXTERNALLIBRARIES`获取到所有提供的依赖库，从而不依赖与构建工具的使用。
+比如`vue`框架,只需要添加依赖映射配置， 如:
+vite.config.js
+
+```js
+import { mxcadAssetsPlugin } from "mxcad-app/vite";
+// vite.config.js
+export default {
+  plugins: [
+    mxcadAssetsPlugin({
+      libraryNames: ["vue"],
+    }),
+  ],
+};
+```
+
+webpack.config.js
+
+```js
+import { MxCadAssetsWebpackPlugin } from "mxcad-app/webpack";
+// webpack.config.js
+module.exports = {
+  // 其他配置...
+  plugins: [
+    new MxCadAssetsWebpackPlugin({
+      libraryNames: ["vue"]
+    }),
+  ],
+};
+```
+
+就可以正常使用mxcad-app中的vue模块（mxcad-app打包的内部vue模块）
+```js
+import { ref } from "vue";
+const n = ref(1)
+```
+
+## 🛠️ 运行时配置修改
+
+在构建时修改配置文件：
+
+### vite
+```js
+import { mxcadAssetsPlugin } from "mxcad-app/vite";
+
+export default {
+  plugins: [
+    mxcadAssetsPlugin({
+      // 修改UI配置
+      transformMxcadUiConfig: (config) => {
+        config.title = "我的CAD"; // 修改标题
+        return config;
+      },
+      // 修改服务器配置  
+      transformMxServerConfig: (config) => {
+        config.serverUrl = "/api/cad"; // 修改API地址
+        return config;
+      },
+      // 修改快捷命令(命令别名)
+      // transformMxQuickCommand: (config) => config
+
+      // 修改草图与注释UI模式的配置
+      // transformMxSketchesAndNotesUiConfig: (config) => config
+
+      // 修改UI配置
+      // transformMxUiConfig: (config) => config,
+
+      // 修改Vuetify主题配置
+      // transformVuetifyThemeConfig: (config) => config
+    })
+  ]
+};
+```
+
+### webpack
+```js
+import { MxCadAssetsWebpackPlugin } from "mxcad-app/webpack";
+
+module.exports = {
+  plugins: [
+    new MxCadAssetsWebpackPlugin({
+      transformMxServerConfig: (config) => {
+        if (process.env.NODE_ENV === 'production') {
+          config.serverUrl = 'https://api.prod.com/cad';
+        }
+        return config;
+      }
+    })
+  ]
+};
+```
+
+## 📚 常见问题速查
+
+**Q: 支持哪些CAD格式？**
+A: DWG、DXF等主流格式以及自定义文件格式(mxweb)
+
+**Q: 是否需要安装CAD软件？**
+A: 不需要！纯Web方案，浏览器就能用
+
+**Q: 能否集成到现有系统？**
+A: 可以！直接使用mxcad-app就可以无缝集成
+
+## 📄 许可证
+
+`mxcad-app` 是自定义许可证。更多信息，请参阅 [LICENSE](./LICENSE) 文件。
+
+---
+如果有任何问题或建议，请随时联系我们。

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { LocaleInstance } from 'vuetify';
 import { LocaleMessages } from 'vuetify';
 import { LocaleOptions } from 'vuetify';
 import { McObject } from 'mxcad';
+import { MxCADPluginSampleCode } from 'mxcad';
 import { Ref } from 'vue';
 import { ShallowRef } from 'vue';
 import { ThemeInstance } from 'vuetify';
@@ -146,6 +147,8 @@ declare class MxCADApp extends MxCADEvents {
         };
         goTo: GoToInstance;
     }>;
+    /** 初始化代码编辑器的代码示例 */
+    initCodeEditorCodeExamples(codes: MxCADPluginSampleCode[]): void;
 }
 
 export declare let mxcadApp: MxCADApp;
@@ -219,26 +222,25 @@ declare module '@howdyjs/to-drag' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        TextDecoration: {
+        fontSize: {
             /**
              * Set the font size attribute
              */
-            setTextDecoration: (textDecoration: string) => ReturnType;
+            setFontSize: (size: string) => ReturnType;
             /**
              * Unset the font size attribute
              */
-            unsetTextDecoration: () => ReturnType;
+            unsetFontSize: () => ReturnType;
         };
     }
 }
 
 
-declare module '@tiptap/core' {
+declare module "@tiptap/core" {
     interface Commands<ReturnType> {
-        Underline: {
-            setUnderline: () => ReturnType;
-            unsetUnderline: () => ReturnType;
-            toggleUnderline: () => ReturnType;
+        selectedText: {
+            setSelectedText: (from: number, to: number) => ReturnType;
+            unsetSelectedText: (from: number, to: number) => ReturnType;
         };
     }
 }
@@ -261,11 +263,12 @@ declare module '@tiptap/core' {
 }
 
 
-declare module "@tiptap/core" {
+declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        selectedText: {
-            setSelectedText: (from: number, to: number) => ReturnType;
-            unsetSelectedText: (from: number, to: number) => ReturnType;
+        Underline: {
+            setUnderline: () => ReturnType;
+            unsetUnderline: () => ReturnType;
+            toggleUnderline: () => ReturnType;
         };
     }
 }
@@ -273,15 +276,16 @@ declare module "@tiptap/core" {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        fontSize: {
+        Strike: {
             /**
              * Set the font size attribute
              */
-            setFontSize: (size: string) => ReturnType;
+            setStrike: () => ReturnType;
             /**
              * Unset the font size attribute
              */
-            unsetFontSize: () => ReturnType;
+            unsetStrike: () => ReturnType;
+            toggleStrike: () => ReturnType;
         };
     }
 }
@@ -289,16 +293,15 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        Strike: {
+        TextDecoration: {
             /**
              * Set the font size attribute
              */
-            setStrike: () => ReturnType;
+            setTextDecoration: (textDecoration: string) => ReturnType;
             /**
              * Unset the font size attribute
              */
-            unsetStrike: () => ReturnType;
-            toggleStrike: () => ReturnType;
+            unsetTextDecoration: () => ReturnType;
         };
     }
 }

package/dist/mxcad.d.ts

@@ -4648,8 +4648,7 @@ declare module "mxcad" {
   	 * ```ts
   	 * import { McGePoint3d, McDbCircle } from "mxcad"
   	 *
-  	 * const center = new McGePoint3d(0,0,0);
-  	 * const circle = new McDbCircle(center, 20);
+  	 * const circle = new McDbCircle(0,0,0, 20);
   	 * const area = circle.getArea();
   	 * console.log("圆面积：", area)
   	 * ```
@@ -5029,8 +5028,7 @@ declare module "mxcad" {
   	 * ```ts
   	 * import { McGePoint3d, McDbCircle } from "mxcad"
   	 *
-  	 * const center = new McGePoint3d(0,0,0);
-  	 * const circle = new McDbCircle(center, 20);
+  	 * const circle = new McDbCircle(0,0,0, 20);
   	 * const vec = circle.getFirstDeriv(new McGePoint3d(20,0,0));//目标点切向量
   	 * if(vec.ret){
   	 *  const val = vec.val;
@@ -5050,8 +5048,7 @@ declare module "mxcad" {
   	 * ```ts
   	 * import { McGePoint3d, McDbCircle, MxCADUiPrPoint, MxCpp } from "mxcad"
   	 *
-  	 * const center = new McGePoint3d(0,0,0);
-  	 * const circle = new McDbCircle(center, 20);
+  	 * const circle = new McDbCircle(0,0,0, 20);
   	 * const mxcad = MxCpp.getCurrentMxCAD();
   	 * mxcad.drawEntity(circle);
   	 *
@@ -7752,7 +7749,7 @@ declare module "mxcad" {
    * 表示图案填充类，实现实心颜色填充和各种图案填充效果
    * @example
    * ```ts
-     import { MxCADUiPrPoint, MxCADUtility, McDbHatch, MxCpp, McDb} from "mxcad"
+     import { MxCADUiPrPoint, MxCADUtility, McDbHatch, MxCpp, McDb, McCmColor} from "mxcad"
      //选点填充
   	const getPoint = new MxCADUiPrPoint();
   	console.log("\n指定填充区域内部一点:");
@@ -12246,7 +12243,7 @@ declare module "mxcad" {
   	 * @param dAng 图片角度,单位是度
   	 * @param imageUrl 图片路径
   	 */
-  	drawImage(dPosX: number, dPosY: number, dWidth: number, dHeight: number, dAng: number, imageUrl: string, isConvertBase64?: boolean, dwgImageSizeWidth?: number, dwgImageSizeHeight?: number): McObjectId;
+  	drawImage(dPosX: number, dPosY: number, dWidth: number, dHeight: number, dAng: number, imageName: string, isConvertBase64?: boolean, dwgImageSizeWidth?: number, dwgImageSizeHeight?: number, imageUrl?: string): McObjectId;
   	/**
   	 * 添加一个图片定义到cad数据库中 。
   	 * @param imageUrl 图片路径
@@ -12266,7 +12263,7 @@ declare module "mxcad" {
   		});
   	 * ```
   	 */
-  	addImageDefine(imageUrl: string, sName?: string, isConvertBase64?: boolean): McObjectId;
+  	addImageDefine(imageUrl: string, sName?: string, isConvertBase64?: boolean, sourceFileName?: string): McObjectId;
   	/**
   	 * 显示线重
   	*/