@jlceda/pro-api-types 0.1.171 → 0.1.173

package/index.d.ts

@@ -892,6 +892,7 @@ declare class EDA {
     sys_MessageBox: SYS_MessageBox;
     sys_MessageBus: SYS_MessageBus;
     sys_PanelControl: SYS_PanelControl;
+    sys_RightClickMenu: SYS_RightClickMenu;
     sys_Setting: SYS_Setting;
     sys_ShortcutKey: SYS_ShortcutKey;
     sys_Storage: SYS_Storage;
@@ -1875,7 +1876,9 @@ declare enum ESYS_NetlistType {
     /** EasyEDA Pro Edition */
     EASYEDA_PRO = "EasyEDA",
     /** Altium Designer */
-    ALTIUM_DESIGNER = "Protel2"
+    ALTIUM_DESIGNER = "Protel2",
+    /** 数字化工业软件联盟 */
+    DISA = "DISA"
 }
 
 /**
@@ -2095,6 +2098,8 @@ declare interface IDMT_EditorDocumentItem {
     documentType: EDMT_EditorDocumentType;
     /** 文档 UUID */
     uuid: string;
+    /** 文档的标签页 ID */
+    tabId: string;
     /** 文档所属工程 UUID */
     parentProjectUuid?: string;
     /** 库文档所属库 UUID */
@@ -2722,6 +2727,12 @@ declare interface ILIB_ExtendLibraryDeviceFunctions extends ILIB_ExtendLibraryFu
         manufacturer?: string;
         description?: string;
     }>>;
+    /**
+     * 获取支持的符号类型
+     *
+     * @returns 符号类型数组
+     */
+    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -2775,12 +2786,6 @@ declare interface ILIB_ExtendLibraryFunctions {
      * @returns 库元素列表
      */
     getList: (props: ILIB_ExtendLibrarySearchProperty<any>) => Promise<ILIB_ExtendLibrarySearchResult<any>>;
-    /**
-     * 获取支持的符号类型
-     *
-     * @returns 符号类型数组
-     */
-    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -2877,6 +2882,12 @@ declare interface ILIB_ExtendLibrarySymbolFunctions extends ILIB_ExtendLibraryFu
         modifier?: ILIB_ExtendLibraryUserIndex;
         owner?: ILIB_ExtendLibraryUserIndex;
     }>>;
+    /**
+     * 获取支持的符号类型
+     *
+     * @returns 符号类型数组
+     */
+    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -3060,10 +3071,16 @@ declare interface ILIB_SymbolSearchItem {
  * @public
  */
 declare interface IPCB_BomPropertiesTableColumns {
+    /** 属性 */
     property: string;
+    /** 显示名称 */
     title?: string;
+    /** 排序规则 */
     sort?: null | 'asc' | 'desc';
+    /** 是否分组 */
     group?: null | 'Yes' | 'No';
+    /** 排列权重（大权重优先在 BOM 的左侧） */
+    orderWeight?: number;
 }
 
 /**
@@ -4120,7 +4137,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveComponent;
     /**
-     * 设置属性状态：是否加入 BOM
+     * 设置属性状态：��否加入 BOM
      *
      * @beta
      * @param addIntoBom - 是否加入 BOM
@@ -5396,7 +5413,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Layer(): TPCB_LayersOfPad;
     /**
-     * 获取属性���态：焊盘编号
+     * 获取属性状态：焊盘编号
      *
      * @public
      * @returns 焊盘编号
@@ -5975,7 +5992,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      */
     getState_PourFillMethod(): any;
     /**
-     * 获取属性状态：是否保留孤岛
+     * 获取属性状态��是否保留孤岛
      *
      * @public
      * @returns 是否保留孤岛
@@ -6609,7 +6626,7 @@ declare class IPCB_PrimitiveString implements IPCB_Primitive {
      */
     setState_Text(text: string): IPCB_PrimitiveString;
     /**
-     * 设置属性状态：字体
+     * 设置属性���态：字体
      *
      * @beta
      * @param fontFamily - 字体
@@ -7927,7 +7944,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
         [key: string]: string | number | boolean;
     }): ISCH_PrimitiveComponent;
     /**
-     * 将图元转换为异��图元
+     * 将图元转换为异步图元
      *
      * @public
      * @returns 圆弧线图元对象
@@ -9190,7 +9207,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      */
     setState_TextColor(textColor: string | null): ISCH_PrimitiveText;
     /**
-     * 设置属性状态：字体名称
+     * 设置属性状��：字体名称
      *
      * @beta
      * @param fontName - 字体名称
@@ -9209,7 +9226,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      * 设置属性状态：是否加粗
      *
      * @beta
-     * @param bold - 是���加粗
+     * @param bold - 是否加粗
      * @returns 文本图元对象
      */
     setState_Bold(bold: boolean): ISCH_PrimitiveText;
@@ -9443,67 +9460,71 @@ declare interface ISYS_FileSystemFileList {
  */
 declare interface ISYS_HeaderMenus {
     /** 主页 */
-    home?: Array<ISYS_HeaderMenuTopMenus>;
+    home?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 空白页 */
-    blank?: Array<ISYS_HeaderMenuTopMenus>;
+    blank?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 原理图 */
-    schematic?: Array<ISYS_HeaderMenuTopMenus>;
+    schematic?: Array<ISYS_HeaderMenuTopMenuItem>;
     /**
      * 原理图
      *
      * @deprecated 请使用 `schematic` 替代 `sch`
      */
-    sch?: Array<ISYS_HeaderMenuTopMenus>;
+    sch?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 符号（包括 CBB 符号） */
-    symbol?: Array<ISYS_HeaderMenuTopMenus>;
+    symbol?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** PCB */
-    pcb?: Array<ISYS_HeaderMenuTopMenus>;
+    pcb?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 封装 */
-    footprint?: Array<ISYS_HeaderMenuTopMenus>;
+    footprint?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** PCB 预览（包括 2D、3D 预览） */
-    pcbView?: Array<ISYS_HeaderMenuTopMenus>;
+    pcbView?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 面板 */
-    panel?: Array<ISYS_HeaderMenuTopMenus>;
+    panel?: Array<ISYS_HeaderMenuTopMenuItem>;
     /** 面板预览 */
-    panelView?: Array<ISYS_HeaderMenuTopMenus>;
+    panelView?: Array<ISYS_HeaderMenuTopMenuItem>;
 }
 
 /**
- * 顶部二级菜单
+ * 顶部二级菜单项
  *
  * @public
  */
-declare interface ISYS_HeaderMenuSub1Menus {
+declare interface ISYS_HeaderMenuSub1MenuItem {
     /** 菜单项 ID，不可重复 */
     id: string;
     /** 菜单项标题 */
     title: string;
+    /** 菜单项图标 */
+    icon?: string;
     /** 注册方法名称（需要在扩展入口文件导出该方法） */
     registerFn?: string;
     /** 子菜单项 */
-    menuItems?: Array<ISYS_HeaderMenuSub2Menus | null>;
+    menuItems?: Array<ISYS_HeaderMenuSub2MenuItem | null>;
 }
 
 /**
- * 顶部三级菜单
+ * 顶部三级菜单项
  *
  * @public
  */
-declare interface ISYS_HeaderMenuSub2Menus {
+declare interface ISYS_HeaderMenuSub2MenuItem {
     /** 菜单项 ID，不可重复 */
     id: string;
     /** 菜单项标题 */
     title: string;
+    /** 菜单项图标 */
+    icon?: string;
     /** 注册方法名称（需要在扩展入口文件导出该方法） */
     registerFn?: string;
 }
 
 /**
- * 顶部一级菜单
+ * 顶部一级菜单项
  *
  * @public
  */
-declare interface ISYS_HeaderMenuTopMenus {
+declare interface ISYS_HeaderMenuTopMenuItem {
     /** 菜单项 ID，不可重复 */
     id: string;
     /** 菜单项标题 */
@@ -9511,7 +9532,7 @@ declare interface ISYS_HeaderMenuTopMenus {
     /** 注册方法名称（需要在扩展入口文件导出该方法） */
     registerFn?: string;
     /** 子菜单项 */
-    menuItems?: Array<ISYS_HeaderMenuSub1Menus | null>;
+    menuItems?: Array<ISYS_HeaderMenuSub1MenuItem | null>;
 }
 
 /**
@@ -9570,6 +9591,24 @@ declare interface ISYS_MultilingualLanguagesData {
     [language: string]: ISYS_LanguageKeyValuePairs;
 }
 
+/**
+ * 右键菜单项
+ *
+ * @public
+ */
+declare interface ISYS_RightClickMenuItem {
+    /** 菜单项 ID，不可重复 */
+    id: string;
+    /** 菜单项标题 */
+    title?: string;
+    /** 菜单项图标 */
+    icon?: string;
+    /** 注册方法名称（需要在扩展入口文件导出该方法） */
+    registerFn?: string;
+    /** 子菜单项 */
+    menuItems?: Array<ISYS_RightClickMenuItem | null>;
+}
+
 /**
  * 窗口事件监听可移除对象
  *
@@ -10112,6 +10151,9 @@ declare class LIB_Footprint {
  * @remarks 此处所有接口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
  */
 declare class LIB_LibrariesList {
+    /** 扩展 UUID */
+    private extensionUuid?;
+    /* Excluded from this release type: __constructor */
     /**
      * 获取系统库的 UUID
      *
@@ -10483,7 +10525,7 @@ declare class PCB_Document {
      * @remarks
      * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
      *
-     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
+     * 例如：传入���据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
      * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
      *
      * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
@@ -12925,7 +12967,7 @@ declare class SCH_ManufactureData {
      * @param fileType - 文件类型
      * @param template - 模板名称
      * @param filterOptions - 过滤规则，仅应包含需要启用的规则，`property` 为规则名称，`includeValue` 为匹配的值
-     * @param statistics - 统计，包含所有需要启用的统计项���名称
+     * @param statistics - 统计，包含所有需要启用的统计项的名称
      * @param property - 属性，包含所有需要启用的属性的名称
      * @param columns - 列的属性及排序，`title`、`sort`、`group`、`orderWeight` 不传入则取默认值，`null` 代表 **无** 或 **空**
      * @returns BOM 文件数据
@@ -13656,7 +13698,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * @param mirror - 是否镜像
      * @param addIntoBom - 是否加入 BOM
      * @param addIntoPcb - 是否转到 PCB
-     * @returns 器件图元对象
+     * @returns 器件图元对���
      */
     create(component: {
         libraryUuid: string;
@@ -13679,7 +13721,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * 创建网络端口
      *
      * @beta
-     * @param direction - 端口方���
+     * @param direction - 端口方向
      * @param net - 网络名称
      * @param x - 坐标 X
      * @param y - 坐标 Y
@@ -14034,7 +14076,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元���返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象，空数组表示获取失败
      */
@@ -14413,7 +14455,7 @@ declare class SYS_Dialog {
      * @param defaultOption - 默认选项，以选项的值作为匹配参数，如若 `multiple` 参数为 `true`，则此处需要传入字符串数组
      * @param multiple - 是否支持多选，默认为单选框
      * @param callbackFn - 回调函数
-     * @returns 用户选择的值，对应传入的 `options` 中的 `value` 字段
+     * @returns 用户选择的值，对应传入的 `options` ���的 `value` 字段
      */
     showSelectDialog(options: Array<string> | Array<{
         value: string;
@@ -14521,6 +14563,27 @@ declare class SYS_Environment {
      * @returns 编辑器编译日期
      */
     getEditorCompliedDate(): string;
+    /**
+     * 获取用户信息
+     *
+     * @public
+     * @returns 用户信息
+     */
+    getUserInfo(): {
+        username?: string;
+        nickname?: string;
+        avatar?: string;
+        uuid?: string;
+        customerCode?: string;
+    };
+    /**
+     * 设置环境：保持工程仅拥有一个板子
+     *
+     * @public
+     * @remarks Board、Schematic、PCB 均保持唯一
+     * @param status - 环境变量状态
+     */
+    setKeepProjectHasOnlyOneBoard(status?: boolean): Promise<void>;
 }
 
 /**
@@ -14741,9 +14804,20 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @param filenameExtensions - 文件扩展名
+     * @param multiFiles - 是否允许读取多文件
+     * @returns File 格式文件数组
+     */
+    openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: true): Promise<Array<File> | undefined>;
+    /**
+     * 打开读入文件窗口
+     *
+     * @beta
+     * @param filenameExtensions - 文件扩展名
+     * @param multiFiles - 是否允许读取多文件
      * @returns File 格式文件
      */
-    openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
+    openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: false): Promise<File | undefined>;
+    /* Excluded from this release type: openReadFolderDialog */
     /**
      * 保存文件
      *
@@ -14789,7 +14863,7 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @remarks
-     * 注��� 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
      *
      * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
      * @param folderPath - 目录路径
@@ -15202,7 +15276,7 @@ declare class SYS_Message {
      * 展示跟随鼠标的提示
      *
      * @beta
-     * @remarks 同一时间只能展示一条提示，如果展示新的提示，则之前的提示将被自动移除
+     * @remarks 同一时间只能展示一条提示，如果展示新的���示，则之前的提示将被自动移除
      * @param tip - 提示内容
      * @param msTimeout - 展示时间，以毫秒（ms）为单位，如若不传入则持续展示，直到调用 {@link SYS_Message.removeFollowMouseTip | removeFollowMouseTip} 或被其它提示覆盖
      */
@@ -15513,6 +15587,18 @@ declare class SYS_PanelControl {
     isBottomPanelLocked(): Promise<boolean>;
 }
 
+/**
+ * 系统 / 右键菜单类
+ *
+ * @public
+ */
+declare class SYS_RightClickMenu {
+    /** 扩展 UUID */
+    private extensionUuid?;
+    /* Excluded from this release type: __constructor */
+    /* Excluded from this release type: changeMenu */
+}
+
 /**
  * 系统 / 设置类
  *
@@ -15522,6 +15608,7 @@ declare class SYS_Setting {
     /**
      * 全局恢复默认设置
      *
+     * @beta
      * @remarks 将所有 EDA 设置恢复到默认状态，本操作将会丢失所有设置项，在调用时请特别注意
      * @returns 操作是否成功
      */
@@ -15727,7 +15814,20 @@ declare class SYS_ToastMessage {
  * @public
  */
 declare class SYS_Tool {
-    /* Excluded from this release type: netlistComparison */
+    /**
+     * 网表对比
+     *
+     * @beta
+     * @param netlist1 - 网表 1，可以为当前工程内的 PCB 和原理图的 UUID、网表的文件数据
+     * @param netlist2 - 网表 2，可以为当前工程内的 PCB 和原理图的 UUID、网表的文件数据
+     * @returns 网表对比结果
+     */
+    netlistComparison(netlist1: string | File, netlist2: string | File): Promise<Array<{
+        type: 'Net' | 'Component';
+        object: string;
+        netlist1Name: Array<string>;
+        netlist2Name: Array<string>;
+    }>>;
 }
 
 /**
@@ -15860,7 +15960,7 @@ declare class SYS_Window {
     /**
      * 打开资源窗口
      *
-     * @beta
+     * @public
      * @param url - 欲加载资源的 URL 或路径
      * @param target - 上下文目标
      */
@@ -15868,7 +15968,7 @@ declare class SYS_Window {
     /**
      * 新增事件监听
      *
-     * @beta
+     * @public
      * @param type - 事件类型，当前支持 `blur` `focus`
      * @param listener - 事件监听回调
      * @param options - 可选参数
@@ -15883,11 +15983,21 @@ declare class SYS_Window {
     /**
      * 移除事件监听
      *
-     * @beta
+     * @public
      * @param removableObject - 窗口事件监听可移除对象
      */
     removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;
-    /* Excluded from this release type: openUI */
+    /**
+     * 打开 UI 窗口
+     *
+     * @public
+     * @remarks 非公开接口使用提醒：本接口按原样提供，不提供参数的额外文档，参数可能在任何版本出现破坏性更改并不另行通知
+     * @param uiName - UI 名称
+     * @param args - 可选参数对象
+     */
+    openUI(uiName: string, args?: {
+        [key: string]: any;
+    }): Promise<void>;
     /**
      * 获取当前主题
      *
@@ -15896,6 +16006,21 @@ declare class SYS_Window {
      * @returns 当前主题
      */
     getCurrentTheme(): Promise<ESYS_Theme>;
+    /**
+     * 获取 URL 参数
+     *
+     * @public
+     * @param key - 参数名
+     * @returns 参数值
+     */
+    getUrlParam(key: string): string | null;
+    /**
+     * 获取 URL 锚点
+     *
+     * @public
+     * @returns URL 锚点值
+     */
+    getUrlAnchor(): string;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.171",
+	"version": "0.1.173",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [