@jlceda/pro-api-types 0.1.108 → 0.1.110

package/index.d.ts

@@ -3569,7 +3569,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      */
     convertToPour(): Promise<IPCB_PrimitivePour>;
     /**
-     * 转换到：区域图元(默认是禁止区域)
+     * 转换到：区��图元(默认是禁止区域)
      *
      * @beta
      * @returns 区域图元对象
@@ -3629,14 +3629,14 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @public
      * @returns BBox 左上点坐标 X
      */
-    getState_X(): number;
+    getState_X(): number | undefined;
     /**
      * 获取属性状态：BBox 左上点坐标 Y
      *
      * @public
      * @returns BBox 左上点坐标 Y
      */
-    getState_Y(): number;
+    getState_Y(): number | undefined;
     /**
      * 获取属性状态：图像源数据（复杂多边形）
      *
@@ -3650,42 +3650,42 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @public
      * @returns 层
      */
-    getState_Layer(): TPCB_LayersOfImage;
+    getState_Layer(): TPCB_LayersOfImage | undefined;
     /**
      * 获取属性状态：宽
      *
      * @public
      * @returns 宽
      */
-    getState_Width(): number;
+    getState_Width(): number | undefined;
     /**
      * 获取属性状态：高
      *
      * @public
      * @returns 高
      */
-    getState_Height(): number;
+    getState_Height(): number | undefined;
     /**
      * 获取属性状态：旋转角度
      *
      * @public
      * @returns 旋转角度
      */
-    getState_Rotation(): number;
+    getState_Rotation(): number | undefined;
     /**
      * 获取属性状态：是否水平镜像
      *
      * @public
      * @returns 是否水平镜像
      */
-    getState_HorizonMirror(): boolean;
+    getState_HorizonMirror(): boolean | undefined;
     /**
      * 获取属性状态：是否锁定
      *
      * @public
      * @returns 是否锁定
      */
-    getState_PrimitiveLock(): boolean;
+    getState_PrimitiveLock(): boolean | undefined;
     /**
      * 设置属性状态：BBox 左上点坐标 X
      *
@@ -3693,7 +3693,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param x - BBox 左上点坐标 X
      * @returns 图像图元对象
      */
-    setState_X(x: number): IPCB_PrimitiveImage;
+    setState_X(x: number | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：BBox 左上点坐标 Y
      *
@@ -3701,7 +3701,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param y - BBox 左上点坐标 Y
      * @returns 图像图元对象
      */
-    setState_Y(y: number): IPCB_PrimitiveImage;
+    setState_Y(y: number | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：层
      *
@@ -3709,7 +3709,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param layer - 层
      * @returns 图像图元对象
      */
-    setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveImage;
+    setState_Layer(layer: TPCB_LayersOfImage | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：宽
      *
@@ -3717,7 +3717,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param width - 宽
      * @returns 图像图元对象
      */
-    setState_Width(width: number): IPCB_PrimitiveImage;
+    setState_Width(width: number | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：高
      *
@@ -3725,7 +3725,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param height - 高
      * @returns 图像图元对象
      */
-    setState_Height(height: number): IPCB_PrimitiveImage;
+    setState_Height(height: number | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：旋转角度
      *
@@ -3733,7 +3733,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param rotation - 旋转角度
      * @returns 图像图元对象
      */
-    setState_Rotation(rotation: number): IPCB_PrimitiveImage;
+    setState_Rotation(rotation: number | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：是否水平镜像
      *
@@ -3741,7 +3741,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param horizonMirror - 是否水平镜像
      * @returns 图像图元对象
      */
-    setState_HorizonMirror(horizonMirror: boolean): IPCB_PrimitiveImage;
+    setState_HorizonMirror(horizonMirror: boolean | undefined): IPCB_PrimitiveImage;
     /**
      * 设置属性状态：是否锁定
      *
@@ -3749,7 +3749,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @param primitiveLock - 是否锁定
      * @returns 图像图元对象
      */
-    setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;
+    setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveImage;
     /**
      * 将图元转换为异步图元
      *
@@ -4067,7 +4067,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
      */
     getState_TopLeftX(): number | undefined;
     /**
-     * 获取属性状态：左上点 Y
+     * 获取属性状态：左上�� Y
      *
      * @public
      * @returns 左上点 Y
@@ -4392,7 +4392,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     getState_Metallization(): boolean;
     /**
-     * ���取属性状态：焊盘功能
+     * 获取属性状态：焊盘功能
      *
      * @public
      * @returns 焊盘功能
@@ -5858,7 +5858,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      */
     getState_ComponentType(): ESCH_PrimitiveComponentType;
     /**
-     * 获取属性状态：图元 ID
+     * 获取属性状态：���元 ID
      *
      * @public
      * @returns 图元 ID
@@ -7102,7 +7102,6 @@ declare class LIB_Footprint {
      * @returns 封装 UUID
      */
     create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
-    /* Excluded from this release type: createByDocumentSource */
     /**
      * 删除封装
      *
@@ -7125,6 +7124,16 @@ declare class LIB_Footprint {
      * @returns 操作是否成功
      */
     modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
+    /**
+     * 更新封装的文档源码
+     *
+     * @beta
+     * @param footprintUuid - 封装 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(footprintUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取封装的所有属性
      *
@@ -7320,7 +7329,6 @@ declare class LIB_Symbol {
      * @returns 符号 UUID
      */
     create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
-    /* Excluded from this release type: createByDocumentSource */
     /**
      * 删除符号
      *
@@ -7343,6 +7351,16 @@ declare class LIB_Symbol {
      * @returns 操作是否成功
      */
     modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
+    /**
+     * 更新符号的文档源码
+     *
+     * @beta
+     * @param symbolUuid - 符号 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(symbolUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取符号的所有属性
      *
@@ -7474,7 +7492,7 @@ declare class PCB_Document {
      * 输入画布坐标返回该坐标对应的数据坐标
      *
      * @public
-     * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点；嘉立�� EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
+     * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点；嘉立创 EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
      * @param canvasOriginX - 画布原点 X
      * @param canvasOriginY - 画布原点 Y
      * @returns 数据原点坐标
@@ -8043,7 +8061,7 @@ declare class PCB_Layer {
      *
      * @beta
      * @remarks
-     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板���将会新增 FPC 补强层图层。
+     * 此处主要是为了适配 FPC 软板的设计，如若将 PCB 类型设置为 FPC 软板，将会新增 FPC 补强层图层。
      *
      * 请注意：
      *
@@ -9183,7 +9201,7 @@ declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
      * 获取二进制内嵌对象
      *
      * @beta
-     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 二进制内嵌对象的图元 ID，��以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 二进制内嵌对象图元对象，`undefined` 表示获取失败
      */
     get(primitiveIds: string): Promise<IPCB_PrimitiveObject | undefined>;
@@ -10978,7 +10996,7 @@ declare class SYS_FileManager {
      */
     getProjectFile(fileName?: string, password?: string): Promise<File | undefined>;
     /**
-     * 获取文档文件
+     * ���取文档文件
      *
      * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -11073,7 +11091,7 @@ declare class SYS_FileSystem {
      *
      * @beta
      * @param filenameExtensions - 文件扩展名
-     * @returns File 格式��件
+     * @returns File 格式文件
      */
     openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
     /**
@@ -11248,8 +11266,28 @@ declare class SYS_IFrame {
      * @returns 操作是否成功
      */
     closeIFrame(id?: string): Promise<boolean>;
-    /* Excluded from this release type: hideIFrame */
-    /* Excluded from this release type: showIFrame */
+    /**
+     * 隐藏内联框架窗口
+     *
+     * @beta
+     * @remarks 本接口为结果导向的：
+     * 如若未找到指定内联框架窗口，接口将会返回 `false`；
+     * 如若在执行操作前该内联框架窗口已处于隐藏状态，接口将会返回 `true`
+     * @param id - 内联框架窗口 ID
+     * @returns 操作是否成功
+     */
+    hideIFrame(id?: string): Promise<boolean>;
+    /**
+     * 显示内联框架窗口
+     *
+     * @beta
+     * @remarks 本接口为结果导向的：
+     * 如若未找到指定内联框架窗口，接口将会返回 `false`；
+     * 如若在执行操作前该内联框架窗口已处于显示状态，接口将会返回 `true`
+     * @param id - 内联框架窗口 ID
+     * @returns 操作是否成功
+     */
+    showIFrame(id?: string): Promise<boolean>;
 }
 
 /**

package/package.json

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