@jlceda/pro-api-types 0.1.120 → 0.1.122

package/index.d.ts

@@ -589,7 +589,7 @@ declare class DMT_Schematic {
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页所关联的原理图的详细属性
-     * @returns 原理图的详细属性，如若为 `undefined` 则获取失败
+     * @returns 原理图���详细属性，如若为 `undefined` 则获取失败
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
@@ -763,8 +763,7 @@ declare class EDA {
     sch_PrimitiveArc: SCH_PrimitiveArc;
     sch_PrimitiveBus: SCH_PrimitiveBus;
     sch_PrimitiveCircle: SCH_PrimitiveCircle;
-    sch_PrimitiveComponent: SCH_PrimitiveComponent;
-    sch_PrimitiveComponent3: SCH_PrimitiveComponent3;
+    sch_PrimitiveComponent: SCH_PrimitiveComponent | SCH_PrimitiveComponent3;
     sch_PrimitivePin: SCH_PrimitivePin;
     sch_PrimitivePolygon: SCH_PrimitivePolygon;
     sch_PrimitiveRectangle: SCH_PrimitiveRectangle;
@@ -955,26 +954,6 @@ declare enum ELIB_SymbolType {
     SHORT_CIRCUIT_FLAG = 22
 }
 
-/**
- * 网表类型
- *
- * @public
- */
-declare enum ENetlistType {
-    /** Allegro */
-    ALLEGRO = "Allegro",
-    /** PADS */
-    PADS = "PADS",
-    /** Protel 2 */
-    PROTEL2 = "Protel2",
-    /** 嘉立创 EDA 专业版 */
-    JLCEDA_PRO = "JLCEDA",
-    /** EasyEDA Pro Edition */
-    EASYEDA_PRO = "EasyEDA",
-    /** Altium Designer */
-    ALTIUM_DESIGNER = "AltiumDesigner"
-}
-
 /**
  * 文档飞线计算功能状态
  *
@@ -1214,21 +1193,21 @@ declare enum EPCB_LayerId {
  */
 declare enum EPCB_LayerType {
     /** 信号层 */
-    SIGNAL = 1,
+    SIGNAL = "SIGNAL",
     /** 内电层 */
-    INTERNAL_ELECTRICAL = 2,
+    INTERNAL_ELECTRICAL = "PLANE",
     /** 丝印层 */
-    SILKSCREEN = 3,
+    SILKSCREEN = "SILKSCREEN",
     /** 阻焊层 */
-    SOLDER_MASK = 4,
+    SOLDER_MASK = "SOLDER_MASK",
     /** 锡膏（助焊）层 */
-    PASTE_MASK = 5,
+    PASTE_MASK = "PASTE_MASK",
     /** 装配层 */
-    ASSEMBLY = 6,
+    ASSEMBLY = "ASSEMBLY",
     /** 其它 */
-    OTHER = 7,
+    OTHER = "OTHER",
     /** 自定义层 */
-    CUSTOM = 8
+    CUSTOM = "CUSTOM"
 }
 
 /**
@@ -1596,20 +1575,7 @@ declare enum ESCH_PrimitiveType {
     /** 文本 */
     TEXT = "Text",
     /** 导线 */
-    WIRE = "Wire",
-    NETFLAG = "Netflag",
-    NETPORT = "Netport",
-    NO_CONNECT = "Noconnect",
-    PART = "Part",
-    SHORT_SYMBOL = "Short_symbol",
-    BLOCK_SYMBOL = "Block_symbol",
-    TABLE = "Table",
-    CELL = "Cell",
-    BUSENTRY = "BusEntry",
-    NONELECTRICAL_SYMBOL = "NonElectrical_symbol",
-    OBJ = "Obj",
-    JUNCTION = "Junction",
-    SHEET = "Sheet"
+    WIRE = "Wire"
 }
 
 /**
@@ -1667,6 +1633,26 @@ declare enum ESYS_LogType {
     /* Excluded from this release type: OPEN_PROJECT */
 }
 
+/**
+ * 网表类型
+ *
+ * @public
+ */
+declare enum ESYS_NetlistType {
+    /** Allegro */
+    ALLEGRO = "Allegro",
+    /** PADS */
+    PADS = "PADS",
+    /** Protel 2 */
+    PROTEL2 = "Protel2",
+    /** 嘉立创 EDA 专业版 */
+    JLCEDA_PRO = "JLCEDA",
+    /** EasyEDA Pro Edition */
+    EASYEDA_PRO = "EasyEDA",
+    /** Altium Designer */
+    ALTIUM_DESIGNER = "AltiumDesigner"
+}
+
 /**
  * 右侧面板标签页
  *
@@ -4397,7 +4383,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      * 设置属性状态：是否锁定
      *
      * @beta
-     * @param primitiveLock - 是否锁定
+     * @param primitiveLock - ���否锁定
      * @returns 二进制内嵌对象图元对象
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveObject;
@@ -4688,7 +4674,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：网络
+     * ���置属性状态：网络
      *
      * @beta
      * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
@@ -5756,7 +5742,7 @@ declare class ISCH_PrimitiveArc implements ISCH_Primitive {
     private referenceY;
     /** 终止点 X */
     private endX;
-    /** 终止点 Y */
+    /** 终止��� Y */
     private endY;
     /** 颜色 */
     private color;
@@ -6083,7 +6069,7 @@ declare class ISCH_PrimitiveBus implements ISCH_Primitive {
      */
     setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveBus;
     /**
-     * 将图元转��为异步图元
+     * 将图元转换为异步图元
      *
      * @public
      * @returns 总线图元对象
@@ -7068,7 +7054,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
      * 将对图元的更改应用到画布
      *
      * @beta
-     * @returns 器件图元对象
+     * @returns 器件图元对���
      */
     done(): Promise<ISCH_PrimitiveComponent_2>;
     /* Excluded from this release type: getAllPins */
@@ -8399,7 +8385,7 @@ declare class LIB_Classification {
      */
     createPrimary(libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationName: string): Promise<ILIB_ClassificationIndex | undefined>;
     /**
-     * 创建二��分类
+     * 创建二级分类
      *
      * @beta
      * @param libraryUuid - 库 UUID
@@ -9592,7 +9578,7 @@ declare class PCB_Layer {
      * 将层设置为不可见
      *
      * @beta
-     * @param layer - ���，如若不指定任何层则默认为所有层
+     * @param layer - 层，如若不指定任何层则默认为所有层
      * @param setOtherLayerVisible - 是否将其它层设置为可见
      * @returns 操作是否成功
      */
@@ -9674,7 +9660,7 @@ declare class PCB_Layer {
      * 修改图层属性
      *
      * @beta
-     * @remarks 仅内层和自定义层允许修改名称；仅内层允许修改类型
+     * @remarks 仅内层和自定义层允许修改名称；仅内层允许修改类型, 透明度仅支持0-100之间的数
      * @param layer - 层
      * @param property - 属性
      * @returns 修改后的图层属性，如若为 `undefined` 则代表修改失败或图层不存在
@@ -9814,7 +9800,7 @@ declare class PCB_ManufactureData {
      * @param netlistType - 网表类型
      * @returns 网表文件数据
      */
-    getNetlistFile(fileName?: string, netlistType?: ENetlistType): Promise<File | undefined>;
+    getNetlistFile(fileName?: string, netlistType?: ESYS_NetlistType): Promise<File | undefined>;
     /**
      * 获取 DXF 文件
      *
@@ -10096,7 +10082,7 @@ declare class PCB_MathPolygon {
      * @param inversion - 是否反相
      * @returns 复杂多边形对象
      */
-    convertImageToComplexPolygon(imageBlob: Blob, imageWidth: number, imageHeight: number, tolerance?: number, simplification?: number, smoothing?: number, despeckling?: number, inversion?: boolean): Promise<IPCB_ComplexPolygon | undefined>;
+    convertImageToComplexPolygon(imageBlob: Blob, imageWidth: number, imageHeight: number, tolerance?: number, simplification?: number, smoothing?: number, despeckling?: number, whiteAsBackgroundColor?: boolean, inversion?: boolean): Promise<IPCB_ComplexPolygon | undefined>;
 }
 
 /**
@@ -10177,7 +10163,7 @@ declare class PCB_Net {
      * @param type - 网表格式
      * @returns 网表数据，当 type 为 `JLCEDA` 或 `EasyEDA` 时，返回值为数组
      */
-    getNetlist(type?: ENetlistType): Promise<string | Array<string>>;
+    getNetlist(type?: ESYS_NetlistType): Promise<string | Array<string>>;
     /**
      * 更新网表
      *
@@ -10185,7 +10171,7 @@ declare class PCB_Net {
      * @param type - 网表格式
      * @param netlist - 网表数据
      */
-    setNetlist(type: ENetlistType | undefined, netlist: string): Promise<boolean>;
+    setNetlist(type: ESYS_NetlistType | undefined, netlist: string): Promise<boolean>;
 }
 
 /**
@@ -10360,9 +10346,6 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
         y?: number;
         rotation?: number;
         primitiveLock?: boolean;
-        attributes?: {
-            [key: string]: any;
-        };
         addIntoBom?: boolean;
         designator?: string | null;
         name?: string | null;
@@ -10371,6 +10354,9 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
         manufacturerId?: string | null;
         supplier?: string | null;
         supplierId?: string | null;
+        otherProperty?: {
+            [key: string]: any;
+        };
     }): Promise<IPCB_PrimitiveComponent | undefined>;
     /**
      * 获取器件
@@ -11475,7 +11461,7 @@ declare class SCH_ManufactureData {
      * @param netlistType - 网表类型
      * @returns 网表文件数据
      */
-    getNetlistFile(fileName?: string, netlistType?: ENetlistType): Promise<File | undefined>;
+    getNetlistFile(fileName?: string, netlistType?: ESYS_NetlistType): Promise<File | undefined>;
     /**
      * 元件下单
      *
@@ -11530,7 +11516,7 @@ declare class SCH_Netlist {
      * @param type - 网表格式
      * @returns 网表数据，当 type 为 `JLCEDA` 或 `EasyEDA` 时，返回值为数组
      */
-    getNetlist(type?: ENetlistType): Promise<string | Array<string>>;
+    getNetlist(type?: ESYS_NetlistType): Promise<string | Array<string>>;
     /**
      * 更新网表
      *
@@ -11538,7 +11524,7 @@ declare class SCH_Netlist {
      * @param type - 网表格式
      * @param netlist - 网表数据
      */
-    setNetlist(type: ENetlistType | undefined, netlist: string): Promise<void>;
+    setNetlist(type: ESYS_NetlistType | undefined, netlist: string): Promise<void>;
 }
 
 /**
@@ -11566,7 +11552,7 @@ declare class SCH_Primitive {
     getPrimitiveByPrimitiveId(id: string): Promise<ISCH_Primitive | undefined>;
     /* Excluded from this release type: getPrimitivesByPrimitiveId */
     /**
-     * 获取图��的 BBox
+     * 获取图元的 BBox
      *
      * @beta
      * @param primitiveIds - 图元 ID 数组或图元对象数组
@@ -11949,7 +11935,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @param direction - 端口方向
      * @param net - 网络名称
      * @param x - 坐标 X
-     * @param y - 坐��� Y
+     * @param y - 坐标 Y
      * @param rotation - 旋转角度
      * @param mirror - 是否镜像
      * @returns 器件图元对象
@@ -12323,7 +12309,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * @remarks
      * 本接口模拟前端点击放置按钮，指定的器件将绑定到当前鼠标，并在用户后续点击时放置于画布
      *
-     * 本接口的返回时机并不会等待用户的放置操作，一旦器件被绑定到��标，本接口将立即返回 `true` 的结果
+     * 本接口的返回时机并不会等待用户的放置操作，一旦器件被绑定到鼠标，本接口将立即返回 `true` 的结果
      * @param component - 关联库器件
      * @returns 是否找到器件
      */
@@ -12521,7 +12507,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 删除矩形
      *
      * @public
-     * @param primitiveIds - 矩形的图元 ID 或矩形图元对象
+     * @param primitiveIds - 矩形的图元 ID 或矩形���元对象
      * @returns 删除操作是否成功
      */
     delete(primitiveIds: string | ISCH_PrimitiveRectangle | Array<string> | Array<ISCH_PrimitiveRectangle>): Promise<boolean>;
@@ -13600,7 +13586,7 @@ declare class SYS_ShortcutKey {
      * @param callbackFn - 回调函数
      * @returns 注册操作是否成功
      */
-    registerShortcutKey(shortcutKey: TShortcutKeys, title: string, callbackFn: (shortcutKey: TShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;
+    registerShortcutKey(shortcutKey: TSYS_ShortcutKeys, title: string, callbackFn: (shortcutKey: TSYS_ShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;
     /**
      * 反注册快捷键
      *
@@ -13608,7 +13594,7 @@ declare class SYS_ShortcutKey {
      * @param shortcutKey - 快捷键，不区分传入的排列顺序，将自动排序并查询匹配的快捷键
      * @returns 反注册操作是否成功
      */
-    unregisterShortcutKey(shortcutKey: TShortcutKeys): Promise<boolean>;
+    unregisterShortcutKey(shortcutKey: TSYS_ShortcutKeys): Promise<boolean>;
     /**
      * 查询快捷键列表
      *
@@ -13617,7 +13603,7 @@ declare class SYS_ShortcutKey {
      * @returns 快捷键列表
      */
     getShortcutKeys(includeSystem?: boolean): Promise<Array<{
-        shortcutKey: TShortcutKeys;
+        shortcutKey: TSYS_ShortcutKeys;
         title: string;
         documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType>;
         scene: Array<ESYS_ShortcutKeyEffectiveEditorScene>;
@@ -14263,6 +14249,6 @@ declare type TPCB_PrimitiveSpecialPadShape = Array<[number, number, TPCB_Primiti
  *
  * @public
  */
-declare type TShortcutKeys = Array<'SHIFT' | 'LEFT_SHIFT' | 'RIGHT_SHIFT' | 'FN' | 'ALT' | 'LEFT_ALT' | 'RIGHT_ALT' | 'CONTROL' | 'LEFT_CONTROL' | 'RIGHT_CONTROL' | 'COMMAND' | 'WIN' | 'OPTION' | 'SUPER' | 'TAB' | 'SPACE' | 'UP' | 'DOWN' | 'LEFT' | 'RIGHT' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'F13' | 'F14' | 'F15' | 'F16' | 'F17' | 'F18' | 'F19' | 'F20' | '`' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '0' | '-' | '=' | 'Q' | 'W' | 'E' | 'R' | 'T' | 'Y' | 'U' | 'I' | 'O' | 'P' | '[' | ']' | 'A' | 'S' | 'D' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | ';' | "'" | '\\' | 'Z' | 'X' | 'C' | 'V' | 'B' | 'N' | 'M' | ',' | '.' | '/'>;
+declare type TSYS_ShortcutKeys = Array<'SHIFT' | 'LEFT_SHIFT' | 'RIGHT_SHIFT' | 'FN' | 'ALT' | 'LEFT_ALT' | 'RIGHT_ALT' | 'CONTROL' | 'LEFT_CONTROL' | 'RIGHT_CONTROL' | 'COMMAND' | 'WIN' | 'OPTION' | 'SUPER' | 'TAB' | 'SPACE' | 'UP' | 'DOWN' | 'LEFT' | 'RIGHT' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'F13' | 'F14' | 'F15' | 'F16' | 'F17' | 'F18' | 'F19' | 'F20' | '`' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '0' | '-' | '=' | 'Q' | 'W' | 'E' | 'R' | 'T' | 'Y' | 'U' | 'I' | 'O' | 'P' | '[' | ']' | 'A' | 'S' | 'D' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | ';' | "'" | '\\' | 'Z' | 'X' | 'C' | 'V' | 'B' | 'N' | 'M' | ',' | '.' | '/'>;
 
 

package/package.json

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