@jlceda/pro-api-types 0.1.166 → 0.1.168

package/index.d.ts

@@ -10055,9 +10055,48 @@ declare class PCB_Document {
      * @returns 操作是否成功
      */
     navigateToCoordinates(x: number, y: number): Promise<boolean>;
-    /* Excluded from this release type: navigateToRegion */
-    /* Excluded from this release type: getPrimitiveAtPoint */
-    /* Excluded from this release type: getPrimitivesInRegion */
+    /**
+     * 定位到画布区域
+     *
+     * @beta
+     * @remarks
+     * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
+     *
+     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
+     * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
+     *
+     * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
+     *
+     * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
+     * @param left - 矩形框第一 X 坐标
+     * @param right - 矩形框第二 X 坐标
+     * @param top - 矩形框第一 Y 坐标
+     * @param bottom - 矩形框第二 Y 坐标
+     * @returns 操作是否成功
+     */
+    navigateToRegion(left: number, right: number, top: number, bottom: number): Promise<boolean>;
+    /**
+     * 获取坐标点的图元
+     *
+     * @beta
+     * @remarks 本操作和前端鼠标点击操作类似，将会获取指定坐标点上的图元
+     * @param x - 坐标点 X
+     * @param y - 坐标点 Y
+     * @returns 坐标点的图元，如若坐标点无法找到图元，将返回 `undefined`
+     */
+    getPrimitiveAtPoint(x: number, y: number): Promise<IPCB_Primitive | undefined>;
+    /**
+     * 获取区域内所有图元
+     *
+     * @beta
+     * @param left - 矩形框第一 X 坐标
+     * @param right - 矩形框第二 X 坐标
+     * @param top - 矩形框第一 Y 坐标
+     * @param bottom - 矩形框第二 Y 坐标
+     * @param leftToRight - 是否仅获取完全框选的图元，`false` 则触碰即获取
+     * @returns 区域内所有图元
+     */
+    getPrimitivesInRegion(left: number, right: number, top: number, bottom: number, leftToRight?: boolean): Promise<Array<IPCB_Primitive>>;
     /**
      * 缩放到板框（适应板框）
      *
@@ -10065,6 +10104,7 @@ declare class PCB_Document {
      * @returns 操作是否成功
      */
     zoomToBoardOutline(): Promise<boolean>;
+    /* Excluded from this release type: getCurrentFilterConfiguration */
 }
 
 /**
@@ -11970,7 +12010,7 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
      * 获取折线
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可���返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 折线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 折线图元对象，空数组表示获取失败
      */
@@ -12391,6 +12431,7 @@ declare class SCH_Document {
     /* Excluded from this release type: navigateToRegion */
     /* Excluded from this release type: getPrimitiveAtPoint */
     /* Excluded from this release type: getPrimitivesInRegion */
+    /* Excluded from this release type: getCurrentFilterConfiguration */
 }
 
 /**
@@ -12404,7 +12445,7 @@ declare class SCH_Drc {
      * 检查 DRC
      *
      * @public
-     * @remarks 如若检查结果存在 **错误** 或以上级别，将会始终呼出底��� DRC 窗口，无视 `userInterface` 参数
+     * @remarks 如若检查结果存在 **错误** 或以上级别，将会始终呼出底部 DRC 窗口，无视 `userInterface` 参数
      * @param strict - 是否严格检查，严格检查时存在 Warning 将返回 `false`，否则返回 `true`
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
      * @returns DRC 检查是否无错误
@@ -13484,7 +13525,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
      * 获取多边形
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返���少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 多边形图元对象，空数组表示获取失败
      */
@@ -13954,7 +13995,7 @@ declare class SYS_Dialog {
     showSelectDialog(options: Array<string> | Array<{
         value: string;
         displayContent: string;
-    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: string, multiple?: false, callbackFn?: (value: string) => void): void;
+    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: string, multiple?: false, callbackFn?: (value: string) => void | Promise<void>): void;
     /**
      * 弹出多选窗口
      *
@@ -13976,7 +14017,8 @@ declare class SYS_Dialog {
     showSelectDialog(options: Array<string> | Array<{
         value: string;
         displayContent: string;
-    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: Array<string>, multiple?: true, callbackFn?: (value: Array<string>) => void): void;
+    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: Array<string>, multiple?: true, callbackFn?: (value: Array<string>) => void | Promise<void>): void;
+    /* Excluded from this release type: insertScriptToDialog */
 }
 
 /**
@@ -14469,19 +14511,29 @@ declare class SYS_IFrame {
      * 内联框架需要展示 `htmlFileName` 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
-     * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
+     * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径，从扩展根目录起始，例如 `/iframe/index.html`
      * @param width - 内联框架窗口的宽度
      * @param height - 内联框架窗口的高度
      * @param id - 内联框架窗口 ID，用于关闭内联框架窗口
+     * @param props - 其它参数
      * @returns 操作是否成功
      */
-    openIFrame(htmlFileName: string, width?: number, height?: number, id?: string): Promise<boolean>;
+    openIFrame(htmlFileName: string, width?: number, height?: number, id?: string, props?: {
+        /** 是否显示最大化按钮 */
+        maximizeButton?: boolean;
+        /** 是否显示最小化按钮 */
+        minimizeButton?: boolean;
+        /** 按钮点击回调 */
+        buttonCallbackFn?: (button: 'close' | 'minimize' | 'maximize') => void;
+        /** 是否背景置灰 */
+        grayscaleMask?: boolean;
+    }): Promise<boolean>;
     /**
      * 关闭内联框架窗口
      *
      * @beta
      * @remarks
-     * 关闭当前扩展打开的所有内联框架窗口；
+     * 关闭指定 ID 的内联框架窗口；
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打开的所有内联框架窗口

package/package.json

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