@jlceda/pro-api-types 0.1.121 → 0.1.123

package/index.d.ts

@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
      * 关闭文档
      *
      * @public
-     * @remarks 如若文档尚未保存，执行此操作将会直接丢失所有未保存的数据，请在修改操作完成后首先执行 {@link SCH_Document.save}、{@link PCB_Document.save}、{@link PNL_Document.save} 保存数据
+     * @remarks 如若文档尚未保存，执行此操作将会直接丢失所���未保存的数据，请在修改操作完成后首先执行 {@link SCH_Document.save}、{@link PCB_Document.save}、{@link PNL_Document.save} 保存数据
      * @param tabId - 标签页 ID，此处支持 {@link IDMT_SchematicPageItem.uuid}、{@link IDMT_PcbItem.uuid}、{@link IDMT_PanelItem.uuid} 作为输入
      * @returns 操作是否成功
      */
@@ -410,7 +410,7 @@ declare class DMT_Project {
      *
      * @beta
      * @param projectFriendlyName - 工程友好名称
-     * @param projectName - 工程名称，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好���称自动生成
+     * @param projectName - 工程名称，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好名称自动生成
      * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
@@ -954,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"
-}
-
 /**
  * 文档飞线计算功能状态
  *
@@ -1184,7 +1164,7 @@ declare enum EPCB_LayerId {
     CUSTOM_30 = 100,
     /** 夹层（介电基板）1 */
     SUBSTRATE_1 = 101,
-    /** 孔层（焊���、过孔的内孔） */
+    /** 孔层（焊盘、过孔的内孔） */
     HOLE = 47,
     /** 元件外形层 */
     COMPONENT_SHAPE = 48,
@@ -1213,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"
 }
 
 /**
@@ -1653,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"
+}
+
 /**
  * 右侧面板标签页
  *
@@ -1925,7 +1925,7 @@ declare interface IDMT_PanelItem {
     readonly itemType: EDMT_ItemType.PANEL;
     /** 面板 UUID */
     uuid: string;
-    /** 面板名称 */
+    /** 面板��称 */
     name: string;
     /** 所属工程 UUID */
     parentProjectUuid: string;
@@ -4674,10 +4674,10 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：网络
+     * ��置属性状态：网络
      *
      * @beta
-     * @remarks 本接���仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
+     * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
      * @param net - 网络名称
      * @returns 焊盘图元对象
      */
@@ -4961,7 +4961,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     toSync(): IPCB_PrimitivePolyline;
     /**
-     * 查询图元是否为异步图元
+     * 查询图元是���为异步图元
      *
      * @public
      * @returns 是否为异步图元
@@ -5607,7 +5607,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      *
      * @beta
      * @param diameter - 外径
-     * @returns 过孔图元对象
+     * @returns 过孔图���对象
      */
     setState_Diameter(diameter: number): IPCB_PrimitiveVia;
     /**
@@ -6913,7 +6913,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
      *
      * @beta
      * @param y - 坐标 Y
-     * @returns 器件图元对象
+     * @returns 器件图元对���
      */
     setState_Y(y: number): ISCH_PrimitiveComponent_2;
     /**
@@ -7054,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 */
@@ -7690,7 +7690,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
      * 设置属性状态：填充样式
      *
      * @beta
-     * @param fillStyle - 填充样式
+     * @param fillStyle - 填���样式
      * @returns 矩形图元对象
      */
     setState_FillStyle(fillStyle: ESCH_PrimitiveFillStyle | null): ISCH_PrimitiveRectangle;
@@ -8305,8 +8305,8 @@ declare class LIB_Cbb {
      * 修改复用模块
      *
      * @beta
-     * @remarks 如希望清除某些属性，则将其的值设置为 `null`
-     * @param cbbUuid - 复��模块 UUID
+     * @remarks 如希望清除某��属性，则将其的值设置为 `null`
+     * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param cbbName - 复用模块名称
      * @param classification - 分类
@@ -8667,10 +8667,10 @@ declare class LIB_Footprint {
      */
     modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
     /**
-     * 更新封装的文档源码
+     * 更新封装��文档源码
      *
      * @beta
-     * @param footprintUuid - 封�� UUID
+     * @param footprintUuid - 封装 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param documentSource - 文档源码
      * @returns 是否更新成功
@@ -9385,7 +9385,7 @@ declare class PCB_Drc {
      */
     modifyDifferentialPairNegativeNet(differentialPairName: string, negativeNet: string): Promise<boolean>;
     /**
-     * 获取所���差分对的详细属性
+     * 获取所有差分对的详细属性
      *
      * @beta
      * @returns 所有差分对的详细属性
@@ -9660,7 +9660,7 @@ declare class PCB_Layer {
      * 修改图层属性
      *
      * @beta
-     * @remarks 仅内层和自定义层允许修改名称；仅内层允许修改类型
+     * @remarks 仅内层和自定义层允许修改名称；仅内层允许修改类型, 透明度仅支持0-100之间的数
      * @param layer - 层
      * @param property - 属性
      * @returns 修改后的图层属性，如若为 `undefined` 则代表修改失败或图层不存在
@@ -9771,7 +9771,7 @@ declare class PCB_ManufactureData {
      * @param fileName - 文件名
      * @param fileType - 文件类型
      * @param template - 模板名称
-     * @param filterOptions - 过滤规则，仅应包含需要启用的规则，`property` 为规则名称，`includeValue` 为匹配的值
+     * @param filterOptions - 过滤规则，仅应包含需要启用的规则，`property` 为规则名称，`includeValue` 为匹配的���
      * @param statistics - 统计，包含所有需要启用的统计项的名称
      * @param property - 属性，包含所有需要启用的属性的名称
      * @param columns - 列的属性及排序，`title`、`sort`、`group`、`orderWeight` 不传入则取默认值，`null` 代表 **无** 或 **空**
@@ -9800,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 文件
      *
@@ -10082,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>;
 }
 
 /**
@@ -10163,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>>;
     /**
      * 更新网表
      *
@@ -10171,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>;
 }
 
 /**
@@ -10346,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;
@@ -10357,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>;
     /**
      * 获取器件
@@ -10929,7 +10929,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
      * @beta
      * @param layer - 层
      * @param net - 网络名称
-     * @param primitiveLock - 是否���定
+     * @param primitiveLock - 是否锁定
      * @returns 焊盘图元对象数组
      */
     getAll(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePad>>;
@@ -11461,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>;
     /**
      * 元件下单
      *
@@ -11516,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>>;
     /**
      * 更新网表
      *
@@ -11524,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>;
 }
 
 /**
@@ -13624,7 +13624,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.121",
+	"version": "0.1.123",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [