@jlceda/pro-api-types 0.1.130 → 0.1.132

package/index.d.ts

@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
      *
      * @beta
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param libraryType - ���类型，支持符号和封装
+     * @param libraryType - ��类型，支持符号和封装
      * @param uuid - 符号、封装 UUID
      * @param splitScreenId - 分屏 ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
      * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
@@ -248,8 +248,31 @@ declare class DMT_EditorControl {
         top: number;
         bottom: number;
     } | false>;
-    /* Excluded from this release type: generateIndicatorMarkers */
-    /* Excluded from this release type: removeIndicatorMarkers */
+    /**
+     * 生成指示标记
+     *
+     * @beta
+     * @remarks 指示标记外形数据中，原理图、符号画布坐标单位跨度为 0.01inch，PCB、封装画布坐标单位跨度为 mil
+     * @param markers - 指示标记外形对象数组
+     * @param color - 指示标记颜色
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 指示标记生成是否成功，`false` 表示画布不支持该操作或 `tabId` 不存在
+     */
+    generateIndicatorMarkers(markers: Array<IDMT_IndicatorMarkerShape>, color?: {
+        r: number;
+        g: number;
+        b: number;
+        alpha: number;
+    }, tabId?: string): Promise<boolean>;
+    /**
+     * 移除指示标记
+     *
+     * @beta
+     * @remarks 本接口会移除所有已生成的指示标记
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 指示标记移除是否成功，`false` 表示画布不支持该操作或 `tabId` 不存在
+     */
+    removeIndicatorMarkers(tabId?: string): Promise<boolean>;
 }
 
 /**
@@ -456,7 +479,7 @@ declare class DMT_Pcb {
      * 删除 PCB
      *
      * @public
-     * @remarks 如若 PCB 已关联复用模块（在工程库内存在同名的复用模块符号），则删除 PCB 时将同步删除关联的原理图和复用模块符号，复用模块符号不可删除则跳过
+     * @remarks 如若 PCB 已关联复用模块（在工程库内存在同名的复用模块符号），则删除 PCB 时将同步删除关联的原��图和复用模块符号，复用模块符号不可删除则跳过
      * @param pcbUuid - PCB UUID
      * @returns 操作是否成功
      */
@@ -823,6 +846,7 @@ declare class EDA {
     pcb_PrimitivePad: PCB_PrimitivePad;
     pcb_PrimitivePolyline: PCB_PrimitivePolyline;
     pcb_PrimitivePour: PCB_PrimitivePour;
+    pcb_PrimitivePoured: PCB_PrimitivePoured;
     pcb_PrimitiveRegion: PCB_PrimitiveRegion;
     pcb_PrimitiveVia: PCB_PrimitiveVia;
     pcb_SelectControl: PCB_SelectControl;
@@ -1426,6 +1450,18 @@ declare enum EPCB_PrimitivePadShapeType {
     POLYLINE_COMPLEX_POLYGON = "POLYGON"
 }
 
+/**
+ * 焊盘类型
+ *
+ * @public
+ */
+declare enum EPCB_PrimitivePadType {
+    /** 焊盘 */
+    NORMAL = "NORMAL",
+    /** 测试点 */
+    TEST = "TEST"
+}
+
 /**
  * 覆铜填充方法
  *
@@ -1494,7 +1530,9 @@ declare enum EPCB_PrimitiveType {
     /** 图像 */
     IMAGE = "Image",
     /** 二进制内嵌对象 */
-    OBJECT = "Object"
+    OBJECT = "Object",
+    /** 覆铜填充 */
+    POURED = "Poured"
 }
 
 /**
@@ -2038,14 +2076,6 @@ declare interface IDMT_IndicatorMarkerShape {
      * 线段 | 圆弧：起始点 Y
      */
     startY?: number;
-    /**
-     * 圆弧：参考点 X
-     */
-    referenceX?: number;
-    /**
-     * 圆弧：参考点 Y
-     */
-    referenceY?: number;
     /**
      * 线段 | 圆弧：终止点 X
      */
@@ -2070,6 +2100,10 @@ declare interface IDMT_IndicatorMarkerShape {
      * 矩形：右 X
      */
     right?: number;
+    /**
+     * 圆弧：角度
+     */
+    angle?: number;
 }
 
 /**
@@ -2996,7 +3030,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      */
     getState_PrimitiveLock(): boolean;
     /**
-     * 设置属性状态：网络名称
+     * 设置属性��态：网络名称
      *
      * @beta
      * @param net - 网络名称
@@ -4627,6 +4661,8 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
     protected heatWelding: IPCB_PrimitivePadHeatWelding | null;
     /** 是否锁定 */
     protected primitiveLock: boolean;
+    /** 焊盘类型 */
+    protected padType: EPCB_PrimitivePadType;
     /* Excluded from this release type: __constructor */
     /**
      * 在 PCB 画布中创建图元
@@ -4643,7 +4679,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_PrimitiveType(): EPCB_PrimitiveType;
     /**
-     * 获取属性状态���图元 ID
+     * 获取属性状态：图元 ID
      *
      * @public
      * @returns 图元 ID
@@ -4768,6 +4804,13 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * @returns 是否锁定
      */
     getState_PrimitiveLock(): boolean;
+    /**
+     * 获取属性状态：焊盘类型
+     *
+     * @public
+     * @returns 焊盘类型
+     */
+    getState_PadType(): EPCB_PrimitivePadType;
     /**
      * 设置属性状态：层
      *
@@ -4970,6 +5013,14 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * @returns 尺寸标注图元对象
      */
     done(): Promise<IPCB_PrimitivePad>;
+    /**
+     * 设置属性状态：焊盘类型
+     *
+     * @beta
+     * @param padType - 焊盘类型
+     * @returns 焊盘图元对象
+     */
+    private setState_PadType;
 }
 
 /**
@@ -5377,6 +5428,8 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * @returns 覆铜边框图元对象
      */
     done(): Promise<IPCB_PrimitivePour>;
+    /* Excluded from this release type: getCopperRegion */
+    /* Excluded from this release type: rebuildCopperRegion */
     /**
      * 转换到：填充图元(默认是填充区域)
      *
@@ -5400,6 +5453,77 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
     convertToRegion(): Promise<IPCB_PrimitiveRegion>;
 }
 
+/**
+ * 覆铜填充图元
+ *
+ * @public
+ */
+declare class IPCB_PrimitivePoured implements IPCB_Primitive {
+    /** 异步 */
+    private async;
+    /** 图元类型 */
+    private readonly primitiveType;
+    /** 覆铜边框图元 ID */
+    private pourPrimitiveId;
+    /** 覆铜填充区域 */
+    private pourFills;
+    /** 图元 ID */
+    private primitiveId;
+    /* Excluded from this release type: __constructor */
+    /* Excluded from this release type: create */
+    /**
+     * 获取属性状态：图元类型
+     *
+     * @public
+     * @returns 图元类型
+     */
+    getState_PrimitiveType(): EPCB_PrimitiveType;
+    /**
+     * 获取属性状态：图元 ID
+     *
+     * @public
+     * @returns 图元 ID
+     */
+    getState_PrimitiveId(): string;
+    /**
+     * 获取属性状态：覆铜边框图元 ID
+     *
+     * @public
+     * @returns 覆铜边框图元 ID
+     */
+    getState_PourPrimitiveId(): string;
+    /**
+     * 获取属性状态：覆铜填充区域
+     *
+     * @public
+     * @returns 覆铜填充区域
+     */
+    getState_PourFills(): Array<IPCB_PrimitivePouredPourFill>;
+    /* Excluded from this release type: toAsync */
+    /* Excluded from this release type: toSync */
+    /* Excluded from this release type: isAsync */
+    /* Excluded from this release type: reset */
+    /* Excluded from this release type: done */
+    /* Excluded from this release type: convertToFill */
+    /* Excluded from this release type: addSolderMaskFill */
+}
+
+/**
+ * 覆铜填充区域
+ *
+ * @public
+ */
+declare interface IPCB_PrimitivePouredPourFill {
+    /** 复杂多边形 */
+    path: IPCB_ComplexPolygon;
+    /** 线宽 */
+    lineWidth: number;
+    /** 是否填充 */
+    fill: boolean;
+    /** ID */
+    id: string;
+}
+
 /**
  * 区域图元
  *
@@ -8141,7 +8265,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
 }
 
 /**
- * 导线图元
+ * 导��图元
  *
  * @public
  */
@@ -10169,7 +10293,7 @@ declare class PCB_ManufactureData {
      * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
      * 即 `ignoreWarning` 参数将被忽略；
      *
-     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行���默检查，
+     * 如若���用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
      * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
      * @param ignoreWarning - 在非交互式检查时忽略警告
      *
@@ -10556,7 +10680,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      *
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
-     * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组��如若为数组，则返回的也是数组
+     * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 器件图元对象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveComponent>>;
@@ -10965,7 +11089,7 @@ declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
      * @beta
      * @param primitiveId - 图元 ID
      * @param property - 修改参数
-     * @returns 二进制��嵌对象图元对象，`undefined` 表示修改失败
+     * @returns 二进制内嵌对象图元对象，`undefined` 表示修改失败
      */
     modify(primitiveId: string | IPCB_PrimitiveObject, property: {
         layer?: TPCB_LayersOfObject;
@@ -11043,9 +11167,10 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
      * @param solderMaskAndPasteMaskExpansion - 阻焊/助焊扩展，`null` 表示遵循规则
      * @param heatWelding - 热焊优化参数
      * @param primitiveLock - 是否锁定
+     * @param padType - 焊盘类型
      * @returns 焊盘图元对象
      */
-    create(layer: TPCB_LayersOfPad, padNumber: string, x: number, y: number, rotation?: number, pad?: TPCB_PrimitivePadShape, net?: string, hole?: TPCB_PrimitivePadHole | null, holeOffsetX?: number, holeOffsetY?: number, holeRotation?: number, metallization?: boolean, padFunction?: EPCB_PrimitivePadFunction, specialPad?: TPCB_PrimitiveSpecialPadShape, solderMaskAndPasteMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null, heatWelding?: IPCB_PrimitivePadHeatWelding | null, primitiveLock?: boolean): Promise<IPCB_PrimitivePad | undefined>;
+    create(layer: TPCB_LayersOfPad, padNumber: string, x: number, y: number, rotation?: number, pad?: TPCB_PrimitivePadShape, net?: string, hole?: TPCB_PrimitivePadHole | null, holeOffsetX?: number, holeOffsetY?: number, holeRotation?: number, metallization?: boolean, padFunction?: EPCB_PrimitivePadFunction, specialPad?: TPCB_PrimitiveSpecialPadShape, solderMaskAndPasteMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null, heatWelding?: IPCB_PrimitivePadHeatWelding | null, primitiveLock?: boolean, padType?: EPCB_PrimitivePadType): Promise<IPCB_PrimitivePad | undefined>;
     /**
      * 删除焊盘
      *
@@ -11107,7 +11232,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
      * @param primitiveLock - 是否锁定
      * @returns 焊盘的图元 ID 数组
      */
-    getAllPrimitiveId(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean): Promise<Array<string>>;
+    getAllPrimitiveId(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean, padType?: EPCB_PrimitivePadType): Promise<Array<string>>;
     /**
      * 获取所有焊盘
      *
@@ -11117,7 +11242,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
      * @param primitiveLock - 是否锁定
      * @returns 焊盘图元对象数组
      */
-    getAll(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePad>>;
+    getAll(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean, padType?: EPCB_PrimitivePadType): Promise<Array<IPCB_PrimitivePad>>;
 }
 
 /**
@@ -11288,6 +11413,21 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
     getAll(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePour>>;
 }
 
+/**
+ * PCB & 封装 / 覆铜填充图元类
+ *
+ * @public
+ */
+declare class PCB_PrimitivePoured 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 */
+}
+
 /**
  * PCB & 封装 / 禁止区域和约束区域图元类
  *
@@ -12243,7 +12383,13 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
         libraryUuid: string;
         uuid: string;
     } | ILIB_DeviceItem, subPartName?: string): Promise<boolean>;
-    /* Excluded from this release type: getAllPropertyNames */
+    /**
+     * 获取所有器件的所有属性名称集合
+     *
+     * @beta
+     * @returns 所有器件的所有属性名称集合
+     */
+    getAllPropertyNames(): Promise<string[]>;
     /* Excluded from this release type: getComponentDetail */
     /* Excluded from this release type: checkComponentType */
 }
@@ -12847,7 +12993,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param line - 多段线坐标组，每段都是连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线，如若多段线彼此无任何连接则创建将会失败
-     * @param net - 网络名称，如若未指定，则���循：
+     * @param net - 网络名称，如若未指定，则遵循：
      * 1. 没有坐标落在任何图元上，则默认为空网络；
      * 2. 有一个坐标点在某个网络的图元上，则跟随该图元的网络；
      * 3. 有多个坐标点在多个不同网络的图元上，则创建失败

package/package.json

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