@jlceda/pro-api-types 0.1.152 → 0.1.154

package/index.d.ts

@@ -348,7 +348,7 @@ declare class DMT_Folder {
      * 删除文件夹
      *
      * @public
-     * @param teamUuid - 团队 UUID
+     * @param teamUuid - ��队 UUID
      * @param folderUuid - 文件夹 UUID
      * @returns 操作是否成功
      */
@@ -508,7 +508,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 - 工程描述
@@ -731,7 +731,7 @@ declare class DMT_Schematic {
  * 文档树 / 选择控制类
  *
  * @public
- * @remarks 在文档树内进行选择焦点的查询、控制
+ * @remarks 在文档树内进行选择焦���的查询、控制
  */
 declare class DMT_SelectControl {
     /**
@@ -1916,6 +1916,18 @@ declare enum ESYS_ShortcutKeyEffectiveEditorScene {
     LOCAL = 6
 }
 
+/**
+ * 主题
+ *
+ * @public
+ */
+declare enum ESYS_Theme {
+    /** 浅色 */
+    LIGHT = "light",
+    /** 深色 */
+    DARK = "dark"
+}
+
 /**
  * 吐司消息类型
  *
@@ -2142,7 +2154,7 @@ declare interface IDMT_IndicatorMarkerShape {
      */
     bottom?: number;
     /**
-     * 矩形：左 X
+     * 矩���：左 X
      */
     left?: number;
     /**
@@ -2804,6 +2816,7 @@ declare class IPCB_ComplexPolygon {
      * @returns 复杂多边形数据
      */
     getSourceStrictComplex(): Array<TPCB_PolygonSourceArray>;
+    /* Excluded from this release type: getCenter */
     /* Excluded from this release type: validateSource */
 }
 
@@ -2935,16 +2948,7 @@ declare class IPCB_Polygon {
      * @returns 单多边形数据
      */
     getSource(): TPCB_PolygonSourceArray;
-    /**
-     * 获取单多边形中心点
-     *
-     * @public
-     * @returns 单多边形中心点
-     */
-    getCenter(): {
-        x: number;
-        y: number;
-    };
+    /* Excluded from this release type: getCenter */
     /* Excluded from this release type: validateSource */
 }
 
@@ -3503,7 +3507,7 @@ declare class IPCB_PrimitiveAttribute implements IPCB_Primitive {
      */
     setState_LineWidth(lineWidth: number): IPCB_PrimitiveAttribute;
     /**
-     * 设置属性状态：对齐模式
+     * 设置属���状态：对齐模式
      *
      * @beta
      * @param alignMode - 对齐模式
@@ -3949,7 +3953,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
  * @remarks
  * 器件焊盘图元是一个特殊的图元，它指的是在 PCB 画布上关联到封装的焊盘
  *
- * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
+ * 你只能通过 {@link PCB_PrimitiveComponent.getAllPinsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
  */
 declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
     /** 图元类型 */
@@ -4329,7 +4333,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      */
     done(): Promise<IPCB_PrimitiveFill>;
     /**
-     * 转换到：折线图元(默认是线条)
+     * 转换到：折线图元
      *
      * @beta
      * @returns 折线图元对象
@@ -4783,7 +4787,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param includeVias - 是否包含导线两端的过孔
-     * @returns 整段导线内的所有直线、圆弧线，以及两端连接的过孔（如果��）
+     * @returns ���段导线内的所有直线、圆弧线，以及两端连接的过孔（如果有）
      */
     getEntireTrack(includeVias: true): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;
 }
@@ -6651,7 +6655,7 @@ declare interface ISCH_Primitive {
 }
 
 /**
- * 原��图图元接口
+ * 原理图图元接口
  *
  * @public
  */
@@ -8586,7 +8590,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
      */
     setState_Height(height: number): ISCH_PrimitiveRectangle;
     /**
-     * 设置属性状态：圆角半径
+     * 设置属性���态：圆角半径
      *
      * @beta
      * @param cornerRadius - 圆角半径
@@ -9207,7 +9211,7 @@ declare class LIB_3DModel {
      * @beta
      * @param key - 搜索关键字
      * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param classification - 分类，默认为全部
+     * @param classification - 分类，��认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
      * @returns 搜索到的 3D 模型属性列表
@@ -9959,7 +9963,7 @@ declare class PCB_Document {
      * 启动飞线计算功能
      *
      * @public
-     * @remarks 在启动时将会触发一次飞线计算
+     * @remarks 在启动时将会触发一次飞线计��
      * @returns 操作是否成功
      */
     startCalculatingRatline(): Promise<boolean>;
@@ -12377,7 +12381,7 @@ declare class PNL_Document {
  * 原理图 & 符号 / 文档操作类
  *
  * @public
- * @remarks 对设计��档总体进行的操作
+ * @remarks 对设计文档总体进行的操作
  */
 declare class SCH_Document {
     /**
@@ -14267,7 +14271,7 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @remarks
-     * ���意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
      *
      * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
      * @param folderPath - 目录路径
@@ -14471,9 +14475,9 @@ declare class SYS_IFrame {
      *
      * 本接口调用后将会打开一个 Dialog 窗口，该 Dialog 窗口的标题为 HTML 文件的 `<title>`，标题栏有关闭按钮；
      *
-     * 正文部分为内联框架，{@link width} 和 {@link height} 均为正文部分内联框架的宽高；
+     * 正文部分为内联框架，`width` 和 `height` 均为正文部分内联框架的宽高；
      *
-     * 内联框架需要展示 {@link htmlFileName} 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中
+     * 内联框架需要展示 `htmlFileName` 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
@@ -14631,8 +14635,23 @@ declare class SYS_Message {
      * @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 */
+    /**
+     * 展示跟随鼠标的提示
+     *
+     * @beta
+     * @remarks 同一时间只能展示一条提示，如果展示新的提示，则之前的提示将被自动移除
+     * @param tip - 提示内容
+     * @param msTimeout - 展示时间，以毫秒（ms）为单位，如若不传入则持续展示，直到调用 {@link SYS_Message.removeFollowMouseTip | removeFollowMouseTip} 或被其它提示覆盖
+     */
+    showFollowMouseTip(tip: string, msTimeout?: number): Promise<void>;
+    /**
+     * 移除跟随鼠标的提示
+     *
+     * @beta
+     * @remarks 移除当前或指定的跟随鼠标的提示
+     * @param tip - 提示内容，如若传入，则仅当当前提示为指定内容时才移除
+     */
+    removeFollowMouseTip(tip?: string): Promise<void>;
 }
 
 /**
@@ -15133,6 +15152,14 @@ declare class SYS_Window {
      */
     removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;
     /* Excluded from this release type: openUI */
+    /**
+     * 获取当前主题
+     *
+     * @public
+     * @remarks 获取当前 EDA 主题，**浅色** 或 **深色**
+     * @returns 当前主题
+     */
+    getCurrentTheme(): Promise<ESYS_Theme>;
 }
 
 /**

package/package.json

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