@jlceda/pro-api-types 0.1.172 → 0.1.174

package/index.d.ts

@@ -1876,7 +1876,9 @@ declare enum ESYS_NetlistType {
     /** EasyEDA Pro Edition */
     EASYEDA_PRO = "EasyEDA",
     /** Altium Designer */
-    ALTIUM_DESIGNER = "Protel2"
+    ALTIUM_DESIGNER = "Protel2",
+    /** 数字化工业软件联盟 */
+    DISA = "DISA"
 }
 
 /**
@@ -2096,6 +2098,8 @@ declare interface IDMT_EditorDocumentItem {
     documentType: EDMT_EditorDocumentType;
     /** 文档 UUID */
     uuid: string;
+    /** 文档的标签页 ID */
+    tabId: string;
     /** 文档所属工程 UUID */
     parentProjectUuid?: string;
     /** 库文档所属库 UUID */
@@ -3067,10 +3071,16 @@ declare interface ILIB_SymbolSearchItem {
  * @public
  */
 declare interface IPCB_BomPropertiesTableColumns {
+    /** 属性 */
     property: string;
+    /** 显示名称 */
     title?: string;
+    /** 排序规则 */
     sort?: null | 'asc' | 'desc';
+    /** 是否分组 */
     group?: null | 'Yes' | 'No';
+    /** 排列权重（大权重优先在 BOM 的左侧） */
+    orderWeight?: number;
 }
 
 /**
@@ -3480,7 +3490,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      * 设置属性状态：是否锁定
      *
      * @beta
-     * @param primitiveLock - ��否锁定
+     * @param primitiveLock - 是否锁定
      * @returns 圆弧线图元对象
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveArc;
@@ -4127,7 +4137,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveComponent;
     /**
-     * 设置属性状态：是否加入 BOM
+     * 设置属性状��：是否加入 BOM
      *
      * @beta
      * @param addIntoBom - 是否加入 BOM
@@ -4138,7 +4148,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      * 设置属性状态：位号
      *
      * @beta
-     * @param designator - 位��
+     * @param designator - 位号
      * @returns 器件图元对象
      */
     setState_Designator(designator: string | undefined): IPCB_PrimitiveComponent;
@@ -5982,7 +5992,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      */
     getState_PourFillMethod(): any;
     /**
-     * 获取属性状态：是否保留孤岛
+     * 获取属性��态：是否保留孤岛
      *
      * @public
      * @returns 是否保留孤岛
@@ -6616,7 +6626,7 @@ declare class IPCB_PrimitiveString implements IPCB_Primitive {
      */
     setState_Text(text: string): IPCB_PrimitiveString;
     /**
-     * 设置属性状态：字体
+     * 设置���性状态：字体
      *
      * @beta
      * @param fontFamily - 字体
@@ -7927,7 +7937,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      * 设置属性状态：其它参数
      *
      * @beta
-     * @param otherProperty - 其它参���
+     * @param otherProperty - 其它参数
      * @returns 器件图元对象
      */
     setState_OtherProperty(otherProperty: {
@@ -8528,7 +8538,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
      * 设置属性状态：引脚编号
      *
      * @beta
-     * @param pinNumber - 引脚编���
+     * @param pinNumber - 引脚编号
      * @returns 引脚图元对象
      */
     setState_PinNumber(pinNumber: string): ISCH_PrimitivePin;
@@ -9197,7 +9207,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      */
     setState_TextColor(textColor: string | null): ISCH_PrimitiveText;
     /**
-     * 设置属性状态：字体名称
+     * 设置属��状态：字体名称
      *
      * @beta
      * @param fontName - 字体名称
@@ -9208,7 +9218,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      * 设置属性状态：字体大小
      *
      * @beta
-     * @param fontSize - 字体��小
+     * @param fontSize - 字体大小
      * @returns 文本图元对象
      */
     setState_FontSize(fontSize: number | null): ISCH_PrimitiveText;
@@ -9764,7 +9774,7 @@ declare class LIB_Cbb {
      * 在编辑器打开复用模块工程
      *
      * @beta
-     * @remarks 本操作将会在 EDA 前端打开模块工程，如若原先已打开其它工程且��未保存的变更，执行本操作将直接丢失所有未保存的数据
+     * @remarks 本操作将会在 EDA 前端打开模块工程，如若原先已打开其它工程且有未保存的变更，执行本操作将直接丢失所有未保存的数据
      * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      */
@@ -10515,7 +10525,7 @@ declare class PCB_Document {
      * @remarks
      * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
      *
-     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
+     * 例如：���入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
      * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
      *
      * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
@@ -10925,7 +10935,7 @@ declare class PCB_Drc {
      * @param padPair - 焊盘对
      * @returns 操作是否成功
      * @example 有三种不同的用法，确保画布上已有对应的焊盘。 分别是 一，游离焊盘-游离焊盘；二，器件焊盘 - 器件焊盘；三，器件焊盘 - 游离焊盘
-     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离焊盘
+     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离��盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','R1:2']) // 器件焊盘 - 器件焊盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','e1']) // 器件焊盘 - 游离焊盘
      */
@@ -13688,7 +13698,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * @param mirror - 是否镜像
      * @param addIntoBom - 是否加入 BOM
      * @param addIntoPcb - 是否转到 PCB
-     * @returns 器件图元对象
+     * @returns 器件图���对象
      */
     create(component: {
         libraryUuid: string;
@@ -14066,7 +14076,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它���元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象，空数组表示获取失败
      */
@@ -14553,6 +14563,27 @@ declare class SYS_Environment {
      * @returns 编辑器编译日期
      */
     getEditorCompliedDate(): string;
+    /**
+     * 获取用户信息
+     *
+     * @public
+     * @returns 用户信息
+     */
+    getUserInfo(): {
+        username?: string;
+        nickname?: string;
+        avatar?: string;
+        uuid?: string;
+        customerCode?: string;
+    };
+    /**
+     * 设置环境：保持工程仅拥有一个板子
+     *
+     * @public
+     * @remarks Board、Schematic、PCB 均保持唯一
+     * @param status - 环境变量状态
+     */
+    setKeepProjectHasOnlyOneBoard(status?: boolean): Promise<void>;
 }
 
 /**
@@ -15245,7 +15276,7 @@ declare class SYS_Message {
      * 展示跟随鼠标的提示
      *
      * @beta
-     * @remarks 同一时间只能展示一条提示，如果展示新的提示，则之前的提示将被自动移除
+     * @remarks 同一时间只能展示一条提示，如果展示���的提示，则之前的提示将被自动移除
      * @param tip - 提示内容
      * @param msTimeout - 展示时间，以毫秒（ms）为单位，如若不传入则持续展示，直到调用 {@link SYS_Message.removeFollowMouseTip | removeFollowMouseTip} 或被其它提示覆盖
      */
@@ -15787,7 +15818,7 @@ declare class SYS_Tool {
      * 网表对比
      *
      * @beta
-     * @param netlist1 - 网表 1，可以为当前工程内�� PCB 和原理图的 UUID、网表的文件数据
+     * @param netlist1 - 网表 1，可以为当前工程内的 PCB 和原理图的 UUID、网表的文件数据
      * @param netlist2 - 网表 2，可以为当前工程内的 PCB 和原理图的 UUID、网表的文件数据
      * @returns 网表对比结果
      */
@@ -15975,6 +16006,21 @@ declare class SYS_Window {
      * @returns 当前主题
      */
     getCurrentTheme(): Promise<ESYS_Theme>;
+    /**
+     * 获取 URL 参数
+     *
+     * @public
+     * @param key - 参数名
+     * @returns 参数值
+     */
+    getUrlParam(key: string): string | null;
+    /**
+     * 获取 URL 锚点
+     *
+     * @public
+     * @returns URL 锚点值
+     */
+    getUrlAnchor(): string;
 }
 
 /**

package/package.json

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