@jlceda/pro-api-types 0.2.26 → 0.2.27

package/index.d.ts

@@ -2331,7 +2331,7 @@ declare global {
 	     *
 	     * @alpha
 	     * @remarks
-	     * 注意：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
+	     * 注意：本接口仅全离线客户端有效，在浏览器环境内调用将始终 `throw Error`
 	     * @param properties - 属性
 	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
 	     * @param classification - 分类，默认为全部
@@ -3361,7 +3361,7 @@ declare global {
 	     * 即 `setCanvasOrigin(0, 0)`；
 	     *
 	     * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
-	     * @param offsetX - 画布原点相对于数���原点的 X 坐标偏移
+	     * @param offsetX - 画布原点相���于数据原点的 X 坐标偏移
 	     * @param offsetY - 画布原点相对于数据原点的 Y 坐标偏移
 	     * @returns 操作是否成功
 	     */
@@ -5440,6 +5440,15 @@ declare global {
 	     * ```
 	     */
 	    getAutoRouteJsonFile(fileName?: string): Promise<File | undefined>;
+	    /**
+	     * 获取 JRouter 专用自动布线文件（JSON）
+	     *
+	     * @beta
+	     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+	     * @param fileName - 文件名
+	     * @returns 自动布线 JSON 文件数据
+	     */
+	    getAutoRouteJsonFileForJRouter(fileName?: string): Promise<File | undefined>;
 	    /**
 	     * 获取自动布局文件（JSON）
 	     *
@@ -5528,7 +5537,7 @@ declare global {
 	     * @remarks 本接口暂时只支持交互式检查，入参暂无作用，预留后续开发
 	     * @param interactive - 是否启用交互式检查
 	     *
-	     * 如���启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
+	     * 如若启用，则会存在弹窗等待用户进行交互，且无法使用 `ignoreWarning` 参数忽略警告，
 	     * 即 `ignoreWarning` 参数将被忽略；
 	     *
 	     * 如若禁用，则在调用后不会有任何 EDA 内部弹窗，程序执行静默检查，
@@ -5980,7 +5989,7 @@ declare global {
 	     */
 	    unhighlightNet(net: string): Promise<boolean>;
 	    /**
-	     * 取消高亮所有网络
+	     * 取消高亮��有网络
 	     *
 	     * @beta
 	     * @returns 操作是否成功
@@ -5998,7 +6007,7 @@ declare global {
 	     * 更新网表
 	     *
 	     * @public
-	     * @param type - ��表格式
+	     * @param type - 网表格式
 	     * @param netlist - 网表数据
 	     */
 	    setNetlist(type: ESYS_NetlistType | undefined, netlist: string): Promise<boolean>;
@@ -7116,7 +7125,7 @@ declare global {
 	     * 获取文本
 	     *
 	     * @alpha
-	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的��元对象
 	     * @param primitiveIds - 文本的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 文本图元对象，空数组表示获取失败
 	     */
@@ -8873,7 +8882,7 @@ declare global {
 	     */
 	    getState_Polygon(): IPCB_Polygon;
 	    /**
-	     * 获取属性状态：线宽
+	     * ��取属性状态：线宽
 	     *
 	     * @public
 	     * @returns 线宽
@@ -11047,7 +11056,7 @@ declare global {
 	     * 获取属性状态：图元类型
 	     *
 	     * @public
-	     * @returns 图元类型
+	     * @returns 图元类���
 	     */
 	    getState_PrimitiveType(): EPCB_PrimitiveType;
 	    /**
@@ -11065,7 +11074,7 @@ declare global {
 	     */
 	    getState_X(): number;
 	    /**
-	     * ��取属性状态：BBox 左上点坐标 Y
+	     * 获取属性状态：BBox 左上点坐标 Y
 	     *
 	     * @public
 	     * @returns BBox 左上点坐标 Y
@@ -13235,7 +13244,7 @@ declare global {
 	     */
 	    getState_PrimitiveType(): ESCH_PrimitiveType;
 	    /**
-	     * 获取属性���态：图元 ID
+	     * 获取属性状态：图元 ID
 	     *
 	     * @public
 	     * @returns 图元 ID
@@ -14406,7 +14415,7 @@ declare global {
 	 *
 	 * @public
 	 * @remarks
-	 * 器件引脚图元是一个特殊的图元，它指的是在原理图画布上关联到符号的引脚
+	 * 器件引脚图元是一个特��的图元，它指的是在原理图画布上关联到符号的引脚
 	 *
 	 * 器件引脚图元仅可更改 `pinNumber`、`noConnected` 属性，其它所有属性均为只读，
 	 * 并且你只能通过 {@link SCH_PrimitiveComponent.getAllPinsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link ISCH_PrimitiveComponent.getAllPins | 器件图元的 getAllPins 方法} 获取到器件引脚图元
@@ -16156,6 +16165,301 @@ declare global {
 	    private setState_CbbSymbol;
 	}
 
+	/**
+	 * 原理图 & 符号 / 二进制内嵌对象图元类
+	 *
+	 * @public
+	 */
+	class SCH_PrimitiveObject implements ISCH_PrimitiveAPI {
+	    /**
+	     * 创建二进制内嵌对象
+	     *
+	     * @alpha
+	     * @param startX - 起点坐标 X
+	     * @param startY - 起点坐标 Y
+	     * @param width - 宽
+	     * @param height - 高
+	     * @param rotation - 旋转角度
+	     * @param mirror - 是否镜像
+	     * @param fileName - 文件名称
+	     * @param content - 对象内容
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    create(content: File | string, startX: number, startY: number, width?: number, height?: number, rotation?: number, mirror?: boolean, fileName?: string): Promise<ISCH_PrimitiveObject | undefined>;
+	    /**
+	     * 删除二进制内嵌对象
+	     *
+	     * @alpha
+	     * @param primitiveIds - 二进制内嵌对象的图元 ID 或二进制内嵌对象图元对象
+	     * @returns 删除操作是否成功
+	     */
+	    delete(primitiveIds: string | ISCH_PrimitiveObject | Array<string> | Array<ISCH_PrimitiveObject>): Promise<boolean>;
+	    /**
+	     * 修改二进制内嵌对象
+	     *
+	     * @alpha
+	     * @param primitiveId - 图元 ID
+	     * @param property - 修改参数
+	     * @returns 二进制内嵌对象图元对象，`undefined` 表示修改失败
+	     */
+	    modify(primitiveId: string | ISCH_PrimitiveObject, property: {
+	        content?: File | string;
+	        startX?: number;
+	        startY?: number;
+	        width?: number;
+	        height?: number;
+	        rotation?: number;
+	        mirror?: boolean;
+	        fileName?: string;
+	    }): Promise<ISCH_PrimitiveObject | undefined>;
+	    /**
+	     * 获取二进制内嵌对象
+	     *
+	     * @alpha
+	     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+	     * @returns 二进制内嵌对象图元对象，`undefined` 表示获取失败
+	     */
+	    get(primitiveIds: string): Promise<ISCH_PrimitiveObject | undefined>;
+	    /**
+	     * 获取二进制内嵌对象
+	     *
+	     * @alpha
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+	     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+	     * @returns 二进制内嵌对象图元对象，空数组表示获取失败
+	     */
+	    get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveObject>>;
+	    /**
+	     * 获取所有二进制内嵌对象的图元 ID
+	     *
+	     * @alpha
+	     * @returns 二进制内嵌对象的图元 ID 数组
+	     */
+	    getAllPrimitiveId(): Promise<Array<string>>;
+	    /**
+	     * 获取所有二进制内嵌对象
+	     *
+	     * @alpha
+	     * @returns 二进制内嵌对象图元对象数组
+	     */
+	    getAll(): Promise<Array<ISCH_PrimitiveObject>>;
+	}
+	/**
+	 * 二进制内嵌对象图元
+	 *
+	 * @public
+	 */
+	class ISCH_PrimitiveObject implements ISCH_Primitive {
+	    /** 异步 */
+	    private async;
+	    /** 图元类型 */
+	    private readonly primitiveType;
+	    /** 图元 ID */
+	    private primitiveId?;
+	    /** 对象内容 */
+	    private content;
+	    /** 起点坐标 X */
+	    private startX;
+	    /** 起点坐标 Y */
+	    private startY;
+	    /** 宽度 */
+	    private width;
+	    /** 高度 */
+	    private height;
+	    /** 旋转角度 */
+	    private rotation;
+	    /** 是否镜像 */
+	    private mirror;
+	    /** 文件名称 */
+	    private fileName;
+	    /** @internal */
+	    constructor(content: File | string, startX: number, startY: number, width?: number, height?: number, rotation?: number, mirror?: boolean, fileName?: string, primitiveId?: string);
+	    /**
+	     * 在原理图画布中创建图元
+	     *
+	     * @internal
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    create(): Promise<ISCH_PrimitiveObject>;
+	    /**
+	     * 将 File 对象转换为 base64 字符串
+	     *
+	     * @internal
+	     * @param file - File 对象
+	     * @returns base64 字符串
+	     */
+	    private fileToBase64;
+	    /**
+	     * 获取属性状态：图元类型
+	     *
+	     * @public
+	     * @returns 图元类型
+	     */
+	    getState_PrimitiveType(): ESCH_PrimitiveType;
+	    /**
+	     * 获取属性状态：图元 ID
+	     *
+	     * @public
+	     * @returns 图元 ID
+	     */
+	    getState_PrimitiveId(): string;
+	    /**
+	     * 获取属性状态：对象内容
+	     *
+	     * @public
+	     * @returns 对象内容
+	     */
+	    getState_Content(): File | string;
+	    /**
+	     * 获取属性状态：坐标 X
+	     *
+	     * @public
+	     * @returns 坐标 X
+	     */
+	    getState_StartX(): number;
+	    /**
+	     * 获取属性状态：坐标 Y
+	     *
+	     * @public
+	     * @returns 坐标 Y
+	     */
+	    getState_StartY(): number;
+	    /**
+	     * 获取属性状态：宽度
+	     *
+	     * @public
+	     * @returns 宽度
+	     */
+	    getState_Width(): number;
+	    /**
+	     * 获取属性状态：高度
+	     *
+	     * @public
+	     * @returns 高度
+	     */
+	    getState_Height(): number;
+	    /**
+	     * 获取属性状态：旋转角度
+	     *
+	     * @public
+	     * @returns 旋转角度
+	     */
+	    getState_Rotation(): number;
+	    /**
+	     * 获取属性状态：是否镜像
+	     *
+	     * @public
+	     * @returns 是否镜像
+	     */
+	    getState_Mirror(): boolean;
+	    /**
+	     * 获取属性状态：文件名称
+	     *
+	     * @public
+	     * @returns 文件名称
+	     */
+	    getState_FileName(): string;
+	    /**
+	     * 设置属性状态：对象内容
+	     *
+	     * @beta
+	     * @param content - 对象内容
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_Content(content: File | string): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：起点坐标 X
+	     *
+	     * @beta
+	     * @param startX - 起点坐标 X
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_StartX(startX: number): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：起点坐标 Y
+	     *
+	     * @beta
+	     * @param startY - 起点坐标 Y
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_StartY(startY: number): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：宽度
+	     *
+	     * @beta
+	     * @param width - 宽度
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_Width(width: number): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：高度
+	     *
+	     * @beta
+	     * @param height - 高度
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_Height(height: number): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：旋转角度
+	     *
+	     * @beta
+	     * @param rotation - 旋转角度
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_Rotation(rotation: number): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：是否镜像
+	     *
+	     * @beta
+	     * @param mirror - 是否镜像
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_Mirror(mirror: boolean): ISCH_PrimitiveObject;
+	    /**
+	     * 设置属性状态：文件名称
+	     *
+	     * @beta
+	     * @param fileName - 文件名称
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    setState_FileName(fileName: string): ISCH_PrimitiveObject;
+	    /**
+	     * 将图元转换为异步图元
+	     *
+	     * @public
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    toAsync(): ISCH_PrimitiveObject;
+	    /**
+	     * 将图元转换为同步图元
+	     *
+	     * @public
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    toSync(): ISCH_PrimitiveObject;
+	    /**
+	     * 查询图元是否为异步图元
+	     *
+	     * @public
+	     * @returns 是否为异步图元
+	     */
+	    isAsync(): boolean;
+	    /**
+	     * 将异步图元重置为当前画布状态
+	     *
+	     * @alpha
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    reset(): Promise<ISCH_PrimitiveObject>;
+	    /**
+	     * 将对图元的更改应用到画布
+	     *
+	     * @alpha
+	     * @returns 二进制内嵌对象图元对象
+	     */
+	    done(): Promise<ISCH_PrimitiveObject>;
+	}
+
 	/**
 	 * 原理图 & 符号 / 多边形（折线）图元类
 	 *
@@ -18011,7 +18315,7 @@ declare global {
 	     */
 	    listFilesOfFileSystem(folderPath: string, recursive?: boolean): Promise<Array<ISYS_FileSystemFileList>>;
 	    /**
-	     * 删除文件系统内���文件
+	     * 删除文件系统内的文件
 	     *
 	     * @beta
 	     * @remarks
@@ -18069,7 +18373,7 @@ declare global {
 	     *
 	     * @beta
 	     * @remarks
-	     * 注意 1：本接口仅离线客户端有效，在浏览器环境内调用将始终 `throw Error`
+	     * 注意 1：本接口仅半、全离线客户端有效，在浏览器环境内调用将始终 `throw Error`
 	     *
 	     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
 	     * @returns 工程目录路径数组
@@ -19535,7 +19839,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param netlist1 - 网表 1，可以为：①当前工程内的原理图、PCB 的 UUID；②其它工程的工程 UUID 和原理图、PCB UUID；③原理图、PCB 文件数据
-	     * @param netlist2 - ���表 2，可以为：①当前工程内的原理图、PCB 的 UUID；②其它工程的工程 UUID 和原理图、PCB UUID；③原理图、PCB 文件数据
+	     * @param netlist2 - 网表 2，可以为：①当前工程内的原理图、PCB 的 UUID；②其它工程的工程 UUID 和原理图、PCB UUID；③原理图、PCB 文件数据
 	     * @returns 网表对比结果
 	     */
 	    netlistComparison(netlist1: string | {
@@ -19838,6 +20142,7 @@ declare global {
 	    sch_SelectControl: SCH_SelectControl;
 	    sch_SimulationEngine: SCH_SimulationEngine;
 	    sch_Utils: SCH_Utils;
+	    sch_PrimitiveObject: SCH_PrimitiveObject;
 	    sys_ClientUrl: SYS_ClientUrl;
 	    sys_Dialog: SYS_Dialog;
 	    sys_Environment: SYS_Environment;

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.26", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
+{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.27", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }