@jlceda/pro-api-types 0.1.171 → 0.1.172

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;
@@ -2722,6 +2723,12 @@ declare interface ILIB_ExtendLibraryDeviceFunctions extends ILIB_ExtendLibraryFu
         manufacturer?: string;
         description?: string;
     }>>;
+    /**
+     * 获取支持的符号类型
+     *
+     * @returns 符号类型数组
+     */
+    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -2775,12 +2782,6 @@ declare interface ILIB_ExtendLibraryFunctions {
      * @returns 库元素列表
      */
     getList: (props: ILIB_ExtendLibrarySearchProperty<any>) => Promise<ILIB_ExtendLibrarySearchResult<any>>;
-    /**
-     * 获取支持的符号类型
-     *
-     * @returns 符号类型数组
-     */
-    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -2877,6 +2878,12 @@ declare interface ILIB_ExtendLibrarySymbolFunctions extends ILIB_ExtendLibraryFu
         modifier?: ILIB_ExtendLibraryUserIndex;
         owner?: ILIB_ExtendLibraryUserIndex;
     }>>;
+    /**
+     * 获取支持的符号类型
+     *
+     * @returns 符号类型数组
+     */
+    getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
 }
 
 /**
@@ -3473,7 +3480,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      * 设置属性状态：是否锁定
      *
      * @beta
-     * @param primitiveLock - 是否锁定
+     * @param primitiveLock - ��否锁定
      * @returns 圆弧线图元对象
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveArc;
@@ -4131,7 +4138,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      * 设置属性状态：位号
      *
      * @beta
-     * @param designator - 位号
+     * @param designator - 位��
      * @returns 器件图元对象
      */
     setState_Designator(designator: string | undefined): IPCB_PrimitiveComponent;
@@ -5396,7 +5403,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Layer(): TPCB_LayersOfPad;
     /**
-     * 获取属性���态：焊盘编号
+     * 获取属性状态：焊盘编号
      *
      * @public
      * @returns 焊盘编号
@@ -7920,14 +7927,14 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      * 设置属性状态：其它参数
      *
      * @beta
-     * @param otherProperty - 其它参数
+     * @param otherProperty - 其它参���
      * @returns 器件图元对象
      */
     setState_OtherProperty(otherProperty: {
         [key: string]: string | number | boolean;
     }): ISCH_PrimitiveComponent;
     /**
-     * 将图元转换为异��图元
+     * 将图元转换为异步图元
      *
      * @public
      * @returns 圆弧线图元对象
@@ -8521,7 +8528,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
      * 设置属性状态：引脚编号
      *
      * @beta
-     * @param pinNumber - 引脚编号
+     * @param pinNumber - 引脚编���
      * @returns 引脚图元对象
      */
     setState_PinNumber(pinNumber: string): ISCH_PrimitivePin;
@@ -9201,7 +9208,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      * 设置属性状态：字体大小
      *
      * @beta
-     * @param fontSize - 字体大小
+     * @param fontSize - 字体��小
      * @returns 文本图元对象
      */
     setState_FontSize(fontSize: number | null): ISCH_PrimitiveText;
@@ -9209,7 +9216,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      * 设置属性状态：是否加粗
      *
      * @beta
-     * @param bold - 是���加粗
+     * @param bold - 是否加粗
      * @returns 文本图元对象
      */
     setState_Bold(bold: boolean): ISCH_PrimitiveText;
@@ -9443,67 +9450,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 +9522,7 @@ declare interface ISYS_HeaderMenuTopMenus {
     /** 注册方法名称（需要在扩展入口文件导出该方法） */
     registerFn?: string;
     /** 子菜单项 */
-    menuItems?: Array<ISYS_HeaderMenuSub1Menus | null>;
+    menuItems?: Array<ISYS_HeaderMenuSub1MenuItem | null>;
 }
 
 /**
@@ -9570,6 +9581,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>;
+}
+
 /**
  * 窗口事件监听可移除对象
  *
@@ -9735,7 +9764,7 @@ declare class LIB_Cbb {
      * 在编辑器打开复用模块工程
      *
      * @beta
-     * @remarks 本操作将会在 EDA 前端打开模块工程，如若原先已打开其它工程且有未保存的变更，执行本操作将直接丢失所有未保存的数据
+     * @remarks 本操作将会在 EDA 前端打开模块工程，如若原先已打开其它工程且��未保存的变更，执行本操作将直接丢失所有未保存的数据
      * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      */
@@ -10112,6 +10141,9 @@ declare class LIB_Footprint {
  * @remarks 此处所有接口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
  */
 declare class LIB_LibrariesList {
+    /** 扩展 UUID */
+    private extensionUuid?;
+    /* Excluded from this release type: __constructor */
     /**
      * 获取系统库的 UUID
      *
@@ -12925,7 +12957,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 文件数据
@@ -13679,7 +13711,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * 创建网络端口
      *
      * @beta
-     * @param direction - 端口方���
+     * @param direction - 端口方向
      * @param net - 网络名称
      * @param x - 坐标 X
      * @param y - 坐标 Y
@@ -14741,9 +14773,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 +14832,7 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @remarks
-     * 注��� 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
      *
      * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
      * @param folderPath - 目录路径
@@ -15513,6 +15556,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 +15577,7 @@ declare class SYS_Setting {
     /**
      * 全局恢复默认设置
      *
+     * @beta
      * @remarks 将所有 EDA 设置恢复到默认状态，本操作将会丢失所有设置项，在调用时请特别注意
      * @returns 操作是否成功
      */
@@ -15727,7 +15783,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 +15929,7 @@ declare class SYS_Window {
     /**
      * 打开资源窗口
      *
-     * @beta
+     * @public
      * @param url - 欲加载资源的 URL 或路径
      * @param target - 上下文目标
      */
@@ -15868,7 +15937,7 @@ declare class SYS_Window {
     /**
      * 新增事件监听
      *
-     * @beta
+     * @public
      * @param type - 事件类型，当前支持 `blur` `focus`
      * @param listener - 事件监听回调
      * @param options - 可选参数
@@ -15883,11 +15952,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>;
     /**
      * 获取当前主题
      *

package/package.json

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