@jlceda/pro-api-types 0.1.89 → 0.1.91

package/index.d.ts

@@ -416,7 +416,7 @@ declare class DMT_Project {
      * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
-     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则��参数将被忽略
+     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
      * @returns 工程 UUID，如若为 `undefined` 则创建失败
      */
     createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -595,7 +595,7 @@ declare class DMT_Schematic {
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
-     * 获取当前原��图图页的详细属性
+     * 获取当前原理图图页的详细属性
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -773,6 +773,7 @@ declare class EDA {
     sch_SelectControl: SCH_SelectControl;
     sch_Utils: SCH_Utils;
     sys_ClientUrl: SYS_ClientUrl;
+    sys_Dialog: SYS_Dialog;
     sys_Environment: SYS_Environment;
     sys_FileManager: SYS_FileManager;
     sys_FileSystem: SYS_FileSystem;
@@ -1187,7 +1188,7 @@ declare enum EPCB_LayerId {
     SHELL_3D_TOP = 54,
     /** 3D 外壳底层 */
     SHELL_3D_BOTTOM = 55,
-    /** 钻���图层 */
+    /** 钻孔图层 */
     DRILL_DRAWING = 56
 }
 
@@ -1227,6 +1228,20 @@ declare enum EPCB_PcbPlateType {
     FPC = 2
 }
 
+/**
+ * PDF 输出方式
+ *
+ * @public
+ */
+declare enum EPCB_PdfOutputMethod {
+    /** 单个多页 PDF */
+    MULTI_PAGE_PDF = "A Multi Page PDF",
+    /** 多个单页 PDF（将会输出包含所有分解图层 PDF 文件的压缩包） */
+    MULTIPLE_SINGLE_PAGE_PDF = "Multiple Single Page PDF",
+    /** 单个单页 PDF（将会输出包含每层一个 PDF 文件的压缩包） */
+    SINGLE_PAGE_PDF = "A Single Page PDF"
+}
+
 /**
  * 圆弧交互模式
  *
@@ -2105,7 +2120,7 @@ declare interface ILIB_DeviceSearchItem {
     footprintName?: string;
     /** 关联封装 UUID */
     footprintUuid?: string;
-    /** 关联 3D 模型名��� */
+    /** 关联 3D 模型名称 */
     model3DName?: string;
     /** 关联 3D 模型 UUID */
     model3DUuid?: string;
@@ -2394,6 +2409,18 @@ declare interface IPCB_PadPairGroupItem {
     padPairs: Array<[string, string]>;
 }
 
+/**
+ * 焊盘对最短导线长度属性
+ *
+ * @public
+ */
+declare interface IPCB_PadPairMinWireLengthItem {
+    /** 焊盘对数组 */
+    padPairs: Array<[string, string]>;
+    /** 最短导线长度 */
+    minWireLength: number;
+}
+
 /**
  * 单多边形
  *
@@ -3241,7 +3268,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      */
     getState_Rotation(): number;
     /**
-     * 获取属��状态：是否水平镜像
+     * 获取属性状态：是否水平镜像
      *
      * @public
      * @returns 是否水平镜像
@@ -3549,7 +3576,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      */
     reset(): Promise<IPCB_PrimitiveLine>;
     /**
-     * 将对图元的更改应用到画布
+     * 将对���元的更改应用到画布
      *
      * @beta
      * @returns 导线图元对象
@@ -5355,7 +5382,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      *
      * @beta
      * @param otherProperty - 其它参数
-     * @returns 器件图元对象
+     * @returns ���件图元对象
      */
     setState_OtherProperty(otherProperty: {
         [key: string]: string;
@@ -7070,6 +7097,7 @@ declare class PCB_Drc {
      * @returns 所有焊盘对组的详细属性
      */
     getAllPadPairGroups(): Promise<Array<IPCB_PadPairGroupItem>>;
+    /* Excluded from this release type: getPadPairGroupMinWireLength */
 }
 
 /**
@@ -7185,7 +7213,7 @@ declare class PCB_Layer {
      *
      * @beta
      * @remarks
-     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板，将会新增 FPC 补���层图层。
+     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板，将会新增 FPC 补强层图层。
      *
      * 请注意：
      *
@@ -7350,6 +7378,8 @@ declare class PCB_ManufactureData {
         layerId: number;
         mirror: boolean;
     }>, objects?: Array<string>): Promise<File | undefined>;
+    /* Excluded from this release type: getPdfFile */
+    /* Excluded from this release type: getIpcD356AFile */
     /**
      * 获取 ODB++ 文件
      *
@@ -7421,6 +7451,8 @@ declare class PCB_ManufactureData {
      * @returns 自动布局 JSON 文件数据
      */
     getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
+    /* Excluded from this release type: getAltiumDesignerFile */
+    /* Excluded from this release type: getPadsFile */
     /**
      * 获取 PCB 信息文件
      *
@@ -7434,6 +7466,15 @@ declare class PCB_ManufactureData {
     /* Excluded from this release type: placeSmtComponentsOrder */
     /* Excluded from this release type: placePcbOrder */
     /* Excluded from this release type: place3DShellOrder */
+    /**
+     * 获取 IPC-D-356A 文件
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @param fileName - 文件名
+     * @returns IPC-D-356A 文件
+     */
+    getIPCFile(fileName?: string): Promise<File | undefined>;
 }
 
 /**
@@ -7679,7 +7720,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      *
      * @beta
      * @param primitiveIds - 器件的图元 ID 或器件图元对象
-     * @returns 删��操作是否成功
+     * @returns 删除操作是否成功
      */
     delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;
     /**
@@ -8295,7 +8336,7 @@ declare class PCB_PrimitiveVia implements IPCB_PrimitiveAPI {
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 过孔的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 过孔图元对象，空数组表示获取失��
+     * @returns 过孔图元对象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveVia>>;
     /**
@@ -9482,6 +9523,40 @@ declare class SYS_ClientUrl {
     }, succeedCallFn?: (data: Response) => void | Promise<void>): Promise<Response>;
 }
 
+/**
+ * 系统 / 对话框类
+ *
+ * @public
+ * @remarks 生成对话框窗口
+ */
+declare class SYS_Dialog {
+    /**
+     * 弹出消息窗口
+     *
+     * @public
+     * @remarks 显示一个文字消息窗口
+     * @param content - 消息文本，支持使用 `\n` 换行
+     * @param title - 弹出窗口标题
+     * @param buttonTitle - 按钮标题，为空则不显示按钮
+     */
+    showInformationMessage(content: string, title?: string, buttonTitle?: string): void;
+    /**
+     * 弹出确认窗口
+     *
+     * @public
+     * @remarks 显示一个拥有确认和取消按钮的窗口
+     * @param content - 消息文本，支持使用 `\n` 换行
+     * @param title - 弹出窗口标题
+     * @param mainButtonTitle - 主要按钮标题
+     * @param buttonTitle - 主要按钮标题
+     * @param callbackFn - 回调函数，如需调用扩展内的函数，请在函数名前加上扩展的唯一 ID，以西文句号 `.` 分隔
+     */
+    showConfirmationMessage(content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void): void;
+    /* Excluded from this release type: showInputDialog */
+    /* Excluded from this release type: showSelectDialog */
+    /* Excluded from this release type: showSelectDialog */
+}
+
 /**
  * 系统 / 运行环境类
  *
@@ -9900,6 +9975,7 @@ declare class SYS_Log {
  * 系统 / 消息框类
  *
  * @public
+ * @deprecated 已更名为 {@link SYS_Dialog}
  * @remarks 生成消息提示框
  */
 declare class SYS_MessageBox {
@@ -9907,6 +9983,7 @@ declare class SYS_MessageBox {
      * 显示消息框
      *
      * @public
+     * @deprecated 请使用 {@link SYS_Dialog.showInformationMessage} 替代
      * @remarks 显示一个文字消息提示框
      * @param content - 消息文本，支持使用 `\n` 换行
      * @param title - 消息框标题
@@ -9917,12 +9994,13 @@ declare class SYS_MessageBox {
      * 显示确认框
      *
      * @public
+     * @deprecated 请使用 {@link SYS_Dialog.showConfirmationMessage} 替代
      * @remarks 显示一个拥有确认和取消按钮的确认框
      * @param content - 消息文本，支持使用 `\n` 换行
      * @param title - 确认框标题
      * @param mainButtonTitle - 主要按钮标题
      * @param buttonTitle - 主要按钮标题
-     * @param callbackFn - 回调函数，如需调用插件内的函数，请在函数名前加上插件的唯一 ID，以西文句号 `.` 分隔
+     * @param callbackFn - 回调函数，如需调用扩展内的函数，请在函数名前加上扩展的唯一 ID，以西文句号 `.` 分隔
      */
     showConfirmationMessage(content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void): void;
 }
@@ -10298,7 +10376,7 @@ declare class SYS_WebSocket {
      * 可以用来执行前检测 WebSocket 连接是否正常，但需要注意 **不要尝试相同 ID 不同参数的连接**，这会造成混乱：
      * 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接，那么其余参数的变更将不会被应用
      *
-     * 注意：本接口需要使用者启用扩展的外部���互权限，如若未启用将始终 `throw Error`
+     * 注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
      * @param id - 自定义 WebSocket ID
      * @param serviceUri - WebSocket 服务地址
      * @param receiveMessageCallFn - 接收到消息时的回调函数
@@ -10377,7 +10455,7 @@ declare class SYS_Window {
 declare type TPCB_LayersInTheSelectable = TPCB_LayersOfInner | TPCB_LayersOfCustom | EPCB_LayerId.TOP | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.TOP_STIFFENER | EPCB_LayerId.BOTTOM | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.BOTTOM_STIFFENER | EPCB_LayerId.BOARD_OUTLINE | EPCB_LayerId.MULTI | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.DRILL_DRAWING | EPCB_LayerId.RATLINE | EPCB_LayerId.COMPONENT_SHAPE | EPCB_LayerId.COMPONENT_MARKING | EPCB_LayerId.PIN_SOLDERING | EPCB_LayerId.PIN_FLOATING | EPCB_LayerId.SHELL_3D_OUTLINE | EPCB_LayerId.SHELL_3D_TOP | EPCB_LayerId.SHELL_3D_BOTTOM;
 
 /**
- * ��件所属层
+ * 器件所属层
  *
  * @public
  */

package/package.json

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