@jlceda/pro-api-types 0.1.136 → 0.1.137

package/index.d.ts

@@ -655,7 +655,7 @@ declare class DMT_Schematic {
      * 获取原理图图页的详细属性
      *
      * @beta
-     * @param schematicPageUuid - ��理图图页 UUID
+     * @param schematicPageUuid - 原理图图页 UUID
      * @returns 原理图图页的详细属性，如若为 `undefined` 则获取失败
      */
     getSchematicPageInfo(schematicPageUuid: string): Promise<IDMT_SchematicPageItem | undefined>;
@@ -733,7 +733,7 @@ declare class DMT_Schematic {
  */
 declare class DMT_SelectControl {
     /**
-     * 获取当前文档的属性
+     * 获取当前文档的属��
      *
      * @beta
      * @remarks 仅在存在打开的工程后生效，将会获取当前打开且拥有最后输入焦点的文档的文档类型、UUID、所属工程的 UUID
@@ -837,6 +837,7 @@ declare class EDA {
     pcb_Net: PCB_Net;
     pcb_Primitive: PCB_Primitive;
     pcb_PrimitiveArc: PCB_PrimitiveArc;
+    pcb_PrimitiveAttribute: PCB_PrimitiveAttribute;
     pcb_PrimitiveComponent: PCB_PrimitiveComponent;
     pcb_PrimitiveDimension: PCB_PrimitiveDimension;
     pcb_PrimitiveFill: PCB_PrimitiveFill;
@@ -1549,7 +1550,9 @@ declare enum EPCB_PrimitiveType {
     /** 覆铜填充 */
     POURED = "Poured",
     /** 文本 */
-    STRING = "String"
+    STRING = "String",
+    /** 属性 */
+    ATTRIBUTE = "Attribute"
 }
 
 /**
@@ -1721,7 +1724,13 @@ declare enum ESCH_PrimitiveType {
     /** 文本 */
     TEXT = "Text",
     /** 导线 */
-    WIRE = "Wire"
+    WIRE = "Wire",
+    /** 二进制内嵌对象 */
+    OBJECT = "Object",
+    /** 三阶贝塞尔线条 */
+    BEZIER = "Bezier",
+    /** 椭圆 */
+    ELLIPSE = "Ellipse"
 }
 
 /**
@@ -3187,6 +3196,340 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
     getEntireTrack(includeVias: true): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;
 }
 
+/**
+ * 属性图元
+ *
+ * @public
+ */
+declare class IPCB_PrimitiveAttribute implements IPCB_Primitive {
+    /** 异步 */
+    private async;
+    /** 图元类型 */
+    private readonly primitiveType;
+    /** 图元 ID */
+    private primitiveId;
+    /** 关联的父图元 ID */
+    private parentPrimitiveId;
+    /** 层 */
+    private layer;
+    /** 坐标 X */
+    private x;
+    /** 坐标 Y */
+    private y;
+    /** Key */
+    private key;
+    /** Value */
+    private value;
+    /** Key 是否可见 */
+    private keyVisible;
+    /** Value 是否可见 */
+    private valueVisible;
+    /** 字体 */
+    private fontFamily;
+    /** 字号 */
+    private fontSize;
+    /** 线宽 */
+    private lineWidth;
+    /** 对齐模式 */
+    private alignMode;
+    /** 旋转角度 */
+    private rotation;
+    /** 是否反相 */
+    private reverse;
+    /** 反相扩展 */
+    private expansion;
+    /** 是否镜像 */
+    private mirror;
+    /** 是否锁定 */
+    private primitiveLock;
+    constructor(layer: TPCB_LayersOfImage, x: number | null, y: number | null, key: string, value: string, keyVisible: boolean, valueVisible: boolean, fontFamily: string, fontSize: number, lineWidth: number, alignMode: EPCB_PrimitiveStringAlignMode, rotation: number, reverse: boolean, expansion: number, mirror: boolean, primitiveLock: boolean, primitiveId: string, parentPrimitiveId: string);
+    /* Excluded from this release type: create */
+    /**
+     * 获取属性状态：图元类型
+     *
+     * @public
+     * @returns 图元类型
+     */
+    getState_PrimitiveType(): EPCB_PrimitiveType;
+    /**
+     * 获取属性状态：图元 ID
+     *
+     * @public
+     * @returns 图元 ID
+     */
+    getState_PrimitiveId(): string;
+    /**
+     * 获取属性状态：关联的父图元 ID
+     *
+     * @public
+     * @returns 关联的父图元 ID
+     */
+    getState_ParentPrimitiveId(): string;
+    /**
+     * 获取属性状态：层
+     *
+     * @public
+     * @returns 层
+     */
+    getState_Layer(): TPCB_LayersOfImage;
+    /**
+     * 获取属性状态：坐标 X
+     *
+     * @public
+     * @returns 坐标 X
+     */
+    getState_X(): number | null;
+    /**
+     * 获取属性状态：坐标 Y
+     *
+     * @public
+     * @returns 坐标 Y
+     */
+    getState_Y(): number | null;
+    /**
+     * 获取属性状态：Key
+     *
+     * @public
+     * @returns Key
+     */
+    getState_Key(): string;
+    /**
+     * 获取属性状态：Value
+     *
+     * @public
+     * @returns Value
+     */
+    getState_Value(): string;
+    /**
+     * 获取属性状态：Key 是否可见
+     *
+     * @public
+     * @returns Key 是否可见
+     */
+    getState_KeyVisible(): boolean;
+    /**
+     * 获取属性状态：Value 是否可见
+     *
+     * @public
+     * @returns Value 是否可见
+     */
+    getState_ValueVisible(): boolean;
+    /**
+     * 获取属性状态：字体
+     *
+     * @public
+     * @returns 字体
+     */
+    getState_FontFamily(): string;
+    /**
+     * 获取属性状态：字号
+     *
+     * @public
+     * @returns 字号
+     */
+    getState_FontSize(): number;
+    /**
+     * 获取属性状态：线宽
+     *
+     * @public
+     * @returns 线宽
+     */
+    getState_LineWidth(): number;
+    /**
+     * 获取属性状态：对齐模式
+     *
+     * @public
+     * @returns 对齐模式
+     */
+    getState_AlignMode(): EPCB_PrimitiveStringAlignMode;
+    /**
+     * 获取属性状态：旋转角度
+     *
+     * @public
+     * @returns 旋转角度
+     */
+    getState_Rotation(): number;
+    /**
+     * 获取属性状态：是否反相
+     *
+     * @public
+     * @returns 是否反相
+     */
+    getState_Reverse(): boolean;
+    /**
+     * 获取属性状态：反相扩展
+     *
+     * @public
+     * @returns 反相扩展
+     */
+    getState_Expansion(): number;
+    /**
+     * 获取属性状态：是否镜像
+     *
+     * @public
+     * @returns 是否镜像
+     */
+    getState_Mirror(): boolean;
+    /**
+     * 获取属性状态：是否锁定
+     *
+     * @public
+     * @returns 是否锁定
+     */
+    getState_PrimitiveLock(): boolean;
+    /**
+     * 设置属性状态：层
+     *
+     * @beta
+     * @param layer - 层
+     * @returns 属性图元对象
+     */
+    setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：坐标 X
+     *
+     * @beta
+     * @param x - 坐标 X
+     * @returns 属性图元对象
+     */
+    setState_X(x: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：坐标 Y
+     *
+     * @beta
+     * @param y - 坐标 Y
+     * @returns 属性图元对象
+     */
+    setState_Y(y: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：Key
+     *
+     * @beta
+     * @param key - Key
+     * @returns 属性图元对象
+     */
+    setState_Key(key: string): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：Value
+     *
+     * @beta
+     * @param value - Value
+     * @returns 属性图元对象
+     */
+    setState_Value(value: string): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：Key 是否可见
+     *
+     * @beta
+     * @param keyVisible - Key 是否可见
+     * @returns 属性图元对象
+     */
+    setState_KeyVisible(keyVisible: boolean): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：Value 是否可见
+     *
+     * @beta
+     * @param valueVisible - Value 是否可见
+     * @returns 属性图元对象
+     */
+    setState_ValueVisible(valueVisible: boolean): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：字体
+     *
+     * @beta
+     * @param fontFamily - 字体
+     * @returns 属性图元对象
+     */
+    setState_FontFamily(fontFamily: string): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：字号
+     *
+     * @beta
+     * @param fontSize - 字号
+     * @returns 属性图元对象
+     */
+    setState_FontSize(fontSize: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：线宽
+     *
+     * @beta
+     * @param lineWidth - 线宽
+     * @returns 属性图元对象
+     */
+    setState_LineWidth(lineWidth: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：对齐模式
+     *
+     * @beta
+     * @param alignMode - 对齐模式
+     * @returns 属性图元对象
+     */
+    setState_AlignMode(alignMode: EPCB_PrimitiveStringAlignMode): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：旋转角度
+     *
+     * @beta
+     * @param rotation - 旋转角度
+     * @returns 属性图元对象
+     */
+    setState_Rotation(rotation: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：是否反相
+     *
+     * @beta
+     * @param reverse - 是否反相
+     * @returns 属性图元对象
+     */
+    setState_Reverse(reverse: boolean): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：反相扩展
+     *
+     * @beta
+     * @param expansion - 反相扩展
+     * @returns 属性图元对象
+     */
+    setState_Expansion(expansion: number): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：是否镜像
+     *
+     * @beta
+     * @param mirror - 是否镜像
+     * @returns 属性图元对象
+     */
+    setState_Mirror(mirror: boolean): IPCB_PrimitiveAttribute;
+    /**
+     * 设置属性状态：是否锁定
+     *
+     * @beta
+     * @param primitiveLock - 是否锁定
+     * @returns 属性图元对象
+     */
+    setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveAttribute;
+    /**
+     * 将图元转换为异步图元
+     *
+     * @public
+     * @returns 属性图元对象
+     */
+    toAsync(): IPCB_PrimitiveAttribute;
+    /**
+     * 将图元转换为同步图元
+     *
+     * @public
+     * @returns 属性图元对象
+     */
+    toSync(): IPCB_PrimitiveAttribute;
+    /**
+     * 查询图元是否为异步图元
+     *
+     * @public
+     * @returns 是否为异步图元
+     */
+    isAsync(): boolean;
+    /* Excluded from this release type: reset */
+    /* Excluded from this release type: done */
+}
+
 /**
  * 器件图元
  *
@@ -3627,7 +3970,7 @@ declare class IPCB_PrimitiveDimension implements IPCB_Primitive {
      * 获取属性状态：尺寸标注类型
      *
      * @public
-     * @returns 尺寸标注类型
+     * @returns 尺寸���注类型
      */
     getState_DimensionType(): EPCB_PrimitiveDimensionType;
     /**
@@ -5428,7 +5771,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      * @returns 覆铜边框图元对象
      */
     done(): Promise<IPCB_PrimitivePour>;
-    /* Excluded from this release type: getCopperRegion */
+    /* Excluded from this release type: getCopperRegions */
     /* Excluded from this release type: rebuildCopperRegion */
     /**
      * 转换到：填充图元(默认是填充区域)
@@ -6178,7 +6521,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      *
      * @beta
      * @param designRuleBlindViaName - 盲埋孔设计规则项名称
-     * @returns 过孔���元对象
+     * @returns 过孔图元对象
      */
     setState_DesignRuleBlindViaName(designRuleBlindViaName: string | null): IPCB_PrimitiveVia;
     /**
@@ -6833,7 +7176,7 @@ declare class ISCH_PrimitiveCircle implements ISCH_Primitive {
      */
     toSync(): ISCH_PrimitiveCircle;
     /**
-     * 查询���元是否为异步图元
+     * 查询图元是否为异步图元
      *
      * @public
      * @returns 是否为异步图元
@@ -8762,7 +9105,7 @@ declare interface ITableColum {
  */
 declare class LIB_3DModel {
     /**
-     * 创建 3D 模型
+     * ��建 3D 模型
      *
      * @beta
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
@@ -9612,7 +9955,7 @@ declare class PCB_Document {
         y: number;
     }>;
     /**
-     * 获取画布原点相对于数据原点的偏移坐标
+     * 获取画布原点相对于数据原��的偏移坐标
      *
      * @public
      * @remarks
@@ -10037,7 +10380,7 @@ declare class PCB_Drc {
      * @returns 操作是否成功
      * @example 有三种不同的用法，确保画布上已有对应的焊盘。 分别是 一，游离焊盘-游离焊盘；二，器件焊盘 - 器件焊盘；三，器件焊盘 - 游离焊盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离焊盘
-     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','R1:2']) // 器件焊盘 - 器件焊盘
+     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','R1:2']) // ���件焊盘 - 器件焊盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','e1']) // 器件焊盘 - 游离焊盘
      */
     addPadPairToPadPairGroup(padPairGroupName: string, padPair: [string, string] | Array<[string, string]>): Promise<boolean>;
@@ -10880,6 +11223,21 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
     getAll(net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveArc>>;
 }
 
+/**
+ * PCB & 封装 / 属性图元类
+ *
+ * @public
+ */
+declare class PCB_PrimitiveAttribute implements IPCB_PrimitiveAPI {
+    /* Excluded from this release type: create */
+    /* Excluded from this release type: delete */
+    /* Excluded from this release type: modify */
+    /* Excluded from this release type: get */
+    /* Excluded from this release type: get */
+    /* Excluded from this release type: getAllPrimitiveId */
+    /* Excluded from this release type: getAll */
+}
+
 /**
  * PCB & 封装 / 器件图元类
  *
@@ -13680,7 +14038,7 @@ declare class SYS_FileManager {
     getDeviceFileByDeviceUuid(deviceUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
     /* Excluded from this release type: getSymbolFileBySymbolUuid */
     /**
-     * 使用封装 UUID 获取封���文件
+     * 使用封装 UUID 获取封装文件
      *
      * @beta
      * @remarks
@@ -13756,14 +14114,115 @@ declare class SYS_FileSystem {
      * @param fileName - 文件名称
      */
     saveFile(fileData: File | Blob, fileName?: string): Promise<void>;
-    /* Excluded from this release type: readFileFromFileSystem */
-    /* Excluded from this release type: saveFileToFileSystem */
-    /* Excluded from this release type: listFilesOfFileSystem */
-    /* Excluded from this release type: deleteFileInFileSystem */
-    /* Excluded from this release type: getEdaPath */
-    /* Excluded from this release type: getDocumentsPath */
-    /* Excluded from this release type: getLibrariesPaths */
-    /* Excluded from this release type: getProjectsPaths */
+    /**
+     * 从文件系统读取文件
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @param uri - 文件资源定位符，需要包含完整的文件名称的绝对路径
+     * @returns File 格式文件
+     */
+    readFileFromFileSystem(uri: string): Promise<File | undefined>;
+    /**
+     * 向文件系统写入文件
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @param uri - 文件资源定位符
+     *
+     * 如若结尾为斜杠 `/`（Windows 为反斜杠 `\`），则识别为文件夹；
+     *
+     * 如若结尾非斜杠，则识别为完整文件名，此时 `fileName` 参数将被忽略
+     * @param fileData - 文件数据
+     * @param fileName - 文件名称
+     * @param force - 强制写入（文件存在则覆盖文件）
+     * @returns 写入操作是否成功，如若不允许覆盖但文件已存在将返回 `false` 的结果
+     */
+    saveFileToFileSystem(uri: string, fileData: File | Blob, fileName?: string, force?: boolean): Promise<boolean>;
+    /**
+     * 查看文件系统路径下的文件列表
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @param folderPath - 目录路径
+     * @param recursive - 是否递归获取所有子文件
+     * @returns 当前目录下的文件列表
+     */
+    listFilesOfFileSystem(folderPath: string, recursive?: boolean): Promise<Array<ISYS_FileSystemFileList>>;
+    /**
+     * 删除文件系统内的文件
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @param uri - 文件资源定位符
+     *
+     * 如若结尾为斜杠 `/`（Windows 为反斜杠 `\`），则识别为文件夹；
+     *
+     * 如若结尾非斜杠，则识别为完整文件名，此时 `fileName` 参数将被忽略
+     * @param force - 强制删除文件夹（当欲删除的是文件夹且文件夹内有文件时，是否强制删除该文件夹）
+     * @returns 删除操作是否成功
+     */
+    deleteFileInFileSystem(uri: string, force?: boolean): Promise<boolean>;
+    /**
+     * 获取 EDA 文档目录路径
+     *
+     * @beta
+     * @remarks
+     * 返回的路径中，结尾不包含斜杠 `/`（或反斜杠 `\`）
+     *
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @returns EDA 文档目录路径
+     */
+    getEdaPath(): Promise<string>;
+    /**
+     * 获取文档目录路径
+     *
+     * @beta
+     * @remarks
+     * 返回的路径中，结尾不包含斜杠 `/`（或反斜杠 `\`）
+     *
+     * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @returns 文档目录路径
+     */
+    getDocumentsPath(): Promise<string>;
+    /**
+     * 获取库目录路径
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅全离线客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @returns 库目录路径数组
+     */
+    getLibrariesPaths(): Promise<Array<string>>;
+    /**
+     * 获取工程目录路径
+     *
+     * @beta
+     * @remarks
+     * 注意 1：本接口仅离线客户端有效，在浏览器环境内调用将始终 `throw Error`
+     *
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
+     * @returns 工程目录路径数组
+     */
+    getProjectsPaths(): Promise<Array<string>>;
 }
 
 /**
@@ -14238,7 +14697,7 @@ declare class SYS_ShortcutKey {
 }
 
 /**
- * 系统 / 存储类
+ * 系统 / 存���类
  *
  * @public
  * @remarks 可以进行扩展的用户配置存储、浏览器本地存储的操作接口
@@ -14632,7 +15091,7 @@ declare type TPCB_LayersOfLine = TPCB_LayersOfCopper | TPCB_LayersOfCustom | EPC
 declare type TPCB_LayersOfObject = EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.DOCUMENT;
 
 /**
- * 焊盘所属层
+ * 焊盘所���层
  *
  * @public
  */

package/package.json

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