@jlceda/pro-api-types 0.1.132 → 0.1.134

package/index.d.ts

@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
      *
      * @beta
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param libraryType - ��类型，支持符号和封装
+     * @param libraryType - 库类型，支持符号和封装
      * @param uuid - 符号、封装 UUID
      * @param splitScreenId - 分屏 ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
      * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
@@ -479,7 +479,7 @@ declare class DMT_Pcb {
      * 删除 PCB
      *
      * @public
-     * @remarks 如若 PCB 已关联复用模块（在工程库内存在同名的复用模块符号），则删除 PCB 时将同步删除关联的原��图和复用模块符号，复用模块符号不可删除则跳过
+     * @remarks 如若 PCB 已关联复用模块（在工程库内存在同名的复用模块符号），则删除 PCB 时将同步删除关联的原理图和复用模块符号，复用模块符号不可删除则跳过
      * @param pcbUuid - PCB UUID
      * @returns 操作是否成功
      */
@@ -848,6 +848,7 @@ declare class EDA {
     pcb_PrimitivePour: PCB_PrimitivePour;
     pcb_PrimitivePoured: PCB_PrimitivePoured;
     pcb_PrimitiveRegion: PCB_PrimitiveRegion;
+    pcb_PrimitiveString: PCB_PrimitiveString;
     pcb_PrimitiveVia: PCB_PrimitiveVia;
     pcb_SelectControl: PCB_SelectControl;
     pnl_Document: PNL_Document;
@@ -1499,6 +1500,32 @@ declare enum EPCB_PrimitiveRegionRuleType {
     FOLLOW_REGION_RULE = 9
 }
 
+/**
+ * 文本对齐模式
+ *
+ * @public
+ */
+declare enum EPCB_PrimitiveStringAlignMode {
+    /** 左上 */
+    LEFT_TOP = "LEFT_TOP",
+    /** 中上 */
+    CENTER_TOP = "CENTER_TOP",
+    /** 右上 */
+    RIGHT_TOP = "RIGHT_TOP",
+    /** 左中 */
+    LEFT_MIDDLE = "LEFT_MIDDLE",
+    /** 中心 */
+    CENTER = "CENTER_MIDDLE",
+    /** 右中 */
+    RIGHT_MIDDLE = "RIGHT_MIDDLE",
+    /** 左下 */
+    LEFT_BOTTOM = "LEFT_BOTTOM",
+    /** 中下 */
+    CENTER_BOTTOM = "CENTER_BOTTOM",
+    /** 右下 */
+    RIGHT_BOTTOM = "RIGHT_BOTTOM"
+}
+
 /**
  * 图元类型
  *
@@ -1532,7 +1559,9 @@ declare enum EPCB_PrimitiveType {
     /** 二进制内嵌对象 */
     OBJECT = "Object",
     /** 覆铜填充 */
-    POURED = "Poured"
+    POURED = "Poured",
+    /** 文本 */
+    STRING = "String"
 }
 
 /**
@@ -3030,7 +3059,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      */
     getState_PrimitiveLock(): boolean;
     /**
-     * 设置属性��态：网络名称
+     * 设置属性状态：网络名称
      *
      * @beta
      * @param net - 网络名称
@@ -3773,7 +3802,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
     private complexPolygon;
     /** 网络名称 */
     private net?;
-    /** 填充模式 */
+    /** 填充��式 */
     private fillMode?;
     /** 线宽 */
     private lineWidth?;
@@ -3995,14 +4024,14 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @public
      * @returns BBox 左上点坐标 X
      */
-    getState_X(): number | undefined;
+    getState_X(): number;
     /**
      * 获取属性状态：BBox 左上点坐标 Y
      *
      * @public
      * @returns BBox 左上点坐标 Y
      */
-    getState_Y(): number | undefined;
+    getState_Y(): number;
     /**
      * 获取属性状态：图像源数据（复杂多边形）
      *
@@ -4016,35 +4045,35 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * @public
      * @returns 层
      */
-    getState_Layer(): TPCB_LayersOfImage | undefined;
+    getState_Layer(): TPCB_LayersOfImage;
     /**
      * 获取属性状态：宽
      *
      * @public
      * @returns 宽
      */
-    getState_Width(): number | undefined;
+    getState_Width(): number;
     /**
      * 获取属性状态：高
      *
      * @public
      * @returns 高
      */
-    getState_Height(): number | undefined;
+    getState_Height(): number;
     /**
      * 获取属性状态：旋转角度
      *
      * @public
      * @returns 旋转角度
      */
-    getState_Rotation(): number | undefined;
+    getState_Rotation(): number;
     /**
      * 获取属性状态：是否水平镜像
      *
      * @public
      * @returns 是否水平镜像
      */
-    getState_HorizonMirror(): boolean | undefined;
+    getState_HorizonMirror(): boolean;
     /**
      * 获取属性状态：是否锁定
      *
@@ -5742,6 +5771,314 @@ declare interface IPCB_PrimitiveSolderMaskAndPasteMaskExpansion {
     bottomPasteMask?: number;
 }
 
+/**
+ * 文本图元
+ *
+ * @public
+ */
+declare class IPCB_PrimitiveString implements IPCB_Primitive {
+    /** 异步 */
+    private async;
+    /** 图元类型 */
+    private readonly primitiveType;
+    /** 图元 ID */
+    private primitiveId?;
+    /** 层 */
+    private layer;
+    /** 坐标 X */
+    private x;
+    /** 坐标 Y */
+    private y;
+    /** 文本内容 */
+    private text;
+    /** 字体 */
+    private fontFamily;
+    /** 字号 */
+    private fontSize;
+    /** 线宽 */
+    private lineWidth;
+    /** 是否加粗 */
+    private bold;
+    /** 是否斜体 */
+    private italic;
+    /** 对齐模式 */
+    private alignMode;
+    /** 旋转角度 */
+    private rotation;
+    /** 是否反相 */
+    private reverse;
+    /** 反相扩展 */
+    private expansion;
+    /** 是否镜像 */
+    private mirror;
+    /** 是否锁定 */
+    private primitiveLock;
+    constructor(layer: TPCB_LayersOfImage, x: number, y: number, text: string, fontFamily?: string, fontSize?: number, lineWidth?: number, bold?: boolean, italic?: boolean, alignMode?: EPCB_PrimitiveStringAlignMode, rotation?: number, reverse?: boolean, expansion?: number, mirror?: boolean, primitiveLock?: boolean, primitiveId?: string);
+    /* Excluded from this release type: create */
+    /**
+     * 获取属性状态：图元类型
+     *
+     * @public
+     * @returns 图元类型
+     */
+    getState_PrimitiveType(): EPCB_PrimitiveType;
+    /**
+     * 获取属性状态：图元 ID
+     *
+     * @public
+     * @returns 图元 ID
+     */
+    getState_PrimitiveId(): string;
+    /**
+     * 获取属性状态：层
+     *
+     * @public
+     * @returns 层
+     */
+    getState_Layer(): TPCB_LayersOfImage;
+    /**
+     * 获取属性状态：坐标 X
+     *
+     * @public
+     * @returns 坐标 X
+     */
+    getState_X(): number;
+    /**
+     * 获取属性状态：坐标 Y
+     *
+     * @public
+     * @returns 坐标 Y
+     */
+    getState_Y(): number;
+    /**
+     * 获取属性状态：文本内容
+     *
+     * @public
+     * @returns 文本内容
+     */
+    getState_Text(): string;
+    /**
+     * 获取属性状态：字体
+     *
+     * @public
+     * @returns 字体
+     */
+    getState_FontFamily(): string;
+    /**
+     * 获取属性状态：字号
+     *
+     * @public
+     * @returns 字号
+     */
+    getState_FontSize(): number;
+    /**
+     * 获取属性状态：线宽
+     *
+     * @public
+     * @returns 线宽
+     */
+    getState_LineWidth(): number;
+    /**
+     * 获取属性状态：是否加粗
+     *
+     * @public
+     * @returns 是否加粗
+     */
+    getState_Bold(): boolean;
+    /**
+     * 获取属性状态：是否斜体
+     *
+     * @public
+     * @returns 是否斜体
+     */
+    getState_Italic(): boolean;
+    /**
+     * 获取属性状态：对齐模式
+     *
+     * @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_PrimitiveString;
+    /**
+     * 设置属性状态：坐标 X
+     *
+     * @beta
+     * @param x - 坐标 X
+     * @returns 文本图元对象
+     */
+    setState_X(x: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：坐标 Y
+     *
+     * @beta
+     * @param y - 坐标 Y
+     * @returns 文本图元对象
+     */
+    setState_Y(y: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：文本内容
+     *
+     * @beta
+     * @param text - 文本内容
+     * @returns 文本图元对象
+     */
+    setState_Text(text: string): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：字体
+     *
+     * @beta
+     * @param fontFamily - 字体
+     * @returns 文本图元对象
+     */
+    setState_FontFamily(fontFamily: string): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：字号
+     *
+     * @beta
+     * @param fontSize - 字号
+     * @returns 文本图元对象
+     */
+    setState_FontSize(fontSize: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：线宽
+     *
+     * @beta
+     * @param lineWidth - 线宽
+     * @returns 文本图元对象
+     */
+    setState_LineWidth(lineWidth: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：是否加粗
+     *
+     * @beta
+     * @param bold - 是否加粗
+     * @returns 文本图元对象
+     */
+    setState_Bold(bold: boolean): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：是否斜体
+     *
+     * @beta
+     * @param italic - 是否斜体
+     * @returns 文本图元对象
+     */
+    setState_Italic(italic: boolean): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：对齐模式
+     *
+     * @beta
+     * @param alignMode - 对齐模式
+     * @returns 文本图元对象
+     */
+    setState_AlignMode(alignMode: EPCB_PrimitiveStringAlignMode): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：旋转角度
+     *
+     * @beta
+     * @param rotation - 旋转角度
+     * @returns 文本图元对象
+     */
+    setState_Rotation(rotation: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：是否反相
+     *
+     * @beta
+     * @param reverse - 是否反相
+     * @returns 文本图元对象
+     */
+    setState_Reverse(reverse: boolean): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：反相扩展
+     *
+     * @beta
+     * @param expansion - 反相扩展
+     * @returns 文本图元对象
+     */
+    setState_Expansion(expansion: number): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：是否镜像
+     *
+     * @beta
+     * @param mirror - 是否镜像
+     * @returns 文本图元对象
+     */
+    setState_Mirror(mirror: boolean): IPCB_PrimitiveString;
+    /**
+     * 设置属性状态：是否锁定
+     *
+     * @beta
+     * @param primitiveLock - 是否锁定
+     * @returns 文本图元对象
+     */
+    setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveString;
+    /**
+     * 将图元转换为异步图元
+     *
+     * @public
+     * @returns 文本图元对象
+     */
+    toAsync(): IPCB_PrimitiveString;
+    /**
+     * 将图元转换为同步图元
+     *
+     * @public
+     * @returns 文本图元对象
+     */
+    toSync(): IPCB_PrimitiveString;
+    /**
+     * 查询图元是否为异步图元
+     *
+     * @public
+     * @returns 是否为异步图元
+     */
+    isAsync(): boolean;
+    /* Excluded from this release type: reset */
+    /* Excluded from this release type: done */
+}
+
 /**
  * 过孔图元
  *
@@ -7928,7 +8265,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
      */
     setState_CornerRadius(cornerRadius: number): ISCH_PrimitiveRectangle;
     /**
-     * 设置属性状态：旋转角度
+     * 设���属性状态：旋转角度
      *
      * @beta
      * @param rotation - 旋转角度
@@ -8265,7 +8602,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
 }
 
 /**
- * 导��图元
+ * 导线图元
  *
  * @public
  */
@@ -9734,7 +10071,7 @@ declare class PCB_Drc {
      * @example 有三种不同的用法，确保画布上已有对应的焊盘。 分别是 一，游离焊盘-游离焊盘；二，器件焊盘 - 器件焊盘；三，器件焊盘 - 游离焊盘
      * await eda.pcb_Drc.createPadPairGroup('test',[['e0','e1']]) // 游离焊盘-游离焊盘
      * await eda.pcb_Drc.createPadPairGroup('test',[['R1:1','R1:2'],['R2:1','R2:2']]) // 器件焊盘 - 器件焊盘
-     * await eda.pcb_Drc.createPadPairGroup('test',[['R1:1','e0'],['R1:2','e1']]) // 器件焊盘 - 游离焊盘
+     * await eda.pcb_Drc.createPadPairGroup('test',[['R1:1','e0'],['R1:2','e1']]) // 器件���盘 - 游离焊盘
      */
     createPadPairGroup(padPairGroupName: string, padPairs: Array<[string, string]>): Promise<boolean>;
     /**
@@ -9959,7 +10296,14 @@ declare class PCB_Layer {
      * @returns 所有图层的详细属性
      */
     getAllLayers(): Promise<Array<IPCB_LayerItem>>;
-    /* Excluded from this release type: setInactiveLayerDisplayMode */
+    /**
+     * 设置非激活层展示模式
+     *
+     * @beta
+     * @param displayMode - 展示模式
+     * @returns 是否设置成功
+     */
+    setInactiveLayerDisplayMode(displayMode?: EPCB_InactiveLayerDisplayMode): Promise<boolean>;
 }
 
 /**
@@ -10293,7 +10637,7 @@ declare class PCB_ManufactureData {
      * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
      * 即 `ignoreWarning` 参数将被忽略；
      *
-     * 如若���用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
+     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
      * 如若达成下单条件，将返回 `true` 并在新标签页打开下单页面
      * @param ignoreWarning - 在非交互式检查时忽略警告
      *
@@ -11510,6 +11854,21 @@ declare class PCB_PrimitiveRegion implements IPCB_PrimitiveAPI {
     getAll(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveRegion>>;
 }
 
+/**
+ * PCB & 封装 / 文本图元类
+ *
+ * @public
+ */
+declare class PCB_PrimitiveString 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 & 封装 / 过孔图元类
  *
@@ -12477,7 +12836,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
         uuid: string;
     } | ILIB_DeviceItem | ILIB_DeviceSearchItem): Promise<boolean>;
     /**
-     * 设置在扩展 API 中 BI 网络端口关联的器件 UUID
+     * 设置在扩展 API 中 BI ��络端口关联的器件 UUID
      *
      * @beta
      * @param component - 关联库器件
@@ -14044,7 +14403,7 @@ declare class SYS_Timer {
      */
     setIntervalTimer(id: string, timeout: number, callFn: (...args: any) => void, ...args: any): boolean;
     /**
-     * 清除指定循环定时器
+     * 清除指定循���定时器
      *
      * @public
      * @param id - 定时器 ID
@@ -14310,7 +14669,7 @@ declare type TPCB_LayersOfDimension = TPCB_LayersOfCustom | EPCB_LayerId.TOP_SIL
 declare type TPCB_LayersOfFill = TPCB_LayersOfCopper | TPCB_LayersOfCustom | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.MULTI;
 
 /**
- * SVG 图像所属层
+ * 复杂多边形图（SVG 图像、文本）所属层
  *
  * @public
  */

package/package.json

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