@jlceda/pro-api-types 0.2.52 → 0.2.54

package/index.d.ts

@@ -525,15 +525,9 @@ declare global {
 	     * @alpha
 	     * @param properties - 属性
 	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
-	     * @param classification - 分类，默认为全部
-	     *
-	     * ADD since EDA v4
-	     * @param symbolType - 符号类型，默认为全部
-	     * @param itemsOfPage - 一页搜索结果的数量
-	     * @param page - 页数
 	     * @returns 搜索到的符号属性的列表
 	     */
-	    searchByProperties(properties: ILIB_SymbolPropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_SymbolSearchItem>;
+	    searchByProperties(properties: ILIB_SymbolPropertiesForSearch, libraryUuid?: string): Promise<Array<ILIB_SymbolSearchItem>>;
 	    /**
 	     * 在编辑器打开文档
 	     *
@@ -2446,7 +2440,7 @@ declare global {
 	     * @param page - 页数
 	     * @returns 搜索到的器件属性的列表
 	     */
-	    searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_DeviceSearchItem>;
+	    searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_DeviceSearchItem>>;
 	    /**
 	     * 使用立创 C 编号获取器件
 	     *
@@ -2622,14 +2616,9 @@ declare global {
 	     * @alpha
 	     * @param properties - 属性
 	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
-	     * @param classification - 分类，默认为全部
-	     *
-	     * ADD since EDA v4
-	     * @param itemsOfPage - 一页搜索结果的数量
-	     * @param page - 页数
 	     * @returns 搜索到的封装属性的列表
 	     */
-	    searchByProperties(properties: ILIB_FootprintPropertiesForSearch, libraryUuid?: string, classification?: Array<string>, itemsOfPage?: number, page?: number): Array<ILIB_FootprintSearchItem>;
+	    searchByProperties(properties: ILIB_FootprintPropertiesForSearch, libraryUuid?: string): Promise<Array<ILIB_FootprintSearchItem>>;
 	    /**
 	     * 在编辑器打开文档
 	     *
@@ -4403,7 +4392,7 @@ declare global {
 	     *
 	     * @public
 	     * @remarks
-	     * 本接口在前端画布上定位到指定的数据层面坐标；
+	     * 本接口在前端画布上定��到指定的数据层面坐标；
 	     *
 	     * 如果希望在进行本操作时前端画布坐标能与传入数据一致，
 	     * 建议调用 {@link PCB_Document.setCanvasOrigin} 方法并设置偏移量为零；
@@ -5119,7 +5108,7 @@ declare global {
 	    /**
 	     * 新增实时 DRC 结果事件监听
 	     *
-	     * @alpha
+	     * @beta
 	     * @remarks
 	     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
 	     * @param id - 事件 ID，用以防止重复注册事件
@@ -5129,6 +5118,45 @@ declare global {
 	    addRealTimeDrcResultEventListener(id: string, eventType: 'all', callFn: (eventType: undefined, props: [{
 	        drcResult: any;
 	    }]) => void | Promise<void>): void;
+	    /**
+	     * 新增光线追踪引擎 3D 预览点击材质事件监听
+	     *
+	     * @alpha
+	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     *
+	     * ADD since EDA v4
+	     * @param id - 事件 ID，用以防止重复注册事件
+	     * @param callFn - 事件触发时的回调函数
+	     * @param onlyOnce - 是否仅监听一次
+	     */
+	    addRayTracerEngine3DViewClickMaterialEventListener(id: string, callFn: (props: {
+	        materialId: number;
+	        material: any;
+	    }) => void | Promise<void>, onlyOnce?: boolean): void;
+	    /**
+	     * 新增光线追踪引擎 3D 预览相机变动（拖动 3D 模型）事件监听
+	     *
+	     * @alpha
+	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     *
+	     * ADD since EDA v4
+	     * @param id - 事件 ID，用以防止重复注册事件
+	     * @param callFn - 事件触发时的回调函数
+	     * @param onlyOnce - 是否仅监听一次
+	     */
+	    addRayTracerEngine3DViewCameraChangeEventListener(id: string, callFn: (props: {
+	        position: {
+	            x: number;
+	            y: number;
+	            z: number;
+	        };
+	        rotation: {
+	            x: number;
+	            y: number;
+	            z: number;
+	        };
+	        focalLength: number;
+	    }) => void | Promise<void>, onlyOnce?: boolean): void;
 	    /**
 	     * 移除事件监听
 	     *
@@ -5250,7 +5278,7 @@ declare global {
 	     * @param fileName - 文件名
 	     * @param password - 加密密码
 	     * @param fileType - 文件格式
-	     * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获取失败
+	     * @returns 文档文件数据，`undefined` 表示当前��打开文档或数据获取失败
 	     */
 	    getDocumentFile(fileName?: string, password?: string, fileType?: 'epro' | 'epro2'): Promise<File | undefined>;
 	    /**
@@ -7712,6 +7740,7 @@ declare global {
 	     * 设置属性状态：是否反相
 	     *
 	     * @beta
+	     * @remarks 默认字体不支持反相
 	     * @param reverse - 是否反相
 	     * @returns 文本图元对象
 	     */
@@ -8151,6 +8180,7 @@ declare global {
 	     * 设置属性状态：是否反相
 	     *
 	     * @beta
+	     * @remarks 默认字体不支持反相
 	     * @param reverse - 是否反相
 	     * @returns 属性图元对象
 	     */
@@ -10424,7 +10454,7 @@ declare global {
 	     * 获取器件
 	     *
 	     * @beta
-	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返���少于传入的图元 ID 数量的图元对象
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
 	     * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 器件图元对象，空数组表示获取失败
 	     */
@@ -11547,7 +11577,7 @@ declare global {
 	     * 查询图元是否为异步图元
 	     *
 	     * @public
-	     * @returns 是否为异步图元
+	     * @returns 是否为异步图���
 	     */
 	    isAsync(): boolean;
 	    /**
@@ -11586,7 +11616,7 @@ declare global {
 	     * @beta
 	     * @param layer - 层
 	     * @param topLeftX - 左上点 X
-	     * @param topLeftY - 左��点 Y
+	     * @param topLeftY - 左上点 Y
 	     * @param binaryData - 二进制数据
 	     * @param width - 宽
 	     * @param height - 高
@@ -11741,6 +11771,10 @@ declare global {
 	     * 获取属性状态：二进制数据
 	     *
 	     * @public
+	     * @remarks
+	     * 从画布取回的 `binaryData` 数据可能为 `hashId`，这是由于我们后端存储二进制内嵌对象数据的是对象存储，
+	     *
+	     * 对象存储以 `hashId` 作为索引，需要完整取回数据将会造成额外请求消耗性能
 	     * @returns 二进制数据
 	     */
 	    getState_BinaryData(): string;
@@ -11814,6 +11848,10 @@ declare global {
 	     * 设置属性状态：二进制数据
 	     *
 	     * @public
+	     * @remarks
+	     * 从画布重新取回的 `binaryData` 数据可能为 `hashId`，这是由于我们后端存储二进制内嵌对象数据的是对象存储，
+	     *
+	     * 对象存储以 `hashId` 作为索引，需要完整取回数据将会造成额外请求消耗性能
 	     * @param binaryData - 二进制数据
 	     * @returns 二进制内嵌对象图元对象
 	     */
@@ -11944,6 +11982,16 @@ declare global {
 	     * @param configurations - 渲染配置
 	     */
 	    setRenderConfigurations(configurations: any): Promise<void>;
+	    /**
+	     * 获取光线追踪渲染配置
+	     *
+	     * @beta
+	     * @remarks 本接口配置定义还在进行中
+	     *
+	     * ADD since EDA v4
+	     * @returns 渲染配置
+	     */
+	    getRenderConfigurations(): Promise<any>;
 	}
 
 	/**
@@ -14314,7 +14362,7 @@ declare global {
 	     */
 	    getState_LineType(): ESCH_PrimitiveLineType | null;
 	    /**
-	     * 获取属性状态：填充���式
+	     * 获取属性状态：填充样式
 	     *
 	     * @public
 	     * @returns 填充样式
@@ -14887,7 +14935,7 @@ declare global {
 	     * 设置属性状态：引脚类型
 	     *
 	     * @internal
-	     * @remarks 本��件引脚图元属性不支持修改，本接口调用将不会有任何效果
+	     * @remarks 本器件引脚图元属性不支持修改，本接口调用将不会有任何效果
 	     * @returns 器件引脚图元对象
 	     */
 	    setState_PinType(): ISCH_PrimitiveComponentPin;
@@ -16995,7 +17043,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param line - 坐标组
-	     * @returns ���边形图元对象
+	     * @returns 多边形图元对象
 	     */
 	    setState_Line(line: Array<number>): ISCH_PrimitivePolygon;
 	    /**
@@ -18085,7 +18133,7 @@ declare global {
 	    setCellStyle: (style: CSSProperties) => void;
 	    /** 设置行样式 */
 	    setRowStyle: (style: CSSProperties) => void;
-	    /** 设置所有单元格��式 */
+	    /** 设置所有单元格样式 */
 	    setAllCellStyle: (style: CSSProperties) => void;
 	    /** 设置行数据 */
 	    setRowData: (data: {
@@ -19532,7 +19580,7 @@ declare global {
 	     *
 	     * 本接口无法移除 {@link SYS_HeaderMenu.insertSystemHeaderMenus | 导入系统顶部菜单} 接口导入的系统顶部菜单项
 	     *
-	     * 本接口无法移除第一级菜单，`id` 数组请至少传递 `2` 个值
+	     * 本��口无法移除第一级菜单，`id` 数组请至少传递 `2` 个值
 	     *
 	     * 本接口无法移除 **高级** 菜单下的任何子菜单
 	     *
@@ -19561,7 +19609,7 @@ declare global {
 	     *
 	     * 本接口不能在 **高级** 菜单下新增任何子菜单
 	     *
-	     * 本接口新增的子菜单将默认排列在原菜单的结尾，除非���定了 `props.insertBefore` 参数
+	     * 本接口新增的子菜单将默认排列在原菜单的结尾，除非指定了 `props.insertBefore` 参数
 	     *
 	     * 注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
 	     *
@@ -20583,7 +20631,7 @@ declare global {
 	     */
 	    unregisterShortcutKey(shortcutKey: TSYS_ShortcutKeys): Promise<boolean>;
 	    /**
-	     * ��询快捷键列表
+	     * 查询快捷键列表
 	     *
 	     * @beta
 	     * @param includeSystem - 是否包含系统快捷键

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.52", "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.54", "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" } }