@jlceda/pro-api-types 0.1.107 → 0.1.108

package/index.d.ts

@@ -196,7 +196,7 @@ declare class DMT_Folder {
      * @param teamUuid - 团队 UUID
      * @param parentFolderUuid - 父文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 文件夹描述
-     * @returns 文��夹 UUID，如若为 `undefined` 则创建失败
+     * @returns 文���夹 UUID，如若为 `undefined` 则创建失败
      */
     createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
     /**
@@ -311,7 +311,7 @@ declare class DMT_Panel {
      *
      * @public
      * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
-     * @returns 面板��详细属性，如若为 `undefined` 则获取失败
+     * @returns 面板���详细属性，如若为 `undefined` 则获取失败
      */
     getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
     /**
@@ -417,7 +417,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>;
@@ -1342,12 +1342,17 @@ declare enum EPCB_PrimitivePadShapeType {
     POLYLINE_COMPLEX_POLYGON = "POLYGON"
 }
 
+/**
+ * 覆铜填充方法
+ *
+ * @public
+ */
 declare enum EPCB_PrimitivePourFillMethod {
-    /** 填充样式 - 45度网格 */
+    /** 45 度网格 */
     GRID45 = "45grid",
-    /** 填充样式 - 90度网格 */
+    /** 90 度网格 */
     GRID = "90grid",
-    /** 填充样式 - 实心填充 */
+    /** 实心填充 */
     SOLID = "solid"
 }
 
@@ -1515,7 +1520,20 @@ declare enum ESCH_PrimitiveType {
     /** 文本 */
     TEXT = "Text",
     /** 导线 */
-    WIRE = "Wire"
+    WIRE = "Wire",
+    NETFLAG = "Netflag",
+    NETPORT = "Netport",
+    NO_CONNECT = "Noconnect",
+    PART = "Part",
+    SHORT_SYMBOL = "Short_symbol",
+    BLOCK_SYMBOL = "Block_symbol",
+    TABLE = "Table",
+    CELL = "Cell",
+    BUSENTRY = "BusEntry",
+    NONELECTRICAL_SYMBOL = "NonElectrical_symbol",
+    OBJ = "Obj",
+    JUNCTION = "Junction",
+    SHEET = "Sheet"
 }
 
 /**
@@ -1773,7 +1791,7 @@ declare interface IDMT_EditorDocumentItem {
     documentType: EDMT_EditorDocumentType;
     /** 文档 UUID */
     uuid: string;
-    /** 文档所属工��� UUID */
+    /** 文档所属工程 UUID */
     parentProjectUuid: string;
 }
 
@@ -2771,8 +2789,21 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      * @returns 圆弧线图元对象
      */
     done(): Promise<IPCB_PrimitiveArc>;
-    /* Excluded from this release type: getAdjacentPrimitives */
-    /* Excluded from this release type: getEntireTrack */
+    /**
+     * 获取相邻的图元对象
+     *
+     * @beta
+     * @remarks 将会获取与圆弧线直接相连的直线、过孔、圆弧线图元对象
+     * @returns 相邻的直线、过孔、圆弧线图元对象
+     */
+    getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc>>;
+    /**
+     * 获取整段导线
+     *
+     * @beta
+     * @returns 整段导线内的所有直线和圆弧线
+     */
+    getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
 }
 
 /**
@@ -3129,7 +3160,13 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      * @returns 器件图元对象
      */
     done(): Promise<IPCB_PrimitiveComponent>;
-    /* Excluded from this release type: getAllPins */
+    /**
+     * 获取器件关联的所有焊盘
+     *
+     * @beta
+     * @returns 器件焊盘图元数组
+     */
+    getAllPins(): Promise<IPCB_PrimitiveComponentPad[]>;
     /* Excluded from this release type: setState_Component */
 }
 
@@ -3150,7 +3187,13 @@ declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
     /* Excluded from this release type: setState_Layer */
     /* Excluded from this release type: setState_PadNumber */
     /* Excluded from this release type: reset */
-    /* Excluded from this release type: done */
+    /**
+     * 将对图元的更改应用到画布
+     *
+     * @beta
+     * @returns 器件焊盘图元对象
+     */
+    done(): Promise<IPCB_PrimitiveComponentPad>;
 }
 
 /**
@@ -3497,11 +3540,41 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      * @returns 是否为异步图元
      */
     isAsync(): boolean;
-    /* Excluded from this release type: reset */
-    /* Excluded from this release type: done */
-    /* Excluded from this release type: convertToPolyline */
-    /* Excluded from this release type: convertToPour */
-    /* Excluded from this release type: convertToRegion */
+    /**
+     * 将异步图元重置为当前画布状态
+     *
+     * @beta
+     * @returns 填充图元对象
+     */
+    reset(): Promise<IPCB_PrimitiveFill>;
+    /**
+     * 将对图元的更改应用到画布
+     *
+     * @beta
+     * @returns 填充图元对象
+     */
+    done(): Promise<IPCB_PrimitiveFill>;
+    /**
+     * 转换到：折线图元(默认是线条)
+     *
+     * @beta
+     * @returns 折线图元对象
+     */
+    convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
+    /**
+     * 转换到：覆铜边框图元
+     *
+     * @beta
+     * @returns 覆铜边框图元对象
+     */
+    convertToPour(): Promise<IPCB_PrimitivePour>;
+    /**
+     * 转换到：区域图元(默认是禁止区域)
+     *
+     * @beta
+     * @returns 区域图元对象
+     */
+    convertToRegion(): Promise<IPCB_PrimitiveRegion>;
 }
 
 /**
@@ -3914,8 +3987,21 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      * @returns 直线图元对象
      */
     done(): Promise<IPCB_PrimitiveLine>;
-    /* Excluded from this release type: getAdjacentPrimitives */
-    /* Excluded from this release type: getEntireTrack */
+    /**
+     * 获取相邻的图元对象
+     *
+     * @beta
+     * @remarks 将会获取与直线两端直接相连的直线、过孔、圆弧线图元对象
+     * @returns 相邻的直线、过孔、圆弧线图元对象
+     */
+    getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc>>;
+    /**
+     * 获取整段导线
+     *
+     * @beta
+     * @returns 整段导线内的所有直线和圆弧线
+     */
+    getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
 }
 
 /**
@@ -4137,8 +4223,20 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @returns 是否为异步图元
      */
     isAsync(): boolean;
-    /* Excluded from this release type: reset */
-    /* Excluded from this release type: done */
+    /**
+     * 将异步图元重置为当前画布状态
+     *
+     * @beta
+     * @returns 二进制内嵌对象图元对象
+     */
+    reset(): Promise<IPCB_PrimitiveObject>;
+    /**
+     * 将对图元的更改应用到画布
+     *
+     * @beta
+     * @returns 二进制内嵌对象图元对象
+     */
+    done(): Promise<IPCB_PrimitiveObject>;
 }
 
 /**
@@ -4294,7 +4392,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Metallization(): boolean;
     /**
-     * 获取属性状态：焊盘功能
+     * ���取属性状态：焊盘功能
      *
      * @public
      * @returns 焊盘功能
@@ -4648,7 +4746,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     setState_Polygon(polygon: IPCB_Polygon): IPCB_PrimitivePolyline;
     /**
-     * ���置属性状态：线宽
+     * 设置属性状态：线宽
      *
      * @beta
      * @param lineWidth - 线宽
@@ -4698,9 +4796,27 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      * @returns 折线图元对象
      */
     done(): Promise<IPCB_PrimitivePolyline>;
-    /* Excluded from this release type: convertToFill */
-    /* Excluded from this release type: convertToPour */
-    /* Excluded from this release type: convertToRegion */
+    /**
+     * 转换到：填充图元
+     *
+     * @beta
+     * @returns 填充图元对象
+     */
+    convertToFill(): Promise<IPCB_PrimitiveFill>;
+    /**
+     * 转换到：覆铜边框图元
+     *
+     * @beta
+     * @returns 覆铜边框图元对象
+     */
+    convertToPour(): Promise<IPCB_PrimitivePour>;
+    /**
+     * 转换到：区域图元
+     *
+     * @beta
+     * @returns 区域图元对象
+     */
+    convertToRegion(): Promise<IPCB_PrimitiveRegion>;
 }
 
 /**
@@ -4817,7 +4933,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      *
      * @beta
      * @param net - 网络名称
-     * @returns 覆铜边框图��对象
+     * @returns 覆铜边框图元对象
      */
     setState_Net(net: string): IPCB_PrimitivePour;
     /**
@@ -4905,11 +5021,41 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * @returns 是否为异步图元
      */
     isAsync(): boolean;
-    /* Excluded from this release type: reset */
-    /* Excluded from this release type: done */
-    /* Excluded from this release type: convertToFill */
-    /* Excluded from this release type: convertToPolyline */
-    /* Excluded from this release type: convertToRegion */
+    /**
+     * 将异步图元重置为当前画布状态
+     *
+     * @beta
+     * @returns 覆铜边框图元对象
+     */
+    reset(): Promise<IPCB_PrimitivePour>;
+    /**
+     * 将对图元的更改应用到画布
+     *
+     * @beta
+     * @returns 覆铜边框图元对象
+     */
+    done(): Promise<IPCB_PrimitivePour>;
+    /**
+     * 转换到：填充图元(默认是填充区域)
+     *
+     * @beta
+     * @returns 填充图元对象
+     */
+    convertToFill(): Promise<IPCB_PrimitiveFill>;
+    /**
+     * 转换到：折线图元(默认是线条)
+     *
+     * @beta
+     * @returns 折线图元对象
+     */
+    convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
+    /**
+     * 转换到：区域图元(默认是禁止区域)
+     *
+     * @beta
+     * @returns 区域图元对象
+     */
+    convertToRegion(): Promise<IPCB_PrimitiveRegion>;
 }
 
 /**
@@ -5067,11 +5213,41 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
      * @returns 是否为异步图元
      */
     isAsync(): boolean;
-    /* Excluded from this release type: reset */
-    /* Excluded from this release type: done */
-    /* Excluded from this release type: convertToFill */
-    /* Excluded from this release type: convertToPolyline */
-    /* Excluded from this release type: convertToPour */
+    /**
+     * 将异步图元重置为当前画布状态
+     *
+     * @beta
+     * @returns 区域图元对象
+     */
+    reset(): Promise<IPCB_PrimitiveRegion>;
+    /**
+     * 将对图元的更改应用到画布
+     *
+     * @beta
+     * @returns 区域图元对象
+     */
+    done(): Promise<IPCB_PrimitiveRegion>;
+    /**
+     * 转换到：填充图元
+     *
+     * @beta
+     * @returns 填充图元对象
+     */
+    convertToFill(): Promise<IPCB_PrimitiveFill>;
+    /**
+     * 转换到：折线图元
+     *
+     * @beta
+     * @returns 折线图元对象
+     */
+    convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
+    /**
+     * 转换到：覆铜边框图元
+     *
+     * @beta
+     * @returns 覆铜边框图元对象
+     */
+    convertToPour(): Promise<IPCB_PrimitivePour>;
 }
 
 /**
@@ -5316,7 +5492,14 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      * @returns 过孔图元对象
      */
     done(): Promise<IPCB_PrimitiveVia>;
-    /* Excluded from this release type: getAdjacentPrimitives */
+    /**
+     * 获取相邻的图元对象
+     *
+     * @beta
+     * @remarks 将会获取与过孔直接相连的导线、圆弧线图元对象
+     * @returns 相邻的导线、圆弧线图元对象
+     */
+    getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
 }
 
 /**
@@ -6536,7 +6719,7 @@ declare class LIB_3DModel {
      * @remarks 如希望清除某些属性，则将其的值设置为 `null`
      * @param modelUuid - 3D 模型 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param modelName - 3D 模���名称
+     * @param modelName - 3D 模型名称
      * @param classification - 分类
      * @param description - 描述
      * @returns 操作是否成功
@@ -6919,6 +7102,7 @@ declare class LIB_Footprint {
      * @returns 封装 UUID
      */
     create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
+    /* Excluded from this release type: createByDocumentSource */
     /**
      * 删除封装
      *
@@ -7099,7 +7283,7 @@ declare class LIB_PanelLibrary {
      *
      * @beta
      * @param key - 搜索关键字
-     * @param libraryUuid - 库 UUID，默认为系统库，可���使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param classification - 分类，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
@@ -7136,6 +7320,7 @@ declare class LIB_Symbol {
      * @returns 符号 UUID
      */
     create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
+    /* Excluded from this release type: createByDocumentSource */
     /**
      * 删除符号
      *
@@ -7228,6 +7413,15 @@ declare class PCB_Document {
      * @returns 导入操作是否成功
      */
     importOldAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
+    /**
+     * 导入自动布线文件（JSON）
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
+     * @param autoRouteFile - 欲导入的 JSON 文件
+     * @returns 导入操作是否成功
+     */
+    importAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
     /**
      * 导入旧版自动布局文件（JSON）
      *
@@ -7280,7 +7474,7 @@ declare class PCB_Document {
      * 输入画布坐标返回该坐标对应的数据坐标
      *
      * @public
-     * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点；嘉立创 EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
+     * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点；嘉立�� EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
      * @param canvasOriginX - 画布原点 X
      * @param canvasOriginY - 画布原点 Y
      * @returns 数据原点坐标
@@ -7849,7 +8043,7 @@ declare class PCB_Layer {
      *
      * @beta
      * @remarks
-     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板，将会新增 FPC 补强层图层。
+     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板���将会新增 FPC 补强层图层。
      *
      * 请注意：
      *
@@ -7864,7 +8058,7 @@ declare class PCB_Layer {
      * 新增自定义层
      *
      * @beta
-     * @returns 新增的自定义层的图层 ID，如若为 `undefined` 则为新增失败，可能��自定义层数量已达到上限
+     * @returns 新增的自定义层的图层 ID，如若为 `undefined` 则为新增失败，可能是自定义层数量已达到上限
      */
     addCustomLayer(): Promise<TPCB_LayersOfCustom | undefined>;
     /**
@@ -7969,7 +8163,14 @@ declare class PCB_ManufactureData {
      * @returns 坐标文件数据
      */
     getPickAndPlaceFile(fileName?: string, fileType?: 'xlsx' | 'csv', unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.MIL): Promise<File | undefined>;
-    /* Excluded from this release type: getFlyingProbeTestFile */
+    /**
+     * 获取飞针测试文件
+     *
+     * @beta
+     * @param fileName - 文件名
+     * @returns 飞针测试文件数据
+     */
+    getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;
     /**
      * 获取 BOM 文件
      *
@@ -8014,8 +8215,49 @@ 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 */
+    /**
+     * 获取 PDF 文件
+     *
+     * @beta
+     * @remarks
+     * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     *
+     * `outputMethod`、`contentConfig`、`watermark` 参数暂不可用，等待后期规划
+     * @param fileName - 文件名
+     * @param outputMethod - 输出方式
+     * @param contentConfig - 内容配置
+     * @param watermark - 水印
+     * @returns PDF 文件数据（或压缩包）
+     */
+    getPdfFile(fileName?: string, outputMethod?: EPCB_PdfOutputMethod, contentConfig?: {
+        displayAttributesAsMenu: boolean;
+        showOutlineOnly: boolean;
+    }, watermark?: {
+        show?: boolean;
+        content?: string;
+        styleConfig?: {
+            color: string;
+            transparency: 'Opaque' | '75%' | '50%' | '25%';
+            font: string;
+            fontSize: string;
+            style: {
+                blood: boolean;
+                italic: boolean;
+                underline: boolean;
+            };
+            slope: 0 | 45 | 90;
+            denseness: 'Single' | 'Sparse' | 'Std' | 'Dense';
+        };
+    }): Promise<File | undefined>;
+    /**
+     * 获取 IPC-D-356A 文件
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @param fileName - 文件名
+     * @returns IPC-D-356A 文件数据
+     */
+    getIpcD356AFile(fileName?: string): Promise<File | undefined>;
     /**
      * 获取 ODB++ 文件
      *
@@ -8087,8 +8329,24 @@ declare class PCB_ManufactureData {
      * @returns 自动布局 JSON 文件数据
      */
     getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
-    /* Excluded from this release type: getAltiumDesignerFile */
-    /* Excluded from this release type: getPadsFile */
+    /**
+     * 获取 Altium Designer 文件
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @param fileName - 文件名
+     * @returns Altium Designer 文件数据
+     */
+    getAltiumDesignerFile(fileName?: string): Promise<File | undefined>;
+    /**
+     * 获取 PADS 文件
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @param fileName - 文件名
+     * @returns PADS 文件数据
+     */
+    getPadsFile(fileName?: string): Promise<File | undefined>;
     /**
      * 获取 PCB 信息文件
      *
@@ -8098,10 +8356,82 @@ declare class PCB_ManufactureData {
      * @returns PCB 信息文件
      */
     getPcbInfoFile(fileName?: string): Promise<File | undefined>;
-    /* Excluded from this release type: placeComponentsOrder */
-    /* Excluded from this release type: placeSmtComponentsOrder */
-    /* Excluded from this release type: placePcbOrder */
-    /* Excluded from this release type: place3DShellOrder */
+    /**
+     * 元件下单
+     *
+     * @beta
+     * @param interactive - 是否启用交互式检查
+     *
+     * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
+     * 即 `ignoreWarning` 参数将被忽略；
+     *
+     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
+     * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
+     * @param ignoreWarning - 在非交互式检查时忽略警告
+     *
+     * 如果设置为 `true`，将会忽略所有检查警告项并尽可能生成下单资料；
+     *
+     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结果
+     * @returns 是否通过下单检查
+     */
+    placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
+    /**
+     * SMT 元件下单
+     *
+     * @beta
+     * @param interactive - 是否启用交互式检查
+     *
+     * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
+     * 即 `ignoreWarning` 参数将被忽略；
+     *
+     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
+     * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
+     * @param ignoreWarning - 在非交互式检查时忽略警告
+     *
+     * 如果设置为 `true`，将会忽略所有检查警告项并尽可能生成下单资料；
+     *
+     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结果
+     * @returns 是否通过下单检查
+     */
+    placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
+    /**
+     * PCB 下单
+     *
+     * @beta
+     * @param interactive - 是否启用交互式检查
+     *
+     * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
+     * 即 `ignoreWarning` 参数将被忽略；
+     *
+     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
+     * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
+     * @param ignoreWarning - 在非交互式检查时忽略警告
+     *
+     * 如果设置为 `true`，将会忽略所有检查警告项并尽可能生成下单资料；
+     *
+     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结果
+     * @returns 是否通过下单检查
+     */
+    placePcbOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
+    /**
+     * 3D 外壳下单
+     *
+     * @beta
+     * @param interactive - 是否启用交互式检查
+     *
+     * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
+     * 即 `ignoreWarning` 参数将被忽略；
+     *
+     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
+     * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
+     * @param ignoreWarning - 在非交互式检查时忽略警告
+     *
+     * 如果设置为 `true`，将会忽略所有检查警告项并尽可能生成下单资料；
+     *
+     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结果
+     * @returns 是否通过下单检查
+     */
+    place3DShellOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
 }
 
 /**
@@ -8202,7 +8532,15 @@ declare class PCB_Net {
      * @returns 操作是否成功
      */
     highlightNet(net: string): Promise<boolean>;
-    /* Excluded from this release type: unhighlightNet */
+    /**
+     * 取消高亮网络
+     *
+     * @beta
+     * @remarks 本接口的返回值为结果导向，如果该网络原先未高亮，也将返回 `true`
+     * @param net - 网络名称
+     * @returns 操作是否成功
+     */
+    unhighlightNet(net: string): Promise<boolean>;
     /* Excluded from this release type: unhighlightAllNets */
     /**
      * 获取网表
@@ -8232,7 +8570,19 @@ declare class PCB_Primitive {
     /* Excluded from this release type: getPrimitiveTypeByPrimitiveId */
     /* Excluded from this release type: getPrimitiveByPrimitiveId */
     /* Excluded from this release type: getPrimitivesByPrimitiveId */
-    /* Excluded from this release type: getPrimitivesBBox */
+    /**
+     * 获取图元的 BBox
+     *
+     * @beta
+     * @param primitiveIds - 图元 ID 数组或图元对象数组
+     * @returns 图元的 BBox，如若图元不存在或没有 BBox，将会返回 `undefined` 的结果
+     */
+    getPrimitivesBBox(primitiveIds: Array<string | IPCB_Primitive>): Promise<{
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+    } | undefined>;
 }
 
 /**
@@ -8429,7 +8779,14 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      * @returns 器件图元对象数组
      */
     getAll(layer?: TPCB_LayersOfComponent, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveComponent>>;
-    /* Excluded from this release type: getAllPinsByPrimitiveId */
+    /**
+     * 获取器件关联的所有焊盘
+     *
+     * @beta
+     * @param primitiveId - 器件图元 ID
+     * @returns 器件焊盘图元数组
+     */
+    getAllPinsByPrimitiveId(primitiveId: string): Promise<Array<IPCB_PrimitiveComponentPad> | undefined>;
     /* Excluded from this release type: placeComponentWithMouse */
 }
 
@@ -8521,13 +8878,80 @@ declare class PCB_PrimitiveDimension implements IPCB_PrimitiveAPI {
  * @public
  */
 declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
-    /* Excluded from this release type: create */
-    /* Excluded from this release type: delete */
-    /* Excluded from this release type: modify */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: getAllPrimitiveId */
-    /* Excluded from this release type: getAll */
+    /**
+     * 创建填充
+     *
+     * @beta
+     * @param layer - 层
+     * @param complexPolygon - 复杂多边形对象
+     * @param net - 网络名称
+     * @param fillMode - 填充模式
+     * @param lineWidth - 线宽
+     * @param primitiveLock - 是否锁定
+     * @returns 填充图元对象
+     */
+    create(layer: TPCB_LayersOfFill, complexPolygon: IPCB_Polygon, net?: string, fillMode?: EPCB_PrimitiveFillMode, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveFill | undefined>;
+    /**
+     * 删除填充
+     *
+     * @beta
+     * @param primitiveIds - 填充的图元 ID 或填充图元对象
+     * @returns 删除操作是否成功
+     */
+    delete(primitiveIds: string | IPCB_PrimitiveFill | Array<string> | Array<IPCB_PrimitiveFill>): Promise<boolean>;
+    /**
+     * 修改填充
+     *
+     * @beta
+     * @param primitiveId - 图元 ID
+     * @param property - 修改参数
+     * @returns 填充图元对象，`undefined` 表示修改失败
+     */
+    modify(primitiveId: string | IPCB_PrimitiveFill, property: {
+        layer?: TPCB_LayersOfFill;
+        complexPolygon?: IPCB_Polygon;
+        net?: string;
+        fillMode?: EPCB_PrimitiveFillMode;
+        lineWidth?: number;
+        primitiveLock?: boolean;
+    }): Promise<IPCB_PrimitiveFill | undefined>;
+    /**
+     * 获取填充
+     *
+     * @beta
+     * @param primitiveIds - 填充的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 填充图元对象，`undefined` 表示获取失败
+     */
+    get(primitiveIds: string): Promise<IPCB_PrimitiveFill | undefined>;
+    /**
+     * 获取填充
+     *
+     * @beta
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @param primitiveIds - 填充的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 填充图元对象，空数组表示获取失败
+     */
+    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
+    /**
+     * 获取所有填充的图元 ID
+     *
+     * @beta
+     * @param layer - 层
+     * @param net - 网络名称
+     * @param primitiveLock - 是否锁定
+     * @returns 填充的图元 ID 数组
+     */
+    getAllPrimitiveId(layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean): Promise<Array<string>>;
+    /**
+     * 获取所有填充
+     *
+     * @beta
+     * @param layer - 层
+     * @param net - 网络名称
+     * @param primitiveLock - 是否锁定
+     * @returns 填充图元对象数组
+     */
+    getAll(layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveFill>>;
 }
 
 /**
@@ -8710,13 +9134,86 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
  * @remarks 彩色丝印图像属于二进制内嵌对象，需要使用二进制内嵌对象的方法创建和修改
  */
 declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
-    /* Excluded from this release type: create */
-    /* Excluded from this release type: delete */
-    /* Excluded from this release type: modify */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: getAllPrimitiveId */
-    /* Excluded from this release type: getAll */
+    /**
+     * 创建二进制内嵌对象
+     *
+     * @beta
+     * @param layer - 层
+     * @param topLeftX - 左上点 X
+     * @param topLeftY - 左上点 Y
+     * @param binaryData - 二进制数据
+     * @param width - 宽
+     * @param height - 高
+     * @param rotation - 旋转角度
+     * @param mirror - 是否水平镜像
+     * @param fileName - 文件名
+     * @param primitiveLock - 是否锁定
+     * @returns - 二进制内嵌对象图元对象
+     */
+    create(layer: TPCB_LayersOfObject, topLeftX: number, topLeftY: number, binaryData: string, width: number, height: number, rotation?: number, mirror?: boolean, fileName?: string, primitiveLock?: boolean): Promise<IPCB_PrimitiveObject | undefined>;
+    /**
+     * 删除二进制内嵌对象
+     *
+     * @beta
+     * @param primitiveIds - 二进制内嵌对象的图元 ID 或二进制内嵌对象图元对象
+     * @returns 删除操作是否成功
+     */
+    delete(primitiveIds: string | IPCB_PrimitiveObject | Array<string> | Array<IPCB_PrimitiveObject>): Promise<boolean>;
+    /**
+     * 修改二进制内嵌对象
+     *
+     * @beta
+     * @param primitiveId - 图元 ID
+     * @param property - 修改参数
+     * @returns 二进制内嵌对象图元对象，`undefined` 表示修改失败
+     */
+    modify(primitiveId: string | IPCB_PrimitiveObject, property: {
+        layer?: TPCB_LayersOfObject;
+        topLeftX?: number;
+        topLeftY?: number;
+        binaryData?: string;
+        width?: number;
+        height?: number;
+        rotation?: number;
+        mirror?: boolean;
+        fileName?: string;
+        primitiveLock?: boolean;
+    }): Promise<IPCB_PrimitiveObject | undefined>;
+    /**
+     * 获取二进制内嵌对象
+     *
+     * @beta
+     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 二进制内嵌对象图元对象，`undefined` 表示获取失败
+     */
+    get(primitiveIds: string): Promise<IPCB_PrimitiveObject | undefined>;
+    /**
+     * 获取二进制内嵌对象
+     *
+     * @beta
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 二进制内嵌对象图元对象，空数组表示获取失败
+     */
+    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveObject>>;
+    /**
+     * 获取所有二进制内嵌对象的图元 ID
+     *
+     * @beta
+     * @param layer - 层
+     * @param primitiveLock - 是否锁定
+     * @returns 二进制内嵌对象的图元 ID 数组
+     */
+    getAllPrimitiveId(layer?: TPCB_LayersOfObject, primitiveLock?: boolean): Promise<Array<string>>;
+    /**
+     * 获取所有二进制内嵌对象
+     *
+     * @beta
+     * @param layer - 层
+     * @param primitiveLock - 是否锁定
+     * @returns 二进制内嵌对象图元对象数组
+     */
+    getAll(layer?: TPCB_LayersOfObject, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveObject>>;
 }
 
 /**
@@ -8909,13 +9406,86 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
  * @public
  */
 declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
-    /* Excluded from this release type: create */
-    /* Excluded from this release type: delete */
-    /* Excluded from this release type: modify */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: getAllPrimitiveId */
-    /* Excluded from this release type: getAll */
+    /**
+     * 创建覆铜边框
+     *
+     * @beta
+     * @param net - 网络名称
+     * @param layer - 层
+     * @param complexPolygon - 复杂多边形对象
+     * @param pourFillMethod - 覆铜填充方法
+     * @param preserveSilos - 是否保留孤岛
+     * @param pourName - 覆铜名称
+     * @param pourPriority - 覆铜优先级
+     * @param lineWidth - 线宽
+     * @param primitiveLock - 是否锁定
+     * @returns 覆铜边框图元对象
+     */
+    create(net: string, layer: TPCB_LayersOfCopper, complexPolygon: IPCB_Polygon, pourFillMethod?: EPCB_PrimitivePourFillMethod, preserveSilos?: boolean, pourName?: string, pourPriority?: number, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitivePour | undefined>;
+    /**
+     * 删除覆铜边框
+     *
+     * @beta
+     * @param primitiveIds - 覆铜边框的图元 ID 或覆铜边框图元对象
+     * @returns 删除操作是否成功
+     */
+    delete(primitiveIds: string | IPCB_PrimitivePour | Array<string> | Array<IPCB_PrimitivePour>): Promise<boolean>;
+    /**
+     * 修改覆铜边框
+     *
+     * @beta
+     * @param primitiveId - 图元 ID
+     * @param property - 修改参数
+     * @returns 覆铜边框图元对象，`undefined` 表示修改失败
+     */
+    modify(primitiveId: string | IPCB_PrimitivePour, property: {
+        net?: string;
+        layer?: TPCB_LayersOfCopper;
+        complexPolygon?: IPCB_Polygon;
+        pourFillMethod?: EPCB_PrimitivePourFillMethod;
+        preserveSilos?: boolean;
+        pourName?: string;
+        pourPriority?: number;
+        lineWidth?: number;
+        primitiveLock?: boolean;
+    }): Promise<IPCB_PrimitivePour | undefined>;
+    /**
+     * 获取覆铜边框
+     *
+     * @beta
+     * @param primitiveIds - 覆铜边框的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 覆铜边框图元对象，`undefined` 表示获取失败
+     */
+    get(primitiveIds: string): Promise<IPCB_PrimitivePour | undefined>;
+    /**
+     * 获取覆铜边框
+     *
+     * @beta
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @param primitiveIds - 覆铜边框的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 覆铜边框图元对象，空数组表示获取失败
+     */
+    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePour>>;
+    /**
+     * 获取所有覆铜边框的图元 ID
+     *
+     * @beta
+     * @param net - 网络名称
+     * @param layer - 层
+     * @param primitiveLock - 是否锁定
+     * @returns 覆铜边框的图元 ID 数组
+     */
+    getAllPrimitiveId(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<string>>;
+    /**
+     * 获取所有填充
+     *
+     * @beta
+     * @param net - 网络名称
+     * @param layer - 层
+     * @param primitiveLock - 是否锁定
+     * @returns 覆铜边框图元对象数组
+     */
+    getAll(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePour>>;
 }
 
 /**
@@ -8924,13 +9494,80 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
  * @public
  */
 declare class PCB_PrimitiveRegion implements IPCB_PrimitiveAPI {
-    /* Excluded from this release type: create */
-    /* Excluded from this release type: delete */
-    /* Excluded from this release type: modify */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: get */
-    /* Excluded from this release type: getAllPrimitiveId */
-    /* Excluded from this release type: getAll */
+    /**
+     * 创建区域
+     *
+     * @beta
+     * @param layer - 层
+     * @param complexPolygon - 复杂多边形对象
+     * @param ruleType - 区域规则类型
+     * @param reginName - 区域名称
+     * @param lineWidth - 线宽
+     * @param primitiveLock - 是否锁定
+     * @returns 区域图元对象
+     */
+    create(layer: TPCB_LayersOfRegion, complexPolygon: IPCB_Polygon, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, regionName?: string, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveRegion | undefined>;
+    /**
+     * 删除区域
+     *
+     * @beta
+     * @param primitiveIds - 区域的图元 ID 或区域图元对象
+     * @returns 删除操作是否成功
+     */
+    delete(primitiveIds: string | IPCB_PrimitiveRegion | Array<string> | Array<IPCB_PrimitiveRegion>): Promise<boolean>;
+    /**
+     * 修改区域
+     *
+     * @beta
+     * @param primitiveId - 图元 ID
+     * @param property - 修改参数
+     * @returns 区域图元对象，`undefined` 表示修改失败
+     */
+    modify(primitiveId: string | IPCB_PrimitiveRegion, property: {
+        layer?: TPCB_LayersOfRegion;
+        complexPolygon?: IPCB_Polygon;
+        ruleType?: Array<EPCB_PrimitiveRegionRuleType>;
+        regionName?: string;
+        lineWidth?: number;
+        primitiveLock?: boolean;
+    }): Promise<IPCB_PrimitiveRegion | undefined>;
+    /**
+     * 获取区域
+     *
+     * @beta
+     * @param primitiveIds - 区域的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 区域图元对象，`undefined` 表示获取失败
+     */
+    get(primitiveIds: string): Promise<IPCB_PrimitiveRegion | undefined>;
+    /**
+     * 获取区域
+     *
+     * @beta
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @param primitiveIds - 区域的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 区域图元对象，空数组表示获取失败
+     */
+    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveRegion>>;
+    /**
+     * 获取所有区域的图元 ID
+     *
+     * @beta
+     * @param layer - 层
+     * @param ruleType - 区域规则类型，只会匹配所有规则类型均一致的图元
+     * @param primitiveLock - 是否锁定
+     * @returns 区域的图元 ID 数组
+     */
+    getAllPrimitiveId(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<string>>;
+    /**
+     * 获取所有区域
+     *
+     * @beta
+     * @param layer - 层
+     * @param ruleType - 区域规则类型，只会匹配所有规则类型均一致的图元
+     * @param primitiveLock - 是否锁定
+     * @returns 区域图元对象数组
+     */
+    getAll(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveRegion>>;
 }
 
 /**
@@ -9477,7 +10114,7 @@ declare class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI {
      * @param centerY - 圆心 Y
      * @param radius - 半径
      * @param color - 颜色，`null` 表示默认
-     * @param fillColor - 填充���色，`none` 表示无填充，`null` 表示默认
+     * @param fillColor - 填充颜色，`none` 表示无填充，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
      * @returns 圆图元对象
@@ -10436,7 +11073,7 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @param filenameExtensions - 文件扩展名
-     * @returns File 格式文件
+     * @returns File 格式��件
      */
     openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
     /**
@@ -10691,7 +11328,7 @@ declare class SYS_Log {
      * 查找条目
      *
      * @public
-     * @remarks 如果日志面板处于打开状态，查找操���会同时在前端展现
+     * @remarks 如果日志面板处于打开状态，查找操作会同时在前端展现
      * @param message - 查找内容
      * @param types - 日志类型数组，可以在指定的日志类型内查找
      * @returns 符合查找条件的日志条目数组
@@ -10943,7 +11580,7 @@ declare class SYS_Storage {
      * 获取扩展用户配置
      *
      * @public
-     * @remarks 注意：本接口仅扩���有效，在独立脚本环境内调用将始终 `throw Error`
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param key - 配置项
      * @returns 配置项对应的值，不存在将返回 `undefined`
      */

package/package.json

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