@jlceda/pro-api-types 0.2.28 → 0.2.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +44 -12
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1624,7 +1624,7 @@ declare global {
1624
1624
  /**
1625
1625
  * 获取 EDA 前端数据单位跨度
1626
1626
  *
1627
- * @alpha
1627
+ * @beta
1628
1628
  * @remarks 此处指的是前端用户可以切换的单位,需要同时兼容原理图和 PCB 画布
1629
1629
  * @returns 单位
1630
1630
  */
@@ -3361,7 +3361,7 @@ declare global {
3361
3361
  * 即 `setCanvasOrigin(0, 0)`;
3362
3362
  *
3363
3363
  * 此处的单位为数据层面单位,在跨度上等同于画布层面的 mil
3364
- * @param offsetX - 画布原点相对于数据原点的 X 坐标偏移
3364
+ * @param offsetX - 画布原点相对���数据原点的 X 坐标偏移
3365
3365
  * @param offsetY - 画布原点相对于数据原点的 Y 坐标偏移
3366
3366
  * @returns 操作是否成功
3367
3367
  */
@@ -5120,7 +5120,7 @@ declare global {
5120
5120
  * @beta
5121
5121
  * @param templateFile - BOM 模板文件
5122
5122
  * @param template - BOM 模板名称,如若为 `undefined` 则自动从 `templateFile` 中取值
5123
- * @returns BOM 模板��称
5123
+ * @returns BOM 模板名称
5124
5124
  * @example
5125
5125
  * ```javascript
5126
5126
  * // 从文件选择器读取模板文件
@@ -5989,7 +5989,7 @@ declare global {
5989
5989
  */
5990
5990
  unhighlightNet(net: string): Promise<boolean>;
5991
5991
  /**
5992
- * 取消高亮所���网络
5992
+ * 取消高亮所��网络
5993
5993
  *
5994
5994
  * @beta
5995
5995
  * @returns 操作是否成功
@@ -7125,7 +7125,7 @@ declare global {
7125
7125
  * 获取文本
7126
7126
  *
7127
7127
  * @alpha
7128
- * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图���对象
7128
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图��对象
7129
7129
  * @param primitiveIds - 文本的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
7130
7130
  * @returns 文本图元对象,空数组表示获取失败
7131
7131
  */
@@ -8882,7 +8882,7 @@ declare global {
8882
8882
  */
8883
8883
  getState_Polygon(): IPCB_Polygon;
8884
8884
  /**
8885
- * 获���属性状态:线宽
8885
+ * 获��属性状态:线宽
8886
8886
  *
8887
8887
  * @public
8888
8888
  * @returns 线宽
@@ -9974,7 +9974,7 @@ declare global {
9974
9974
  * 将异步图元重置为当前画布状态
9975
9975
  *
9976
9976
  * @internal
9977
- * @remarks 本器件焊盘图元属性不支持修��,本接口调用将不会有任何效果
9977
+ * @remarks 本器件焊盘图元属性不支持修改,本接口调用将不会有任何效果
9978
9978
  * @returns 器件焊盘图元对象
9979
9979
  */
9980
9980
  reset(): Promise<IPCB_PrimitiveComponentPad>;
@@ -11567,6 +11567,37 @@ declare global {
11567
11567
  done(): Promise<IPCB_PrimitiveObject>;
11568
11568
  }
11569
11569
 
11570
+ /**
11571
+ * PCB & 封装 / 光线追踪引擎类
11572
+ *
11573
+ * @public
11574
+ * @remarks 控制光线追踪引擎的对接和交互
11575
+ */
11576
+ class PCB_RayTracerEngine {
11577
+ /** 扩展 UUID */
11578
+ private extensionUuid?;
11579
+ /**
11580
+ * @internal
11581
+ * @param extensionUuid - 扩展 UUID
11582
+ */
11583
+ constructor(extensionUuid?: string);
11584
+ /**
11585
+ * 初始化光线追踪引擎
11586
+ *
11587
+ * @alpha
11588
+ * @param lut - 材质查找表
11589
+ */
11590
+ init(lut: Array<{
11591
+ [key: string]: any;
11592
+ }>): Promise<void>;
11593
+ /**
11594
+ * 停止光线追踪引擎
11595
+ *
11596
+ * @alpha
11597
+ */
11598
+ dispose(): Promise<void>;
11599
+ }
11600
+
11570
11601
  /**
11571
11602
  * PCB & 封装 / 选择控制类
11572
11603
  *
@@ -14415,7 +14446,7 @@ declare global {
14415
14446
  *
14416
14447
  * @public
14417
14448
  * @remarks
14418
- * 器件引脚图元是一个特殊���图元,它指的是在原理图画布上关联到符号的引脚
14449
+ * 器件引脚图元是一个特殊的图元,它指的是在原理图画布上关联到符号的引脚
14419
14450
  *
14420
14451
  * 器件引脚图元仅可更改 `pinNumber`、`noConnected` 属性,其它所有属性均为只读,
14421
14452
  * 并且你只能通过 {@link SCH_PrimitiveComponent.getAllPinsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link ISCH_PrimitiveComponent.getAllPins | 器件图元的 getAllPins 方法} 获取到器件引脚图元
@@ -14825,7 +14856,7 @@ declare global {
14825
14856
  *
14826
14857
  * 本接口的返回时机并不会等待用户的放置操作,一旦器件被绑定到鼠标,本接口将立即返回 `true` 的结果
14827
14858
  * @param component - 关联库器件
14828
- * @returns 是否找到器件
14859
+ * @returns 是否找��器件
14829
14860
  */
14830
14861
  placeComponentWithMouse(component: {
14831
14862
  libraryUuid: string;
@@ -18069,7 +18100,7 @@ declare global {
18069
18100
  *
18070
18101
  * @beta
18071
18102
  * @param options -
18072
- * 选项列表,可以为字符串数组或对象数组,在未指定 `defaultOption` 时,默认值���列表的第一项;
18103
+ * 选项列表,可以为字符串数组或对象数组,在未指定 `defaultOption` 时,默认值为列表的第一项;
18073
18104
  *
18074
18105
  * 如若为字符串数组,则选项的值和选项的展示内容将保持一致;
18075
18106
  *
@@ -18557,7 +18588,7 @@ declare global {
18557
18588
  title: string;
18558
18589
  /** 菜单项图标 */
18559
18590
  icon?: string;
18560
- /** 注册方法名称(需要在扩展入口文件导出该方法) */
18591
+ /** 注册方法名称(需要在扩展入���文件导出该方法) */
18561
18592
  registerFn?: string;
18562
18593
  }
18563
18594
  /**
@@ -20040,7 +20071,7 @@ declare global {
20040
20071
  * 获取当前主题
20041
20072
  *
20042
20073
  * @public
20043
- * @remarks 获取当前 EDA 主题,**浅色** 或 **深色**
20074
+ * @remarks 获取当��� EDA 主题,**浅色** 或 **深色**
20044
20075
  * @returns 当前主题
20045
20076
  */
20046
20077
  getCurrentTheme(): Promise<ESYS_Theme>;
@@ -20123,6 +20154,7 @@ declare global {
20123
20154
  pcb_PrimitiveRegion: PCB_PrimitiveRegion;
20124
20155
  pcb_PrimitiveString: PCB_PrimitiveString;
20125
20156
  pcb_PrimitiveVia: PCB_PrimitiveVia;
20157
+ pcb_RayTracerEngine: PCB_RayTracerEngine;
20126
20158
  pcb_SelectControl: PCB_SelectControl;
20127
20159
  pnl_Document: PNL_Document;
20128
20160
  sch_Document: SCH_Document;
package/package.json CHANGED
@@ -1 +1 @@
1
- { "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.28", "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" } }
1
+ { "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.29", "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" } }