@jlceda/pro-api-types 0.1.105 → 0.1.106

package/index.d.ts

@@ -89,6 +89,7 @@ declare class DMT_EditorControl {
      * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
      */
     openDocument(documentUuid: string, splitScreenId?: string): Promise<string | undefined>;
+    /* Excluded from this release type: openLibraryDocument */
     /**
      * 关闭文档
      *
@@ -310,7 +311,7 @@ declare class DMT_Panel {
      *
      * @public
      * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
-     * @returns 面板的详细属性，如若为 `undefined` 则获取失败
+     * @returns 面板���详细属性，如若为 `undefined` 则获取失败
      */
     getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
     /**
@@ -416,7 +417,7 @@ declare class DMT_Project {
      * @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>;
@@ -595,7 +596,7 @@ declare class DMT_Schematic {
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
-     * 获取当前原��图图页的详细属性
+     * 获取当前原理图图页的详细属性
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -783,6 +784,7 @@ declare class EDA {
     sys_IFrame: SYS_IFrame;
     sys_LoadingAndProgressBar: SYS_LoadingAndProgressBar;
     sys_Log: SYS_Log;
+    sys_Message: SYS_Message;
     sys_MessageBox: SYS_MessageBox;
     sys_PanelControl: SYS_PanelControl;
     sys_ShortcutKey: SYS_ShortcutKey;
@@ -1017,7 +1019,7 @@ declare enum EPCB_LayerId {
     TOP_SOLDER_MASK = 5,
     /** 顶层锡膏（助焊）层 */
     TOP_PASTE_MASK = 7,
-    /** 顶层���配层 */
+    /** 顶层装配层 */
     TOP_ASSEMBLY = 9,
     /** 顶层 FPC 补强层 */
     TOP_STIFFENER = 58,
@@ -1659,15 +1661,15 @@ declare enum ESYS_ShortcutKeyEffectiveEditorScene {
  */
 declare enum ESYS_ToastMessageType {
     /** 错误 */
-    ERROR = 0,
+    ERROR = "error",
     /** 警告 */
-    WARNING = 1,
+    WARNING = "warn",
     /** 信息 */
-    INFO = 2,
+    INFO = "info",
     /** 成功 */
-    SUCCESS = 3,
+    SUCCESS = "success",
     /** 问询 */
-    ASK = 4
+    ASK = "question"
 }
 
 /**
@@ -1799,8 +1801,7 @@ declare interface IDMT_EditorTabItem {
     draggable: boolean;
     /** 标签页是否可关闭 */
     isAbleDelete: boolean;
-    /** 标签页是否不使用 I18n 功能（内部功能） */
-    notUseI18n?: boolean;
+    /* Excluded from this release type: notUseI18n */
 }
 
 /**
@@ -2126,6 +2127,32 @@ declare interface ILIB_DeviceItem {
     property: ILIB_DeviceExtendPropertyItem;
 }
 
+/**
+ * 可用于精确搜索的器件参数
+ *
+ * @public
+ */
+declare interface ILIB_DevicePropertiesForSearch {
+    /** 器件名称 */
+    name?: string;
+    /** 值 */
+    value?: string;
+    /** 描述 */
+    description?: string;
+    /** 关联符号名称 */
+    symbolName?: string;
+    /** 关联封装名称 */
+    footprintName?: string;
+    /** 供应商封装名称 */
+    supplierFootprint?: string;
+    /** 供应商编号 */
+    supplierId?: string;
+    /** 料号 */
+    partNumber?: string;
+    /** 元件编码 */
+    partCode?: string;
+}
+
 /**
  * 搜索到的器件属性
  *
@@ -2160,11 +2187,11 @@ declare interface ILIB_DeviceSearchItem {
     description?: string;
     /** 制造商 */
     manufacturer?: string;
-    /** 制造商料号 */
+    /** 制造商编号 */
     manufacturerId?: string;
     /** 供应商 */
     supplier?: string;
-    /** 供应商料号 */
+    /** 供应商编号 */
     supplierId?: string;
     /** 立创商城库存 */
     lcscInventory?: number;
@@ -3102,7 +3129,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
  *
  * @public
  * @remarks
- * 器件��盘图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
+ * 器件焊盘图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
  *
  * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
  */
@@ -3322,14 +3349,14 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
     private readonly primitiveType;
     /** 图元 ID */
     private primitiveId?;
-    /** 网络名称 */
-    private net;
     /** 层 */
     private layer;
     /** 复杂多边形 */
     private complexPolygon;
+    /** 网络名称 */
+    private net?;
     /** 填充模式 */
-    private fillMode;
+    private fillMode?;
     /** 线宽 */
     private lineWidth?;
     /** 是否锁定 */
@@ -3350,13 +3377,6 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      * @returns 图元 ID
      */
     getState_PrimitiveId(): string;
-    /**
-     * 获取属性状态：网络名称
-     *
-     * @public
-     * @returns 网络名称
-     */
-    getState_Net(): string;
     /**
      * 获取属性状态：层
      *
@@ -3370,14 +3390,21 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      * @public
      * @returns 复杂多边形
      */
-    getState_ComplexPolygon(): IPCB_ComplexPolygon;
+    getState_ComplexPolygon(): IPCB_Polygon;
+    /**
+     * 获取属性状态：网络名称
+     *
+     * @public
+     * @returns 网络名称
+     */
+    getState_Net(): string | undefined;
     /**
      * 获取属性状态：填充模式
      *
      * @public
      * @returns 填充模式
      */
-    getState_FillMode(): EPCB_PrimitiveFillMode;
+    getState_FillMode(): EPCB_PrimitiveFillMode | undefined;
     /**
      * 获取属性状态：线宽
      *
@@ -3386,20 +3413,12 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      */
     getState_LineWidth(): number;
     /**
-     * 获取属性状态：是否锁定
+     * 获取属性状��：是否锁定
      *
      * @public
      * @returns 是否锁定
      */
     getState_PrimitiveLock(): boolean;
-    /**
-     * 设置属性状态：网络名称
-     *
-     * @beta
-     * @param net - 网络名称
-     * @returns 填充图元对象
-     */
-    setState_Net(net: string): IPCB_PrimitiveFill;
     /**
      * 设置属性状态：层
      *
@@ -3415,7 +3434,15 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      * @param complexPolygon - 复杂多边形
      * @returns 填充图元对象
      */
-    setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitiveFill;
+    setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveFill;
+    /**
+     * 设置属性状态：网络名称
+     *
+     * @beta
+     * @param net - 网络名称
+     * @returns 填充图元对象
+     */
+    setState_Net(net: string): IPCB_PrimitiveFill;
     /**
      * 设置属性状态：填充模式
      *
@@ -3578,7 +3605,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      */
     getState_PrimitiveLock(): boolean;
     /**
-     * 设���属性状态：BBox 左上点坐标 X
+     * 设置属性状态：BBox 左上点坐标 X
      *
      * @beta
      * @param x - BBox 左上点坐标 X
@@ -3713,7 +3740,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      * 获取属性状态：图元类型
      *
      * @public
-     * @returns 图元类型
+     * @returns 图元���型
      */
     getState_PrimitiveType(): EPCB_PrimitiveType;
     /**
@@ -3745,7 +3772,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      */
     getState_StartX(): number;
     /**
-     * 获取属性状态：起��位置 Y
+     * 获取属性状态：起始位置 Y
      *
      * @public
      * @returns 起始位置 Y
@@ -4230,7 +4257,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Hole(): TPCB_PrimitivePadHole | null;
     /**
-     * 获取属��状态：孔偏移 X
+     * 获取属性状态：孔偏移 X
      *
      * @public
      * @returns 孔偏移 X
@@ -4358,7 +4385,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * 设置属性状态：网络
      *
      * @beta
-     * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被���为空网络
+     * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
      * @param net - 网络名称
      * @returns 焊盘图元对象
      */
@@ -4488,7 +4515,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     reset(): Promise<IPCB_PrimitivePad>;
     /**
-     * 将对图元的更改应用到���布
+     * 将对图元的更改应用到画布
      *
      * @beta
      * @returns 尺寸标注图元对象
@@ -4733,7 +4760,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * @public
      * @returns 复杂多边形
      */
-    getState_ComplexPolygon(): IPCB_ComplexPolygon;
+    getState_ComplexPolygon(): IPCB_Polygon;
     /**
      * 获取属性状态：覆铜填充方法
      *
@@ -4799,7 +4826,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * @param complexPolygon - 复杂多边形
      * @returns 覆铜边框图元对象
      */
-    setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitivePour;
+    setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitivePour;
     /**
      * 设置属性状态：覆铜填充方法
      *
@@ -4812,7 +4839,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * 设置属性状态：是否保留孤岛
      *
      * @beta
-     * @param preserveSilos - 是否��留孤岛
+     * @param preserveSilos - 是否保留孤岛
      * @returns 覆铜边框图元对象
      */
     setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;
@@ -4929,7 +4956,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
      * @public
      * @returns 复杂多边形
      */
-    getState_ComplexPolygon(): IPCB_ComplexPolygon;
+    getState_ComplexPolygon(): IPCB_Polygon;
     /**
      * 获取属性状态：区域规则类型
      *
@@ -4973,7 +5000,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
      * @param complexPolygon - 复杂多边形
      * @returns 区域图元对象
      */
-    setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitiveRegion;
+    setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveRegion;
     /**
      * 设置属性状态：区域规则类型
      *
@@ -5104,7 +5131,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      */
     getState_PrimitiveType(): EPCB_PrimitiveType;
     /**
-     * 获取属性状态���图元 ID
+     * 获取属性状态：图元 ID
      *
      * @public
      * @returns 图元 ID
@@ -5267,7 +5294,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异步��元重置为当前画布状态
+     * 将异步图元重置为当前画布状态
      *
      * @beta
      * @returns 过孔图元对象
@@ -6831,6 +6858,7 @@ declare class LIB_Device {
      * @returns 搜索到的器件属性的列表
      */
     search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_DeviceSearchItem>>;
+    /* Excluded from this release type: searchByProperties */
     /**
      * 使用立创 C 编号获取器件
      *
@@ -7285,7 +7313,7 @@ declare class PCB_Document {
         offsetY: number;
     }>;
     /**
-     * 设置画��原点相对于数据原点的偏移坐标
+     * 设置画布原点相对于数据原点的偏移坐标
      *
      * @public
      * @remarks
@@ -8123,7 +8151,7 @@ declare class PCB_MathPolygon {
  */
 declare class PCB_Net {
     /**
-     * 获取所��网络的网络名称
+     * 获取所有网络的网络名称
      *
      * @beta
      * @returns 网络名称数组
@@ -8154,22 +8182,8 @@ declare class PCB_Net {
      * @returns 操作是否成功
      */
     selectNet(net: string): Promise<boolean>;
-    /**
-     * 取消选中网络
-     *
-     * @beta
-     * @param net - 网络名称
-     * @returns 操作是否成功
-     */
-    unselectNet(net: string): Promise<boolean>;
-    /**
-     * 取消选中所有网络
-     *
-     * @beta
-     * @remarks 如果希望取消选中所有图元，请使用 {@link PCB_SelectControl.clearSelected} 接口
-     * @returns 操作是否成功
-     */
-    unselectAllNets(): Promise<boolean>;
+    /* Excluded from this release type: unselectNet */
+    /* Excluded from this release type: unselectAllNets */
     /**
      * 高亮网络
      *
@@ -8345,7 +8359,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      * @param primitiveLock - 是否锁定
      * @param addIntoBom - 是否加入 BOM
      * @param designator - 位号
-     * @param name - 名称，`null` 表示留���
+     * @param name - 名称，`null` 表示留空
      * @param uniqueId - 唯一 ID，`null` 表示留空
      * @param manufacturer - 制造商，`null` 表示留空
      * @param manufacturerId - 制造商编号，`null` 表示留空
@@ -8653,7 +8667,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * 获取直线
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传���的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 直线图元对象，空数组表示获取失败
      */
@@ -8896,7 +8910,7 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
 }
 
 /**
- * PCB & 封装 / 区域图元类
+ * PCB & 封装 / 禁止区域和约束区域图元类
  *
  * @public
  */
@@ -10243,7 +10257,7 @@ declare class SYS_Environment {
      */
     isProPrivateEdition(): boolean;
     /**
-     * 是��为在线模式
+     * 是否为在线模式
      *
      * @public
      * @returns 是否为在线模式
@@ -10446,7 +10460,7 @@ declare class SYS_I18n {
      *
      * @public
      * @remarks
-     * 可以使用 `${1}` 格式的占位符��示参数；
+     * 可以使用 `${1}` 格式的占位符表示参数；
      *
      * 语言优先级：当前显示语言 \> 系统默认语言 \> 数据集中第一个搜索到的包含该文本标签的语言 \> 文本标签(tag)
      * @param tag - 文本标签，对应多语言文件键值对中的键
@@ -10548,7 +10562,7 @@ declare class SYS_IFrame {
      * 关闭当前扩展打开的所有内联框架窗口；
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
-     * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打��的所有内联框架窗口
+     * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打开的所有内联框架窗口
      * @returns 操作是否成功
      */
     closeIFrame(id?: string): Promise<boolean>;
@@ -10649,6 +10663,29 @@ declare class SYS_Log {
     }>, types?: ESYS_LogType | Array<ESYS_LogType>): Promise<Array<ISYS_LogLine>>;
 }
 
+/**
+ * 系统 / 消息通知类
+ *
+ * @public
+ * @remarks 生成各种对用户的非侵入式提醒
+ */
+declare class SYS_Message {
+    /**
+     * 显示吐司消息
+     *
+     * @public
+     * @param message - 消息内容
+     * @param messageType - 消息类型
+     * @param timer - 自动关闭倒计时秒数，`0` 为不自动关闭
+     * @param bottomPanel - 展开底部信息面板
+     * @param buttonTitle - 回调按钮标题
+     * @param buttonCallbackFn - 回调函数内容，字符串形式，会被自动解析并执行
+     */
+    showToastMessage(message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string): void;
+    /* Excluded from this release type: showFollowMouseTip */
+    /* Excluded from this release type: removeFollowMouseTip */
+}
+
 /**
  * 系统 / 消息框类
  *
@@ -10684,7 +10721,7 @@ declare class SYS_MessageBox {
 }
 
 /**
- * ���统 / 面板控制类
+ * 系统 / 面板控制类
  *
  * @public
  */
@@ -10826,7 +10863,7 @@ declare class SYS_Storage {
      * 获取扩展所有用户配置
      *
      * @public
-     * @remarks 注意：本接��仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @returns 扩展所有用户配置信息
      */
     getExtensionAllUserConfigs(): {
@@ -10946,6 +10983,7 @@ declare class SYS_Timer {
  * 系统 / 吐司消息类
  *
  * @public
+ * @deprecated 即将移除吐司消息类，合并入 {@link SYS_Message | 消息通知类}
  * @remarks 在屏幕的边缘弹出简短的消息提醒，会在一定时间后自动消除
  */
 declare class SYS_ToastMessage {
@@ -10953,6 +10991,7 @@ declare class SYS_ToastMessage {
      * 显示吐司消息
      *
      * @public
+     * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代
      * @param message - 消息内容
      * @param messageType - 消息类型
      * @param timer - 自动关闭倒计时秒数，`0` 为不自动关闭

package/package.json

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