@jlceda/pro-api-types 0.1.124 → 0.1.126

package/index.d.ts

@@ -81,7 +81,17 @@ declare class DMT_EditorControl {
      * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
      */
     openDocument(documentUuid: string, splitScreenId?: string): Promise<string | undefined>;
-    /* Excluded from this release type: openLibraryDocument */
+    /**
+     * 打开库符号、封装文档
+     *
+     * @beta
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryType - 库类型，支持符号和封装
+     * @param uuid - 符号、封装 UUID
+     * @param splitScreenId - 分屏 ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
+     * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
+     */
+    openLibraryDocument(libraryUuid: string, libraryType: ELIB_LibraryType.SYMBOL | ELIB_LibraryType.FOOTPRINT, uuid: string, splitScreenId?: string): Promise<string | undefined>;
     /**
      * 关闭文档
      *
@@ -172,11 +182,74 @@ 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 */
+    /**
+     * 获取画布渲染区域图像
+     *
+     * @beta
+     * @param tabId - 标签页 ID，如若未传入，则获取最后输入焦点的画布
+     * @returns - 画布渲染区域的 Blob 格式图像数据
+     */
+    getCurrentRenderedAreaImage(tabId?: string): Promise<Blob | undefined>;
+    /**
+     * 缩放到区域
+     *
+     * @beta
+     * @remarks 在原理图、符号画布坐标单位跨度为 0.01inch，在 PCB、封装画布坐标单位跨度为 mil
+     * @param left - 矩形框第一 X 坐标
+     * @param right - 矩形框第二 X 坐标
+     * @param top - 矩形框第一 Y 坐标
+     * @param bottom - 矩形框第二 Y 坐标
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 操作是否成功
+     */
+    zoomToRegion(left: number, right: number, top: number, bottom: number, tabId?: string): Promise<boolean>;
+    /**
+     * 缩放到坐标
+     *
+     * @beta
+     * @remarks 在原理图、符号画布坐标单位跨度为 0.01inch，在 PCB、封装画布坐标单位跨度为 mil
+     * @param x - 中心坐标 X，如若不传入则不改变当前 X 坐标
+     * @param y - 中心坐标 Y，如若不传入则不改变当前 Y 坐标
+     * @param scaleRatio - 缩放比，如若不传入则不改变当前缩放比，单位跨度为 `1/100`，如若传入 `200`，则表示缩放比为 `200%`
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 缩放到的区域数据，`false` 表示画布不支持该缩放操作或 `tabId` 不存在
+     */
+    zoomTo(x?: number, y?: number, scaleRatio?: number, tabId?: string): Promise<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    } | false>;
+    /**
+     * 缩放到所有图元（适应全部）
+     *
+     * @beta
+     * @remarks 在返回数据中，原理图、符号画布坐标单位跨度为 0.01inch，PCB、封装画布坐标单位跨度为 mil
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 缩放到的区域数据，`false` 表示画布不支持该缩放操作或 `tabId` 不存在
+     */
+    zoomToAllPrimitives(tabId?: string): Promise<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    } | false>;
+    /**
+     * 缩放到已选中图元（适应选中）
+     *
+     * @beta
+     * @remarks 在返回数据中，原理图、符号画布坐标单位跨度为 0.01inch，PCB、封装画布坐标单位跨度为 mil
+     * @param tabId - 标签页 ID，如若未传入，则为最后输入焦点的画布
+     * @returns 缩放到的区域数据，`false` 表示画布不支持该缩放操作或 `tabId` 不存在
+     */
+    zoomToSelectedPrimitives(tabId?: string): Promise<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    } | false>;
+    /* Excluded from this release type: generateIndicatorMarkers */
+    /* Excluded from this release type: removeIndicatorMarkers */
 }
 
 /**
@@ -410,7 +483,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 - 工程描述
@@ -509,7 +582,7 @@ declare class DMT_Schematic {
      * @beta
      * @param schematicPageUuid - 原理图图页 UUID
      * @param schematicPageName - 原理图图页名称
-     * @returns 是否修改成功
+     * @returns 是否���改成功
      */
     modifySchematicPageName(schematicPageUuid: string, schematicPageName: string): Promise<boolean>;
     /**
@@ -858,6 +931,24 @@ declare enum EDMT_EditorSplitScreenDirection {
     VERTICAL = "vertical"
 }
 
+/**
+ * 指示标记类型
+ *
+ * @public
+ */
+declare enum EDMT_IndicatorMarkerType {
+    /** 点 */
+    POINT = "point",
+    /** 圆形 */
+    CIRCLE = "circle",
+    /** 线段 */
+    LINE = "line",
+    /** 圆弧 */
+    ARC = "arc",
+    /** 矩形 */
+    RECTANGLE = "rectangle"
+}
+
 /**
  * 文档树项目类型
  *
@@ -1429,7 +1520,7 @@ declare enum ESCH_PrimitiveComponentType {
     /** 元件 */
     COMPONENT = "part",
     /** 图纸 */
-    DRAWING = "Drawing",
+    DRAWING = "sheet",
     /** 网络标识 */
     NET_FLAG = "netflag",
     /** 网络端口 */
@@ -1451,7 +1542,7 @@ declare enum ESCH_PrimitiveComponentType_2 {
     /** 元件 */
     COMPONENT = "part",
     /** 图纸 */
-    DRAWING = "Drawing",
+    DRAWING = "sheet",
     /** 网络标识 */
     NET_FLAG = "netflag",
     /** 网络端口 */
@@ -1915,6 +2006,72 @@ declare interface IDMT_FolderItem {
     childrenFoldersUuid?: Array<string>;
 }
 
+/**
+ * 指示标记外形
+ *
+ * @public
+ */
+declare interface IDMT_IndicatorMarkerShape {
+    /** 类型 */
+    type: EDMT_IndicatorMarkerType;
+    /**
+     * 点：坐标 X
+     *
+     * 圆形：圆心 X
+     */
+    x?: number;
+    /**
+     * 点：坐标 Y
+     *
+     * 圆形：圆心 Y
+     */
+    y?: number;
+    /**
+     * 圆形：半径
+     */
+    r?: number;
+    /**
+     * 线段 | 圆弧：起始点 X
+     */
+    startX?: number;
+    /**
+     * 线段 | 圆弧：起始点 Y
+     */
+    startY?: number;
+    /**
+     * 圆弧：参考点 X
+     */
+    referenceX?: number;
+    /**
+     * 圆弧：参考点 Y
+     */
+    referenceY?: number;
+    /**
+     * 线段 | 圆弧：终止点 X
+     */
+    endX?: number;
+    /**
+     * 线段 | 圆弧：终止点 Y
+     */
+    endY?: number;
+    /**
+     * 矩形：上 Y
+     */
+    top?: number;
+    /**
+     * 矩形：下 Y
+     */
+    bottom?: number;
+    /**
+     * 矩形：左 X
+     */
+    left?: number;
+    /**
+     * 矩形：右 X
+     */
+    right?: number;
+}
+
 /**
  * 面板属性
  *
@@ -1925,7 +2082,7 @@ declare interface IDMT_PanelItem {
     readonly itemType: EDMT_ItemType.PANEL;
     /** 面板 UUID */
     uuid: string;
-    /** 面板���称 */
+    /** 面板名称 */
     name: string;
     /** 所属工程 UUID */
     parentProjectUuid: string;
@@ -4629,7 +4786,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Layer(layer: TPCB_LayersOfPad): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：焊盘编号
+     * 设置属性状���：焊盘编号
      *
      * @beta
      * @param padNumber - 焊盘编号
@@ -4674,7 +4831,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;
     /**
-     * ���置属性状态：网络
+     * 设置属性状态：网络
      *
      * @beta
      * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
@@ -8270,7 +8427,7 @@ declare class LIB_3DModel {
      * @param classification - 分类，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
-     * @returns 搜索到的 3D 模型属性列表
+     * @returns ���索到的 3D 模型属性列表
      */
     search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_3DModelSearchItem>>;
 }
@@ -9024,7 +9181,7 @@ declare class PCB_Document {
      */
     startCalculatingRatline(): Promise<boolean>;
     /**
-     * 停止飞线计算功能
+     * 停���飞线计算功能
      *
      * @public
      * @returns 操作是否成功
@@ -10188,7 +10345,7 @@ declare class PCB_Primitive {
      * 获取图元的 BBox
      *
      * @beta
-     * @param primitiveIds - 图元 ID 数组或图元对象数组
+     * @param primitiveIds - ���元 ID 数组或图元对象数组
      * @returns 图元的 BBox，如若图元不存在或没有 BBox，将会返回 `undefined` 的结果
      */
     getPrimitivesBBox(primitiveIds: Array<string | IPCB_Primitive>): Promise<{
@@ -10317,7 +10474,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      *
      * @beta
      * @param primitiveIds - 器件的图元 ID 或器件图元对象
-     * @returns 删除操作是否��功
+     * @returns 删除操作是否成功
      */
     delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;
     /**
@@ -11436,7 +11593,7 @@ declare class SCH_Event {
 }
 
 /**
- * 原理图 & 符号 / 生产资料类
+ * 原理图 & 符号 / 生产资���类
  *
  * @public
  * @remarks 获取当前原理图图页的生产资料文件及快捷下单
@@ -11821,7 +11978,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
     private defaultLibraryUuid;
     /* Excluded from this release type: __constructor */
     /**
-     * 设置在扩展 API 中 Power 网络标识关联的器件 UUID
+     * 设��在扩展 API 中 Power 网络标识关联的器件 UUID
      *
      * @beta
      * @param component - 关联库器件
@@ -13624,7 +13781,7 @@ declare class SYS_Storage {
      * 获取扩展所有用户配置
      *
      * @public
-     * @remarks 注意：本接口仅扩展有效，在独立脚本环境���调用将始终 `throw Error`
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @returns 扩展所有用户配置信息
      */
     getExtensionAllUserConfigs(): {
@@ -13935,7 +14092,7 @@ declare class SYS_Window {
  * 可选中图层
  *
  * @public
- * @remarks 此处为所有在编辑器图层菜单中可以选中并设置可见性的图层
+ * @remarks 此处为所有在编辑器图层菜单中可以选中并设置��见性的图层
  */
 declare type TPCB_LayersInTheSelectable = TPCB_LayersOfInner | TPCB_LayersOfCustom | EPCB_LayerId.TOP | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.TOP_STIFFENER | EPCB_LayerId.BOTTOM | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.BOTTOM_STIFFENER | EPCB_LayerId.BOARD_OUTLINE | EPCB_LayerId.MULTI | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.DRILL_DRAWING | EPCB_LayerId.RATLINE | EPCB_LayerId.COMPONENT_SHAPE | EPCB_LayerId.COMPONENT_MARKING | EPCB_LayerId.PIN_SOLDERING | EPCB_LayerId.PIN_FLOATING | EPCB_LayerId.SHELL_3D_OUTLINE | EPCB_LayerId.SHELL_3D_TOP | EPCB_LayerId.SHELL_3D_BOTTOM;
 
@@ -14030,7 +14187,7 @@ declare type TPCB_LayerTypesOfInnerLayer = EPCB_LayerType.SIGNAL | EPCB_LayerTyp
  *
  * @public
  * @remarks
- * 单多边形为首尾重��的一条不间断的线所描述的区域，如果首尾不重合将会自动重合。
+ * 单多边形为首尾重合的一条不间断的线所描述的区域，如果首尾不重合将会自动重合。
  *
  * 单多边形的数据格式举例：
  *

package/package.json

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