@jlceda/pro-api-types 0.1.109 → 0.1.111

package/index.d.ts

@@ -180,6 +180,11 @@ declare class DMT_EditorControl {
      * @returns 操作是否成功
      */
     mergeAllDocumentFromSplitScreen(): Promise<boolean>;
+    /* Excluded from this release type: getCurrentRenderedAreaImage */
+    /* Excluded from this release type: zoomToRegion */
+    /* Excluded from this release type: zoomTo */
+    /* Excluded from this release type: zoomToAllPrimitives */
+    /* Excluded from this release type: zoomToSelectedPrimitives */
 }
 
 /**
@@ -196,7 +201,7 @@ declare class DMT_Folder {
      * @param teamUuid - 团队 UUID
      * @param parentFolderUuid - 父文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 文件夹描述
-     * @returns 文���夹 UUID，如若为 `undefined` 则创建失败
+     * @returns 文件夹 UUID，如若为 `undefined` 则创建失败
      */
     createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
     /**
@@ -311,7 +316,7 @@ declare class DMT_Panel {
      *
      * @public
      * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
-     * @returns 面板���详细属性，如若为 `undefined` 则获取失败
+     * @returns 面板的详细属性，如若为 `undefined` 则获取失败
      */
     getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
     /**
@@ -413,11 +418,11 @@ 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 - 工程描述
-     * @param collaborationMode - 工程协作���式，如若团队权限无需工程设置协作模式，则该参数将被忽略
+     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
      * @returns 工程 UUID，如若为 `undefined` 则创建失败
      */
     createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -987,6 +992,20 @@ declare enum EPCB_DocumentRatlineCalculatingActiveStatus {
     INACTIVE = "inactive"
 }
 
+/**
+ * 非激活层展示模式
+ *
+ * @public
+ */
+declare enum EPCB_InactiveLayerDisplayMode {
+    /** 正常亮度 */
+    NORMAL_BRIGHTNESS = 0,
+    /** 置灰 */
+    TURN_GRAY = 1,
+    /** 隐藏 */
+    HIDE = 2
+}
+
 /**
  * 图层颜色配置
  *
@@ -1167,7 +1186,7 @@ declare enum EPCB_LayerId {
     CUSTOM_28 = 98,
     /** 自定义层 29 */
     CUSTOM_29 = 99,
-    /** 自定义层 30 */
+    /** ���定义层 30 */
     CUSTOM_30 = 100,
     /** 夹层（介电基板）1 */
     SUBSTRATE_1 = 101,
@@ -1899,7 +1918,7 @@ declare interface IDMT_ProjectItem extends IDMT_BriefProjectItem {
     description?: string;
     /** 工程内文档数据 */
     data: Array<IDMT_BoardItem | IDMT_SchematicItem | IDMT_PcbItem | IDMT_PanelItem>;
-    /** 工程协作模式 */
+    /** 工��协作模式 */
     collaborationMode?: EDMT_ProjectCollaborationMode;
 }
 
@@ -2415,7 +2434,7 @@ declare class IPCB_ComplexPolygon {
      */
     getSource(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;
     /**
-     * 获取复杂多边形数据
+     * 获��复杂多边形数据
      *
      * @public
      * @remarks 强制返回复杂多边形格式数据，即使它仅包含单一的单多边形
@@ -2449,6 +2468,8 @@ declare interface IPCB_EqualLengthNetGroupItem {
     name: string;
     /** 网络名称数组 */
     nets: Array<string>;
+    /** 等长网络组颜色 */
+    color: string | null;
 }
 
 /**
@@ -2479,6 +2500,22 @@ declare interface IPCB_NetClassItem {
     name: string;
     /** 网络名称数组 */
     nets: Array<string>;
+    /** 网络类颜色 */
+    color: string | null;
+}
+
+/**
+ * 网络属性
+ *
+ * @public
+ */
+declare interface IPCB_NetInfo {
+    /** 网络名称 */
+    net: string;
+    /** 颜色 */
+    color: string | null;
+    /** 长度 */
+    length: number;
 }
 
 /**
@@ -4028,7 +4065,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
     private width;
     /** 高 */
     private height;
-    /** 旋转角度 */
+    /** 旋���角度 */
     private rotation;
     /** 是否水平镜像 */
     private mirror;
@@ -4067,7 +4104,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      */
     getState_TopLeftX(): number | undefined;
     /**
-     * 获取属性状态：左上�� Y
+     * 获取属性状态：左上点 Y
      *
      * @public
      * @returns 左上点 Y
@@ -4476,7 +4513,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Rotation(rotation: number): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：焊盘外形
+     * 设置属性状��：焊盘外形
      *
      * @beta
      * @remarks
@@ -4601,7 +4638,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     toAsync(): IPCB_PrimitivePad;
     /**
-     * 将图元转换为同步图元
+     * ���图元转换为同步图元
      *
      * @public
      * @returns 焊盘图元对象
@@ -7063,7 +7100,7 @@ declare class LIB_Device {
      * 私有化部署环境暂无法使用本接口
      * @param lcscIds - 立创 C 编号
      * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个结果
+     * @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个���果
      * @returns 搜索到的器件属性
      */
     getByLcscIds<T extends boolean>(lcscIds: string, libraryUuid?: string, allowMultiMatch?: T): Promise<T extends true ? ILIB_DeviceSearchItem | undefined : Array<ILIB_DeviceSearchItem>>;
@@ -7124,7 +7161,16 @@ declare class LIB_Footprint {
      * @returns 操作是否成功
      */
     modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
-    /* Excluded from this release type: updateDocumentSource */
+    /**
+     * 更新封装的文档源码
+     *
+     * @beta
+     * @param footprintUuid - 封装 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(footprintUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取封装的所有属性
      *
@@ -7174,7 +7220,7 @@ declare class LIB_Footprint {
  * 综合库 / 库列表类
  *
  * @public
- * @remarks 此处所有���口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
+ * @remarks 此处所有接口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
  */
 declare class LIB_LibrariesList {
     /**
@@ -7342,7 +7388,16 @@ declare class LIB_Symbol {
      * @returns 操作是否成功
      */
     modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
-    /* Excluded from this release type: updateDocumentSource */
+    /**
+     * 更新符号的文档源码
+     *
+     * @beta
+     * @param symbolUuid - 符号 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(symbolUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取符号的所有属性
      *
@@ -7365,7 +7420,7 @@ declare class LIB_Symbol {
      */
     copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newSymbolName?: string): Promise<string | undefined>;
     /**
-     * 搜索���号
+     * 搜索符号
      *
      * @beta
      * @param key - 搜索关键字
@@ -7553,6 +7608,7 @@ declare class PCB_Document {
     /* Excluded from this release type: navigateToRegion */
     /* Excluded from this release type: getPrimitiveAtPoint */
     /* Excluded from this release type: getPrimitivesInRegion */
+    /* Excluded from this release type: zoomToBoardOutline */
 }
 
 /**
@@ -7568,7 +7624,7 @@ declare class PCB_Drc {
      * @public
      * @param strict - 是否严格检查，严格检查时存在 Warning 将返回 `false`，否则返回 `true`
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
-     * @returns DRC ���查是否无错误
+     * @returns DRC 检查是否无错误
      */
     check(strict?: boolean, userInterface?: boolean): Promise<boolean>;
     /**
@@ -7668,7 +7724,7 @@ declare class PCB_Drc {
      * 覆写网络规则
      *
      * @beta
-     * @remarks 将会覆写当前 PCB 的所有网络规则，请注意数据丢失��险
+     * @remarks 将会覆写当前 PCB 的所有网络规则，请注意数据丢失风险
      * @param netRules - 网络规则
      * @returns 覆写是否成功
      */
@@ -7721,9 +7777,10 @@ declare class PCB_Drc {
      * @beta
      * @param netClassName - 网络类名称
      * @param nets - 网络名称数组
+     * @param color - 网络类颜色
      * @returns 操作是否成功
      */
-    createNetClass(netClassName: string, nets: Array<string>): Promise<boolean>;
+    createNetClass(netClassName: string, nets: Array<string>, color?: string | null): Promise<boolean>;
     /**
      * 删除网络类
      *
@@ -7824,9 +7881,10 @@ declare class PCB_Drc {
      * @beta
      * @param equalLengthNetGroupName - 等长网络组名称
      * @param nets - 网络名称数组
+     * @param color - 等长网络组颜色
      * @returns 操作是否成功
      */
-    createEqualLengthNetGroup(equalLengthNetGroupName: string, nets: Array<string>): Promise<boolean>;
+    createEqualLengthNetGroup(equalLengthNetGroupName: string, nets: Array<string>, color?: string | null): Promise<boolean>;
     /**
      * 删除等长网络组
      *
@@ -8034,7 +8092,7 @@ declare class PCB_Layer {
      * 设置非激活层透明度
      *
      * @beta
-     * @param transparency - 透明度
+     * @param transparency - 透明度，范围 `0-100`
      * @returns 操作是否成功
      */
     setInactiveLayerTransparency(transparency: number): Promise<boolean>;
@@ -8092,6 +8150,7 @@ declare class PCB_Layer {
      * @returns 所有图层的详细属性
      */
     getAllLayers(): Promise<Array<IPCB_LayerItem>>;
+    /* Excluded from this release type: setInactiveLayerDisplayMode */
 }
 
 /**
@@ -8489,21 +8548,33 @@ declare class PCB_MathPolygon {
  * @public
  */
 declare class PCB_Net {
+    /* Excluded from this release type: getAllNets */
+    /* Excluded from this release type: getNet */
     /**
      * 获取所有网络的网络名称
      *
-     * @beta
+     * @public
+     * @returns 网络名称数组
+     */
+    getAllNetsName(): Promise<Array<string>>;
+    /**
+     * 获取所有网络的网络名称
+     *
+     * @public
+     * @deprecated 请使用 {@link PCB_Net.getAllNetsName | getAllNetsName} 替代
      * @returns 网络名称数组
      */
     getAllNetName(): Promise<Array<string>>;
     /**
      * 获取指定网络的长度
      *
-     * @beta
+     * @public
      * @param net - 网络名称
      * @returns 网络长度，`undefined` 为不存在该网络，`0` 为网络无长度
      */
     getNetLength(net: string): Promise<number | undefined>;
+    /* Excluded from this release type: getNetColor */
+    /* Excluded from this release type: setNetColor */
     /**
      * 获取关联指定网络的所有图元
      *
@@ -8545,7 +8616,7 @@ declare class PCB_Net {
     /**
      * 获取网表
      *
-     * @beta
+     * @public
      * @param type - 网表格式
      * @returns 网表数据，当 type 为 `JLCEDA` 或 `EasyEDA` 时，返回值为数组
      */
@@ -8553,7 +8624,7 @@ declare class PCB_Net {
     /**
      * 更新网表
      *
-     * @beta
+     * @public
      * @param type - 网表格式
      * @param netlist - 网表数据
      */
@@ -8929,7 +9000,7 @@ declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 填充的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 填充图元对象，空数组表示获取失败
+     * @returns 填充图元对象，空��组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
     /**
@@ -9100,7 +9171,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * 获取直线
      *
      * @beta
-     * @remarks 如若��入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 直线图元对象，空数组表示获取失败
      */
@@ -9936,7 +10007,19 @@ declare class SCH_Primitive {
      */
     getPrimitiveByPrimitiveId(id: string): Promise<ISCH_Primitive | undefined>;
     /* Excluded from this release type: getPrimitivesByPrimitiveId */
-    /* Excluded from this release type: getPrimitivesBBox */
+    /**
+     * 获取图元的 BBox
+     *
+     * @beta
+     * @param primitiveIds - 图元 ID 数组或图元对象数组
+     * @returns 图元的 BBox，如若图元不存在或没有 BBox，将会返回 `undefined` 的结果
+     */
+    getPrimitivesBBox(primitiveIds: Array<string | ISCH_Primitive>): Promise<{
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+    } | undefined>;
 }
 
 /**
@@ -10024,7 +10107,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param busName - 总线名称
-     * @param line - 多段线坐标组，每段都是连续的��组 `[x1, y1, x2, y2, x3, y3]` 所描述的线，如若多段线彼此无任何连接则创建将会失败
+     * @param line - 多段线坐标组，每段都是连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线，如若多段线彼此无任何连接则创建将会失败
      * @param color - 总线颜色，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
@@ -10319,7 +10402,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @param uniqueId - 唯一 ID，`null` 表示留空
      * @param manufacturer - 制造商，`null` 表示留空
      * @param manufacturerId - 制造商编号，`null` 表示留空
-     * @param supplier - 供应商，`null` 表示留空
+     * @param supplier - 供应���，`null` 表示留空
      * @param supplierId - 供应商编号，`null` 表示留空
      * @returns 器件图元对象
      */
@@ -11463,7 +11546,7 @@ declare class SYS_PanelControl {
      */
     openRightPanel(tab?: ESYS_RightPanelTab): void;
     /**
-     * 关闭右侧面板
+     * 关闭���侧面板
      *
      * @public
      */
@@ -11690,7 +11773,7 @@ declare class SYS_Timer {
  */
 declare class SYS_ToastMessage {
     /**
-     * 显��吐司消息
+     * 显示吐司消息
      *
      * @public
      * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代

package/package.json

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