@jlceda/pro-api-types 0.1.102 → 0.1.104

package/index.d.ts

@@ -1017,7 +1017,7 @@ declare enum EPCB_LayerId {
     TOP_SOLDER_MASK = 5,
     /** 顶层锡膏（助焊）层 */
     TOP_PASTE_MASK = 7,
-    /** 顶层���配层 */
+    /** 顶层��配层 */
     TOP_ASSEMBLY = 9,
     /** 顶层 FPC 补强层 */
     TOP_STIFFENER = 58,
@@ -1433,25 +1433,50 @@ declare enum ESCH_PrimitiveComponentType {
     NET_LABEL = "netlabel"
 }
 
+/**
+ * 引脚形状
+ *
+ * @public
+ */
+declare enum ESCH_PrimitivePinShape {
+    /** 无 */
+    NONE = "None",
+    /** 反向 */
+    INVERTED = "Inverted",
+    /** 时钟 */
+    CLOCK = "Clock",
+    /** 反向时钟 */
+    INVERTED_CLOCK = "Inverted Clock"
+}
+
 /**
  * 引脚类型
  *
  * @public
- * @remarks 引脚图元仅符号编辑器可用，在原理图图页内，关联到符号的引脚被称为 {@link ISCH_PrimitiveComponentPin | 器件引脚图元}
  */
 declare enum ESCH_PrimitivePinType {
+    /** 输入 */
     IN = "IN",
+    /** 输出 */
     OUT = "OUT",
+    /** 双向 */
     BI = "BI",
+    /** 无源 */
+    PASSIVE = "Passive",
+    /** 开集电极 */
     OPEN_COLLECTOR = "Open Collector",
-    STATE_3 = "3 State",
+    /** 开发射极 */
     OPEN_EMITTER = "Open Emitter",
+    /** 电源 */
     POWER = "Power",
+    /** 地 */
+    GROUND = "Ground",
+    /** 高阻 */
     HIZ = "HIZ",
-    UNDEFINED = "Undefined",
+    /** 信号终端 */
     TERMINATOR = "Terminator",
-    GROUND = "Ground",
-    DEFAULT = "BI"
+    /** 未定义 */
+    UNDEFINED = "Undefined"
 }
 
 /**
@@ -3079,7 +3104,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
  * @remarks
  * 器件焊盘图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
  *
- * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘��元
+ * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
  */
 declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
     /** 图元类型 */
@@ -3553,7 +3578,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      */
     getState_PrimitiveLock(): boolean;
     /**
-     * 设置属性状态：BBox 左上点坐标 X
+     * 设��属性状态：BBox 左上点坐标 X
      *
      * @beta
      * @param x - BBox 左上点坐标 X
@@ -3902,7 +3927,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * 获取属性状态：图元 ID
      *
      * @public
-     * @returns 图��� ID
+     * @returns 图元 ID
      */
     getState_PrimitiveId(): string;
     /**
@@ -3911,21 +3936,21 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @public
      * @returns 层
      */
-    getState_Layer(): TPCB_LayersOfObject;
+    getState_Layer(): TPCB_LayersOfObject | undefined;
     /**
      * 获取属性状态：左上点 X
      *
      * @public
      * @returns 左上点 X
      */
-    getState_TopLeftX(): number;
+    getState_TopLeftX(): number | undefined;
     /**
      * 获取属性状态：左上点 Y
      *
      * @public
      * @returns 左上点 Y
      */
-    getState_TopLeftY(): number;
+    getState_TopLeftY(): number | undefined;
     /**
      * 获取属性状态：二进制数据
      *
@@ -3939,42 +3964,42 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @public
      * @returns 宽
      */
-    getState_Width(): number;
+    getState_Width(): number | undefined;
     /**
      * 获取属性状态：高
      *
      * @public
      * @returns 高
      */
-    getState_Height(): number;
+    getState_Height(): number | undefined;
     /**
      * 获取属性状态：旋转角度
      *
      * @public
      * @returns 旋转角度
      */
-    getState_Rotation(): number;
+    getState_Rotation(): number | undefined;
     /**
      * 获取属性状态：是否水平镜像
      *
      * @public
      * @returns 是否水平镜像
      */
-    getState_Mirror(): boolean;
+    getState_Mirror(): boolean | undefined;
     /**
      * 获取属性状态：文件名
      *
      * @public
      * @returns 文件名
      */
-    getState_FileName(): string;
+    getState_FileName(): string | undefined;
     /**
      * 获取属性状态：是否锁定
      *
      * @public
      * @returns 是否锁定
      */
-    getState_PrimitiveLock(): boolean;
+    getState_PrimitiveLock(): boolean | undefined;
     /**
      * 设置属性状态：层
      *
@@ -3982,7 +4007,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param layer - 层
      * @returns 二进制内嵌对象图元对象
      */
-    setState_Layer(layer: TPCB_LayersOfObject): IPCB_PrimitiveObject;
+    setState_Layer(layer: TPCB_LayersOfObject | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：左上点 X
      *
@@ -3990,7 +4015,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param topLeftX - 左上点 X
      * @returns 二进制内嵌对象图元对象
      */
-    setState_TopLeftX(topLeftX: number): IPCB_PrimitiveObject;
+    setState_TopLeftX(topLeftX: number | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：左上点 Y
      *
@@ -3998,7 +4023,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param topLeftY - 左上点 Y
      * @returns 二进制内嵌对象图元对象
      */
-    setState_TopLeftY(topLeftY: number): IPCB_PrimitiveObject;
+    setState_TopLeftY(topLeftY: number | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：二进制数据
      *
@@ -4014,7 +4039,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param width - 宽
      * @returns 二进制内嵌对象图元对象
      */
-    setState_Width(width: number): IPCB_PrimitiveObject;
+    setState_Width(width: number | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：高
      *
@@ -4022,7 +4047,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param height - 高
      * @returns 二进制内嵌对象图元对象
      */
-    setState_Height(height: number): IPCB_PrimitiveObject;
+    setState_Height(height: number | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：旋转角度
      *
@@ -4030,7 +4055,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param rotation - 旋转角度
      * @returns 二进制内嵌对象图元对象
      */
-    setState_Rotation(rotation: number): IPCB_PrimitiveObject;
+    setState_Rotation(rotation: number | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：是否水平镜像
      *
@@ -4038,7 +4063,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param mirror - 是否水平镜像
      * @returns 二进制内嵌对象图元对象
      */
-    setState_Mirror(mirror: boolean): IPCB_PrimitiveObject;
+    setState_Mirror(mirror: boolean | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：文件名
      *
@@ -4046,7 +4071,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param fileName - 文件名
      * @returns 二进制内嵌对象图元对象
      */
-    setState_FileName(fileName: string): IPCB_PrimitiveObject;
+    setState_FileName(fileName: string | undefined): IPCB_PrimitiveObject;
     /**
      * 设置属性状态：是否锁定
      *
@@ -4054,7 +4079,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * @param primitiveLock - 是否锁定
      * @returns 二进制内嵌对象图元对象
      */
-    setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveObject;
+    setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveObject;
     /**
      * 将图元转换为异步图元
      *
@@ -4463,7 +4488,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     reset(): Promise<IPCB_PrimitivePad>;
     /**
-     * 将对图元的更改应用到画布
+     * 将对图元的更改应用到��布
      *
      * @beta
      * @returns 尺寸标注图元对象
@@ -4624,7 +4649,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异步图元重置为当前画布状态
+     * 将异���图元重置为当前画布状态
      *
      * @beta
      * @returns 折线图元对象
@@ -5697,7 +5722,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
         uuid: string;
     } | undefined;
     /**
-     * 获取属性状态：关联库��装
+     * 获取属性状态：关联库封装
      *
      * @public
      * @returns 关联库封装
@@ -5980,7 +6005,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
     protected pinLength: number;
     /** 引脚颜色 */
     protected pinColor: string | null;
-    /** 引脚外形 */
+    /** 引脚形状 */
     protected pinShape: string;
     /** 引脚类型 */
     protected pinType: ESCH_PrimitivePinType;
@@ -6362,7 +6387,7 @@ declare class ISCH_PrimitiveWire implements ISCH_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异步图元重置为当前画布状态
+     * 将异步图元重置��当前画布状态
      *
      * @beta
      */
@@ -6387,7 +6412,7 @@ declare interface ISYS_FileSystemFileList {
     isDirectory: boolean;
     /** 目录子文件 */
     subFiles?: Array<ISYS_FileSystemFileList>;
-    /** 相对路径���不包含前面的传入路径和文件名（当没有传入路径时，不存在相对路径），且前后均无斜杠 */
+    /** 相对路径，不包含前面的传入路径和文件名（当没有传入路径时，不存在相对路径），且前后均无斜杠 */
     relativePath?: string;
     /** 完整路径，包含文件名的绝对路径 */
     fullPath: string;
@@ -6507,7 +6532,7 @@ declare class LIB_3DModel {
      *
      * @beta
      * @param key - 搜索关键字
-     * @param libraryUuid - 库 UUID，默认为系统库��可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param classification - 分类，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
@@ -6798,7 +6823,7 @@ declare class LIB_Device {
      *
      * @beta
      * @param key - 搜索关键字
-     * @param libraryUuid - 库 UUID，默认为系统库，可以��用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param classification - 分类，默认为全部
      * @param symbolType - 符号类型，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
@@ -7355,6 +7380,7 @@ declare class PCB_Drc {
      * 保存设计规则配置
      *
      * @beta
+     * @remarks 只有自定义配置可以覆盖保存，系统配置不允许修改和覆盖
      * @param ruleConfiguration - 设计规则配置
      * @param configurationName - 配置名称
      * @param allowOverwrite - 是否允许覆写同名设计规则配置，`false` 则将在遇到同名设计规则配置时返回 `false`，请注意可能的数据丢失风险
@@ -7510,7 +7536,7 @@ declare class PCB_Drc {
      */
     getAllNetClasses(): Promise<Array<IPCB_NetClassItem>>;
     /**
-     * 创建���分对
+     * 创建差分对
      *
      * @beta
      * @param differentialPairName - 差分对名称
@@ -7663,7 +7689,14 @@ declare class PCB_Drc {
      * @returns 所有焊盘对组的详细属性
      */
     getAllPadPairGroups(): Promise<Array<IPCB_PadPairGroupItem>>;
-    /* Excluded from this release type: getPadPairGroupMinWireLength */
+    /**
+     * 获取焊盘对组最短导线长度
+     *
+     * @beta
+     * @param padPairGroupName - 焊盘对组名称
+     * @returns 所有焊盘对的最短导线长度
+     */
+    getPadPairGroupMinWireLength(padPairGroupName: string): Promise<Array<IPCB_PadPairMinWireLengthItem>>;
 }
 
 /**
@@ -7712,7 +7745,7 @@ declare class PCB_Layer {
      *
      * @public
      * @param layer - 层
-     * @returns 操作是否成功，不存在指定层将返回 `false`
+     * @returns 操作是否成功，不���在指定层将返回 `false`
      */
     selectLayer(layer: TPCB_LayersInTheSelectable): Promise<boolean>;
     /**
@@ -8312,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` 表示留空
@@ -8620,7 +8653,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * 获取直线
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传��的图元 ID 数量的图元对象
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 直线图元对象，空数组表示获取失败
      */
@@ -8967,7 +9000,7 @@ declare class PCB_PrimitiveVia implements IPCB_PrimitiveAPI {
  * PCB & 封装 / 选择控制类
  *
  * @public
- * @remarks ��取或操作选择的元素
+ * @remarks 获取或操作选择的元素
  */
 declare class PCB_SelectControl {
     /**
@@ -9069,6 +9102,7 @@ declare class SCH_Drc {
      * 检查 DRC
      *
      * @public
+     * @remarks 如若检查结果存在 **错误** 或以上级别，将会始终呼出底部 DRC 窗口，无视 `userInterface` 参数
      * @param strict - 是否严格检查，严格检查时存在 Warning 将返回 `false`，否则返回 `true`
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
      * @returns DRC 检查是否无错误
@@ -9382,7 +9416,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 圆图元对象
@@ -9677,6 +9711,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
  * 原理图 & 符号 / 引脚图元类
  *
  * @public
+ * @remarks 引脚图元仅符号编辑器可用，在原理图图页内，关联到符号的引脚被称为 {@link ISCH_PrimitiveComponentPin | 器件引脚图元}
  */
 declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
     /**
@@ -9690,7 +9725,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
      * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param pinLength - 引脚长度
      * @param pinColor - 引脚颜色，`null` 表示默认
-     * @param activeLow - 是否低电平有效
+     * @param pinShape - 引脚形状
      * @param pinType - 引脚类型
      * @returns 引脚图元对象
      */
@@ -9715,7 +9750,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
      * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param pinLength - 引脚长度
      * @param pinColor - 引脚颜色，`null` 表示默认
-     * @param activeLow - 是否低电平有效
+     * @param pinShape - 引脚形状
      * @param pinType - 引脚类型
      * @returns 引脚图元对象
      */
@@ -9733,18 +9768,16 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
      * 获取所有引脚的图元 ID
      *
      * @beta
-     * @remarks 当处于符号编辑器时，componentPrimitiveId 应始终为 undefined
      * @returns 引脚的图元 ID 数组
      */
-    getAllPrimitiveId(componentPrimitiveId?: string | ISCH_PrimitiveComponent): Promise<Array<string>>;
+    getAllPrimitiveId(): Promise<Array<string>>;
     /**
      * 获取所有引脚
      *
      * @beta
-     * @remarks 当处于符号编辑器时，componentPrimitiveId 应始终为 undefined
      * @returns 引脚图元对象数组
      */
-    getAll(componentPrimitiveId?: string | ISCH_PrimitiveComponent): Promise<Array<ISCH_PrimitivePin>>;
+    getAll(): Promise<Array<ISCH_PrimitivePin>>;
 }
 
 /**
@@ -9853,7 +9886,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * @param height - 高
      * @param cornerRadius - 圆角半径
      * @param rotation - 旋转角度，绕左上点旋转，可选 `0` `90` `180` `270`
-     * @param color - 颜色，`null` ��示默认
+     * @param color - 颜色，`null` 表示默认
      * @param fillColor - 填充颜色，`none` 表示无填充，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
@@ -10255,7 +10288,7 @@ declare class SYS_FileManager {
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      * @param fileName - 文件名
      * @param password - 加密密码
-     * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获��失败
+     * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获取失败
      */
     getDocumentFile(fileName?: string, password?: string): Promise<File | undefined>;
     /**
@@ -10340,7 +10373,7 @@ declare class SYS_FileSystem {
     private extensionUuid?;
     /* Excluded from this release type: __constructor */
     /**
-     * 打开读入文件���口
+     * 打开读入文件窗口
      *
      * @beta
      * @param filenameExtensions - 文件扩展名
@@ -10452,7 +10485,7 @@ declare class SYS_I18n {
      * @public
      * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param language - 语言
-     * @param source - 欲导��的多语言数据对象
+     * @param source - 欲导入的多语言数据对象
      * @returns 导入是否成功
      */
     importMultilingual(language: string, source: ISYS_LanguageKeyValuePairs): boolean;
@@ -10490,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 */
 }
 
 /**
@@ -10631,7 +10684,7 @@ declare class SYS_MessageBox {
 }
 
 /**
- * 系统 / 面板控制类
+ * ��统 / 面板控制类
  *
  * @public
  */
@@ -11255,7 +11308,7 @@ declare type TPCB_PolygonSourceArray = Array<'L' | 'ARC' | 'CARC' | 'C' | 'R' |
  *
  * - `{number}` `x1` - 圆、圆弧上的端点 X
  *
- * - `{number}` `y1` - ��、圆弧上的端点 Y
+ * - `{number}` `y1` - 圆、圆弧上的端点 Y
  *
  * - `{number}` `x2` - 标注线尾部的端点 X
  *

package/package.json

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