@jlceda/pro-api-types 0.1.103 → 0.1.105

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 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -1017,7 +1017,7 @@ declare enum EPCB_LayerId {
     TOP_SOLDER_MASK = 5,
     /** 顶层锡膏（助焊）层 */
     TOP_PASTE_MASK = 7,
-    /** 顶层装配层 */
+    /** 顶层���配层 */
     TOP_ASSEMBLY = 9,
     /** 顶层 FPC 补强层 */
     TOP_STIFFENER = 58,
@@ -3102,7 +3102,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
  *
  * @public
  * @remarks
- * 器件焊���图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
+ * 器件��盘图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
  *
  * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
  */
@@ -3578,7 +3578,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      */
     getState_PrimitiveLock(): boolean;
     /**
-     * 设置属性状态：BBox 左上点坐标 X
+     * 设���属性状态：BBox 左上点坐标 X
      *
      * @beta
      * @param x - BBox 左上点坐标 X
@@ -3745,7 +3745,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      */
     getState_StartX(): number;
     /**
-     * 获取属性状态：起始���置 Y
+     * 获取属性状态：起��位置 Y
      *
      * @public
      * @returns 起始位置 Y
@@ -4230,7 +4230,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Hole(): TPCB_PrimitivePadHole | null;
     /**
-     * 获取属性���态：孔偏移 X
+     * 获取属��状态：孔偏移 X
      *
      * @public
      * @returns 孔偏移 X
@@ -4358,7 +4358,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * 设置属性状态：网络
      *
      * @beta
-     * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
+     * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被���为空网络
      * @param net - 网络名称
      * @returns 焊盘图元对象
      */
@@ -4488,7 +4488,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     reset(): Promise<IPCB_PrimitivePad>;
     /**
-     * 将对图元的更改应用到画布
+     * 将对图元的更改应用到���布
      *
      * @beta
      * @returns 尺寸标注图元对象
@@ -4649,7 +4649,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异��图元重置为当前画布状态
+     * 将异步图元重置为当前画布状态
      *
      * @beta
      * @returns 折线图元对象
@@ -4812,7 +4812,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * 设置属性状态：是否保留孤岛
      *
      * @beta
-     * @param preserveSilos - 是否保���孤岛
+     * @param preserveSilos - 是否��留孤岛
      * @returns 覆铜边框图元对象
      */
     setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;
@@ -5104,7 +5104,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      */
     getState_PrimitiveType(): EPCB_PrimitiveType;
     /**
-     * 获取属性状态：图元 ID
+     * 获取属性状态���图元 ID
      *
      * @public
      * @returns 图元 ID
@@ -5267,7 +5267,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异步图���重置为当前画布状态
+     * 将异步��元重置为当前画布状态
      *
      * @beta
      * @returns 过孔图元对象
@@ -7175,7 +7175,7 @@ declare class LIB_Symbol {
  */
 declare class PCB_Document {
     /**
-     * 从原理图导入��更
+     * 从原理图导入变更
      *
      * @public
      * @param uuid - 原理图 UUID，默认为关联在同一个 Board 下的原理图
@@ -7285,7 +7285,7 @@ declare class PCB_Document {
         offsetY: number;
     }>;
     /**
-     * 设置画布���点相对于数据原点的偏移坐标
+     * 设置画��原点相对于数据原点的偏移坐标
      *
      * @public
      * @remarks
@@ -7502,7 +7502,7 @@ declare class PCB_Drc {
      */
     deleteNetClass(netClassName: string): Promise<boolean>;
     /**
-     * 修改网络类的��称
+     * 修改网络类的名称
      *
      * @beta
      * @param originalNetClassName - 原网络类名称
@@ -7745,7 +7745,7 @@ declare class PCB_Layer {
      *
      * @public
      * @param layer - 层
-     * @returns 操作是否成功，不��在指定层将返回 `false`
+     * @returns 操作是否成功，不存在指定层将返回 `false`
      */
     selectLayer(layer: TPCB_LayersInTheSelectable): Promise<boolean>;
     /**
@@ -8123,7 +8123,7 @@ declare class PCB_MathPolygon {
  */
 declare class PCB_Net {
     /**
-     * 获取所有���络的网络名称
+     * 获取所��网络的网络名称
      *
      * @beta
      * @returns 网络名称数组
@@ -8345,7 +8345,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      * @param primitiveLock - 是否锁定
      * @param addIntoBom - 是否加入 BOM
      * @param designator - 位号
-     * @param name - 名称，`null` 表示留空
+     * @param name - 名称，`null` 表示留���
      * @param uniqueId - 唯一 ID，`null` 表示留空
      * @param manufacturer - 制造商，`null` 表示留空
      * @param manufacturerId - 制造商编号，`null` 表示留空
@@ -8653,7 +8653,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * 获取直线
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传���的图元 ID 数量的图元对象
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 直线图元对象，空数组表示获取失败
      */
@@ -10243,7 +10243,7 @@ declare class SYS_Environment {
      */
     isProPrivateEdition(): boolean;
     /**
-     * 是否���在线模式
+     * 是��为在线模式
      *
      * @public
      * @returns 是否为在线模式
@@ -10446,7 +10446,7 @@ declare class SYS_I18n {
      *
      * @public
      * @remarks
-     * 可以使用 `${1}` 格式的占位符表���参数；
+     * 可以使用 `${1}` 格式的占位符��示参数；
      *
      * 语言优先级：当前显示语言 \> 系统默认语言 \> 数据集中第一个搜索到的包含该文本标签的语言 \> 文本标签(tag)
      * @param tag - 文本标签，对应多语言文件键值对中的键
@@ -10523,17 +10523,37 @@ declare class SYS_IFrame {
      * 打开内联框架窗口
      *
      * @beta
+     * @remarks
+     * 本接口仅扩展包允许调用，用户需要在扩展包内包含用于内联的 HTML 文件；
+     *
+     * 本接口调用后将会打开一个 Dialog 窗口，该 Dialog 窗口的标题为 HTML 文件的 `<title>`，标题栏有关闭按钮；
+     *
+     * 正文部分为内联框架，{@link width} 和 {@link height} 均为正文部分内联框架的宽高；
+     *
+     * 内联框架需要展示 {@link htmlFileName} 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
      * @param width - 内联框架窗口的宽度
      * @param height - 内联框架窗口的高度
+     * @param id - 内联框架窗口 ID，用于关闭内联框架窗口
+     * @returns 操作是否成功
      */
-    openIFrame(htmlFileName: string, width?: number, height?: number): Promise<void>;
+    openIFrame(htmlFileName: string, width?: number, height?: number, id?: string): Promise<boolean>;
     /**
      * 关闭内联框架窗口
      *
-     * @public
+     * @beta
+     * @remarks
+     * 关闭当前扩展打开的所有内联框架窗口；
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打��的所有内联框架窗口
+     * @returns 操作是否成功
      */
-    closeIFrame(): Promise<void>;
+    closeIFrame(id?: string): Promise<boolean>;
+    /* Excluded from this release type: hideIFrame */
+    /* Excluded from this release type: showIFrame */
 }
 
 /**
@@ -10664,7 +10684,7 @@ declare class SYS_MessageBox {
 }
 
 /**
- * 系统 / 面板控制类
+ * ���统 / 面板控制类
  *
  * @public
  */
@@ -10673,7 +10693,7 @@ declare class SYS_PanelControl {
      * 打开左侧面板
      *
      * @public
-     * @param tab - 标签页，如若不指定则不��换标签页
+     * @param tab - 标签页，如若不指定则不切换标签页
      */
     openLeftPanel(tab?: ESYS_LeftPanelTab): void;
     /**
@@ -10806,7 +10826,7 @@ declare class SYS_Storage {
      * 获取扩展所有用户配置
      *
      * @public
-     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @remarks 注意：本接��仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @returns 扩展所有用户配置信息
      */
     getExtensionAllUserConfigs(): {

package/package.json

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