@jlceda/pro-api-types 0.2.27 → 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 +68 -33
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -960,7 +960,7 @@ declare global {
960
960
  * @beta
961
961
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
962
962
  * @param libraryType - 库类型,支持符号和封装
963
- * @param uuid - 符号、��装 UUID
963
+ * @param uuid - 符号、封��� UUID
964
964
  * @param splitScreenId - 分屏 ID,即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
965
965
  * @returns 标签页 ID,如若为 `undefined`,则打开文档失败
966
966
  */
@@ -1392,7 +1392,7 @@ declare global {
1392
1392
  * @beta
1393
1393
  * @param projectFriendlyName - 工程友好名称
1394
1394
  * @param projectName - 工程名称,不可重复,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生成
1395
- * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
1395
+ * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团�� UUID
1396
1396
  * @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
1397
1397
  * @param description - 工程描述
1398
1398
  * @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则该参数将被忽略
@@ -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
  */
@@ -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 线宽
@@ -11056,7 +11056,7 @@ declare global {
11056
11056
  * 获取属性状态:图元类型
11057
11057
  *
11058
11058
  * @public
11059
- * @returns 图元类���
11059
+ * @returns 图元类型
11060
11060
  */
11061
11061
  getState_PrimitiveType(): EPCB_PrimitiveType;
11062
11062
  /**
@@ -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;
@@ -17473,13 +17504,13 @@ declare global {
17473
17504
 
17474
17505
  interface ButtonProps {
17475
17506
  text?: string;
17476
- disable?: boolean;
17507
+ disabled?: boolean;
17477
17508
  type?: 'default' | 'primary' | 'danger' | 'forbidden' | 'text';
17478
17509
  width?: number | 'responsive';
17479
17510
  icon?: IconProps;
17480
17511
  onClick?: () => void;
17481
17512
  }
17482
- function Button({ text, disable, type, width, icon, onClick, }: ButtonProps): react_jsx_runtime.JSX.Element;
17513
+ function Button({ text, disabled, type, width, icon, onClick, }: ButtonProps): react_jsx_runtime.JSX.Element;
17483
17514
 
17484
17515
  interface ListChildren$1 {
17485
17516
  title: string;
@@ -17492,7 +17523,7 @@ declare global {
17492
17523
  width?: number;
17493
17524
  disabled?: boolean;
17494
17525
  readonly?: boolean;
17495
- clearBtn?: boolean | 'keepAlive';
17526
+ clearBtn?: boolean;
17496
17527
  clickBtn?: boolean;
17497
17528
  dropDownList?: ListChildren$1[];
17498
17529
  searchBtn?: boolean;
@@ -17529,11 +17560,12 @@ declare global {
17529
17560
  color?: string;
17530
17561
  padding?: number[];
17531
17562
  margin?: number[];
17532
- width?: number;
17533
- height?: number;
17563
+ width?: number | '100%';
17564
+ height?: number | '100%';
17534
17565
  rotate?: number;
17535
17566
  cursor?: 'pointer' | 'default' | 'none' | 'move' | 'text';
17536
17567
  invisible?: boolean;
17568
+ display?: string;
17537
17569
  }
17538
17570
 
17539
17571
  interface FlexProps extends ContainerStyleProps {
@@ -17634,32 +17666,34 @@ declare global {
17634
17666
  function TextArea({ disabled, value, width, height, resizable, placeholder, name, onChange, }: TextAreaProps): react_jsx_runtime.JSX.Element;
17635
17667
 
17636
17668
  interface ModalProps {
17637
- defaultTop: number;
17638
- defaultLeft: number;
17639
- defaultWidth: number;
17640
- defaultHeight: number;
17669
+ top: number;
17670
+ left: number;
17671
+ width: number;
17672
+ height: number;
17673
+ overlay?: boolean;
17641
17674
  maxDragX?: number;
17642
17675
  maxDragY?: number;
17643
17676
  hide?: boolean;
17644
17677
  children?: React$1.ReactNode;
17645
17678
  onMoved?: (top: number, left: number) => void;
17646
17679
  }
17647
- function Modal({ defaultTop, defaultLeft, defaultWidth, defaultHeight, maxDragX, maxDragY, hide, children, onMoved, }: ModalProps): react_jsx_runtime.JSX.Element;
17680
+ function Modal({ top, left, width, height, maxDragX, maxDragY, hide, overlay, children, onMoved, }: ModalProps): react_jsx_runtime.JSX.Element;
17648
17681
 
17649
- interface DialogButtonProps {
17650
- text: string;
17651
- icon?: IconProps;
17652
- width?: number;
17653
- onClick?: () => void;
17654
- type?: 'default' | 'primary' | 'danger' | 'forbidden' | 'text';
17655
- }
17656
17682
  interface DialogProps {
17657
17683
  title: string;
17658
- buttons?: DialogButtonProps[];
17684
+ width?: number;
17685
+ height?: number;
17686
+ left?: number;
17687
+ top?: number;
17688
+ hide?: boolean;
17689
+ overlay?: boolean;
17690
+ maxDragY?: number;
17691
+ modal?: boolean;
17692
+ buttons?: ButtonProps[];
17659
17693
  onClose?: () => void;
17660
17694
  children?: React$1.ReactNode;
17661
17695
  }
17662
- function Dialog({ title, buttons, onClose, children }: DialogProps): react_jsx_runtime.JSX.Element;
17696
+ function Dialog(props: DialogProps): react_jsx_runtime.JSX.Element;
17663
17697
 
17664
17698
  interface SelectListItem {
17665
17699
  title: string;
@@ -18439,7 +18473,7 @@ declare global {
18439
18473
  /**
18440
18474
  * 转换 T/DISA 4001 库到单个嘉立创库文件
18441
18475
  *
18442
- * @alpha
18476
+ * @beta
18443
18477
  * @param file - T/DISA 4001 库文件
18444
18478
  * @returns 嘉立创库文件
18445
18479
  */
@@ -18447,7 +18481,7 @@ declare global {
18447
18481
  /**
18448
18482
  * 转换 T/DISA 4001 库到多个嘉立创库文件(每个器件一个文件)
18449
18483
  *
18450
- * @alpha
18484
+ * @beta
18451
18485
  * @param file - T/DISA 4001 库文件
18452
18486
  * @returns 多个嘉立创库文件
18453
18487
  */
@@ -18554,7 +18588,7 @@ declare global {
18554
18588
  title: string;
18555
18589
  /** 菜单项图标 */
18556
18590
  icon?: string;
18557
- /** 注册方法名称(需要在扩展入口文件导出该方法) */
18591
+ /** 注册方法名称(需要在扩展入���文件导出该方法) */
18558
18592
  registerFn?: string;
18559
18593
  }
18560
18594
  /**
@@ -20037,7 +20071,7 @@ declare global {
20037
20071
  * 获取当前主题
20038
20072
  *
20039
20073
  * @public
20040
- * @remarks 获取当前 EDA 主题,**浅色** 或 **深色**
20074
+ * @remarks 获取当��� EDA 主题,**浅色** 或 **深色**
20041
20075
  * @returns 当前主题
20042
20076
  */
20043
20077
  getCurrentTheme(): Promise<ESYS_Theme>;
@@ -20120,6 +20154,7 @@ declare global {
20120
20154
  pcb_PrimitiveRegion: PCB_PrimitiveRegion;
20121
20155
  pcb_PrimitiveString: PCB_PrimitiveString;
20122
20156
  pcb_PrimitiveVia: PCB_PrimitiveVia;
20157
+ pcb_RayTracerEngine: PCB_RayTracerEngine;
20123
20158
  pcb_SelectControl: PCB_SelectControl;
20124
20159
  pnl_Document: PNL_Document;
20125
20160
  sch_Document: SCH_Document;
package/package.json CHANGED
@@ -1 +1 @@
1
- { "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" } }
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" } }