@jlceda/pro-api-types 0.1.75 → 0.1.76

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 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -784,6 +784,7 @@ declare class EDA {
     sys_ToastMessage: SYS_ToastMessage;
     sys_Unit: SYS_Unit;
     sys_WebSocket: SYS_WebSocket;
+    sys_Window: SYS_Window;
     /* Excluded from this release type: extensionUuid */
     /* Excluded from this release type: allowExternalInteractions */
     /* Excluded from this release type: __constructor */
@@ -1550,6 +1551,30 @@ declare enum ESYS_Unit {
     MIL = "mil"
 }
 
+/**
+ * 窗口事件类型
+ *
+ * @public
+ */
+declare enum ESYS_WindowEventType {
+    /** 失去焦点 */
+    BLUR = "blur",
+    /** 获取焦点 */
+    FOCUS = "focus"
+}
+
+/**
+ * 打开窗口上下文目标
+ *
+ * @public
+ */
+declare enum ESYS_WindowOpenTarget {
+    /** 新标签页 */
+    BLANK = "_blank",
+    /** 当前页 */
+    SELF = "_self"
+}
+
 /**
  * 板子属性
  *
@@ -2085,7 +2110,7 @@ declare interface ILIB_PanelLibraryItem {
     libraryUuid: string;
     /** 面板库名称 */
     name: string;
-    /** 分类 */
+    /** 分�� */
     classification?: ILIB_ClassificationIndex;
     /** 描述 */
     description?: string;
@@ -2245,7 +2270,7 @@ declare interface IPCB_LayerItem {
     type: EPCB_LayerType;
     /** 颜色（RGB HEX 格式） */
     color: string;
-    /** 透明度（%） */
+    /** ��明度（%） */
     transparency: number;
 }
 
@@ -2554,7 +2579,7 @@ declare class IPCB_PrimitiveDimension implements IPCB_Primitive {
      * @returns
      */
     getState_PrimitiveId(): string;
-    /** @alpha 所有的 setState_* 方法都需要对��据进行基本的格式校验 */
+    /** @alpha 所有的 setState_* 方法都需要对数据进行基本的格式校验 */
     /**
      * 设置属性状态：尺寸标注类型
      *
@@ -2997,7 +3022,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * @remarks
      * 设置焊盘外形时将会联动设置部分其它属性状态：
      *
-     * 1. 特殊焊盘外形属性将被清���
+     * 1. 特殊焊盘外形属性将被清空
      *
      * @param pad - 焊盘外形
      * @returns 焊盘图元对象
@@ -3248,7 +3273,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
 declare interface IPCB_PrimitiveSolderMaskAndPasteMaskExpansion {
     /** 顶层阻焊扩展 */
     topSolderMask?: number;
-    /** 底层阻焊扩展 */
+    /** 底��阻焊扩展 */
     bottomSolderMask?: number;
     /** 顶层助焊扩展 */
     topPasteMask?: number;
@@ -3935,7 +3960,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
     private height;
     /** 圆角半径 */
     private cornerRadius;
-    /** 旋转角度 */
+    /** 旋���角度 */
     private rotation;
     /** 边框颜色 */
     private color;
@@ -4201,6 +4226,20 @@ declare interface ISYS_MultilingualLanguagesData {
     [language: string]: ISYS_LanguageKeyValuePairs;
 }
 
+/**
+ * 窗口事件监听可移除对象
+ *
+ * @public
+ * @remarks 本对象从 {@link addEventListener} 获取，并可用于移除创建的事件监听，仅需将其传入 {@link removeEventListener}
+ */
+declare interface ISYS_WindowEventListenerRemovableObject {
+    type: ESYS_WindowEventType;
+    listener: (ev: any) => any;
+    options?: {
+        capture?: boolean;
+    };
+}
+
 /**
  * 综合库 / 3D 模型类
  *
@@ -4989,7 +5028,7 @@ declare class PCB_Document {
      * 嘉立创 EDA 专业版 API 使用的均为数据原点；
      *
      * 如果希望在 API 操作时前端画布坐标能与数据一致，
-     * 建议调用本方法并设置偏移量���零，
+     * 建议调用本方法并设置偏移量为零，
      * 即 `setCanvasOrigin(0, 0)`；
      *
      * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
@@ -5856,7 +5895,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
      */
     create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, arcAngle: number, lineWidth?: number, interactiveMode?: EPCB_PrimitiveArcInteractiveMode, primitiveLock?: boolean): Promise<IPCB_PrimitiveArc | undefined>;
     /**
-     * 删除圆弧线
+     * ���除圆弧线
      *
      * @beta
      * @param primitiveIds - 圆弧线的图元 ID 或圆弧线图元对象
@@ -6620,7 +6659,7 @@ declare class PNL_Document {
      * 保存文档
      *
      * @beta
-     * @returns 保存操作是否成功，保存失败、上传失败等错误均返回 `false`
+     * @returns 保存操作是否成功，保存失败、上传���败等错误均返回 `false`
      */
     save(): Promise<boolean>;
 }
@@ -7042,7 +7081,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param componentUuid - 器件 UUID
-     * @param libraryPath - 库路径，默认为系统库
+     * @param libraryPath - 库路���，默认为系统库
      * @returns 操作是否成功
      */
     setNetFlagComponentUuid_ProtectGround(componentUuid: string, libraryPath?: string): Promise<boolean>;
@@ -7142,7 +7181,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @param primitiveId - 图元 ID
      * @param x - 坐标 X
      * @param y - 坐标 Y
-     * @param rotation - 旋转角度，可��� `0` `90` `180` `270`
+     * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param mirror - 是否镜像
      * @param libraryPath - 库路径，默认为系统库
      * @param addIntoBom - 是否加入 BOM
@@ -7326,7 +7365,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
      * 获取多边形
      *
      * @beta
-     * @param primitiveIds - 多边形的图元 ID，可以为字符串或��符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 多边形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitivePolygon | undefined>;
@@ -7400,7 +7439,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @public
-     * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 矩形的���元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveRectangle | undefined>;
@@ -7514,7 +7553,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
      * 3. 有多个坐标点在多个不同网络的图元上，则创建失败
      *
      * 如若已指定，则遵循：
-     * 1. 有一个或多个坐���点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
+     * 1. 有一个或多个坐标点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
      * 2. 如若其他图元指定了网络，则创建失败
      * @param color - 导线颜色，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
@@ -7758,7 +7797,7 @@ declare class SYS_FileManager {
      */
     getFootprintFileByFootprintUuid(footprintUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
     /**
-     * 使用复用模块 UUID 获取复用模块文件
+     * 使用复用模块 UUID ��取复用模块文件
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -8256,7 +8295,7 @@ declare class SYS_Unit {
      *
      * @public
      * @param mil - 输入密尔数
-     * @param numberOfDecimals - 保留小数位数，默认为 `4`
+     * @param numberOfDecimals - 保留小��位数，默认为 `4`
      * @returns 输出毫米数
      */
     milToMm(mil: number, numberOfDecimals?: number): number;
@@ -8358,6 +8397,45 @@ declare class SYS_WebSocket {
     close(id: string, code?: number, reason?: string, extensionUuid?: string): void;
 }
 
+/**
+ * 系统 / 窗口类
+ *
+ * @public
+ * @remarks 为了保证安全性，仅提供有限的窗口跳转与监听支持，更多操作请使用内联框架窗口 {@link SYS_IFrame}
+ */
+declare class SYS_Window {
+    /**
+     * 打开资源窗口
+     *
+     * @beta
+     * @param url - 欲加载资源的 URL 或路径
+     * @param target - 上下文目标
+     */
+    open(url: string, target?: ESYS_WindowOpenTarget): void;
+    /**
+     * 新增事件监听
+     *
+     * @beta
+     * @param type - 事件类型，当前支持 `blur` `focus`
+     * @param listener - 事件监听回调
+     * @param options - 可选参数
+     * @returns 事件监听方法，用于移除事件监听，如若为 `undefined` 则表示创建事件监听失败
+     */
+    addEventListener(type: ESYS_WindowEventType, listener: (ev: any) => any, options?: {
+        capture?: boolean;
+        once?: boolean;
+        passive?: boolean;
+        signal?: AbortSignal;
+    }): ISYS_WindowEventListenerRemovableObject | undefined;
+    /**
+     * 移除事件监听
+     *
+     * @beta
+     * @param removableObject - 窗口事件监听可移除对象
+     */
+    removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;
+}
+
 /**
  * 可选中图层
  *

package/package.json

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