@jlceda/pro-api-types 0.1.123 → 0.1.125

package/index.d.ts

@@ -81,12 +81,22 @@ 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>;
     /**
      * 关闭文档
      *
      * @public
-     * @remarks 如若文档尚未保存，执行此操作将会直接丢失所���未保存的数据，请在修改操作完成后首先执行 {@link SCH_Document.save}、{@link PCB_Document.save}、{@link PNL_Document.save} 保存数据
+     * @remarks 如若文档尚未保存，执行此操作将会直接丢失所有未保存的数据，请在修改操作完成后首先执行 {@link SCH_Document.save}、{@link PCB_Document.save}、{@link PNL_Document.save} 保存数据
      * @param tabId - 标签页 ID，此处支持 {@link IDMT_SchematicPageItem.uuid}、{@link IDMT_PcbItem.uuid}、{@link IDMT_PanelItem.uuid} 作为输入
      * @returns 操作是否成功
      */
@@ -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 */
 }
 
 /**
@@ -307,7 +380,7 @@ declare class DMT_Panel {
      * 获取当前面板的详细属性
      *
      * @public
-     * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
+     * @remarks 将会��取当前打开且拥有最后输入焦点的面板的详细属性
      * @returns 面板的详细属性，如若为 `undefined` 则获取失败
      */
     getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
@@ -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;
@@ -4674,7 +4831,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;
     /**
-     * ��置属性状态：网络
+     * 设置属性状态：网络
      *
      * @beta
      * @remarks 本接口仅在 PCB 编辑器可用，空字符串与 `undefined` 均被视为空网络
@@ -4961,7 +5118,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     toSync(): IPCB_PrimitivePolyline;
     /**
-     * 查询图元是���为异步图元
+     * 查询图元是否为异步图元
      *
      * @public
      * @returns 是否为异步图元
@@ -5607,7 +5764,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      *
      * @beta
      * @param diameter - 外径
-     * @returns 过孔图���对象
+     * @returns 过孔图元对象
      */
     setState_Diameter(diameter: number): IPCB_PrimitiveVia;
     /**
@@ -6913,7 +7070,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
      *
      * @beta
      * @param y - 坐标 Y
-     * @returns 器件图元对���
+     * @returns 器件图元对象
      */
     setState_Y(y: number): ISCH_PrimitiveComponent_2;
     /**
@@ -7054,7 +7211,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
      * 将对图元的更改应用到画布
      *
      * @beta
-     * @returns 器件图元对��
+     * @returns 器件图元对象
      */
     done(): Promise<ISCH_PrimitiveComponent_2>;
     /* Excluded from this release type: getAllPins */
@@ -7690,7 +7847,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
      * 设置属性状态：填充样式
      *
      * @beta
-     * @param fillStyle - 填���样式
+     * @param fillStyle - 填充样式
      * @returns 矩形图元对象
      */
     setState_FillStyle(fillStyle: ESCH_PrimitiveFillStyle | null): ISCH_PrimitiveRectangle;
@@ -8305,7 +8462,7 @@ declare class LIB_Cbb {
      * 修改复用模块
      *
      * @beta
-     * @remarks 如希望清除某��属性，则将其的值设置为 `null`
+     * @remarks 如希望清除某些属性，则将其的值设置为 `null`
      * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param cbbName - 复用模块名称
@@ -8362,7 +8519,7 @@ declare class LIB_Cbb {
      * @beta
      * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param splitScreenId - 分屏 ID，不填写则默认在最后输入焦点的分屏内打开，可以使用 {@link DMT_EditorControl} 内的接口获取
+     * @param splitScreenId - 分屏 ID，不填写则默认在最后输入焦点的分屏内打开，可以���用 {@link DMT_EditorControl} 内的接口获取
      * @returns 标签页 ID，对应 {@link IDMT_EditorTabItem.tabId}，可使用 {@link DMT_EditorControl.getSplitScreenIdByTabId} 获取到分屏 ID
      */
     openSymbolInEditor(cbbUuid: string, libraryUuid: string, splitScreenId?: string): Promise<string | undefined>;
@@ -8667,7 +8824,7 @@ declare class LIB_Footprint {
      */
     modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
     /**
-     * 更新封装��文档源码
+     * 更新封装的文档源码
      *
      * @beta
      * @param footprintUuid - 封装 UUID
@@ -9127,7 +9284,7 @@ declare class PCB_Drc {
      * 检查 DRC
      *
      * @beta
-     * @param strict - 是否严格检查，当前 PCB 统一为严格检查模式
+     * @param strict - ���否严格检查，当前 PCB 统一为严格检查模式
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
      * @param includeVerboseError - 是否在返回值中包含详细错误信息，如若为 `true`，则返回值将始终为数组
      * @returns DRC 检查是否通过
@@ -9771,7 +9928,7 @@ declare class PCB_ManufactureData {
      * @param fileName - 文件名
      * @param fileType - 文件类型
      * @param template - 模板名称
-     * @param filterOptions - 过滤规则，仅应包含需要启用的规则，`property` 为规则名称，`includeValue` 为匹配的���
+     * @param filterOptions - 过滤规则，仅应包含需要启用的规则，`property` 为规则名称，`includeValue` 为匹配的值
      * @param statistics - 统计，包含所有需要启用的统计项的名称
      * @param property - 属性，包含所有需要启用的属性的名称
      * @param columns - 列的属性及排序，`title`、`sort`、`group`、`orderWeight` 不传入则取默认值，`null` 代表 **无** 或 **空**
@@ -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<{
@@ -11436,7 +11593,7 @@ declare class SCH_Event {
 }
 
 /**
- * 原理图 & 符号 / 生产资料类
+ * 原理图 & 符号 / 生产资��类
  *
  * @public
  * @remarks 获取当前原理图图页的生产资料文件及快捷下单
@@ -13624,7 +13781,7 @@ declare class SYS_Storage {
      * 获取扩展所有用户配置
      *
      * @public
-     * @remarks 注意：本接口仅扩展有效，在独立脚本环境��调用将始终 `throw Error`
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @returns 扩展所有用户配置信息
      */
     getExtensionAllUserConfigs(): {

package/package.json

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