@jlceda/pro-api-types 0.1.107 → 0.1.109

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 +766 -109
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -196,7 +196,7 @@ declare class DMT_Folder {
196
196
  * @param teamUuid - 团队 UUID
197
197
  * @param parentFolderUuid - 父文件夹 UUID,如若不指定,则为根文件夹
198
198
  * @param description - 文件夹描述
199
- * @returns 文��夹 UUID,如若为 `undefined` 则创建失败
199
+ * @returns 文���夹 UUID,如若为 `undefined` 则创建失败
200
200
  */
201
201
  createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
202
202
  /**
@@ -311,7 +311,7 @@ declare class DMT_Panel {
311
311
  *
312
312
  * @public
313
313
  * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
314
- * @returns 面板��详细属性,如若为 `undefined` 则获取失败
314
+ * @returns 面板���详细属性,如若为 `undefined` 则获取失败
315
315
  */
316
316
  getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
317
317
  /**
@@ -417,7 +417,7 @@ declare class DMT_Project {
417
417
  * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
418
418
  * @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
419
419
  * @param description - 工程描述
420
- * @param collaborationMode - 工程协作��式,如若团队权限无需工程设置协作模式,则该参数将被忽略
420
+ * @param collaborationMode - 工程协作���式,如若团队权限无需工程设置协作模式,则该参数将被忽略
421
421
  * @returns 工程 UUID,如若为 `undefined` 则创建失败
422
422
  */
423
423
  createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -1342,12 +1342,17 @@ declare enum EPCB_PrimitivePadShapeType {
1342
1342
  POLYLINE_COMPLEX_POLYGON = "POLYGON"
1343
1343
  }
1344
1344
 
1345
+ /**
1346
+ * 覆铜填充方法
1347
+ *
1348
+ * @public
1349
+ */
1345
1350
  declare enum EPCB_PrimitivePourFillMethod {
1346
- /** 填充样式 - 45度网格 */
1351
+ /** 45 度网格 */
1347
1352
  GRID45 = "45grid",
1348
- /** 填充样式 - 90度网格 */
1353
+ /** 90 度网格 */
1349
1354
  GRID = "90grid",
1350
- /** 填充样式 - 实心填充 */
1355
+ /** 实心填充 */
1351
1356
  SOLID = "solid"
1352
1357
  }
1353
1358
 
@@ -1515,7 +1520,20 @@ declare enum ESCH_PrimitiveType {
1515
1520
  /** 文本 */
1516
1521
  TEXT = "Text",
1517
1522
  /** 导线 */
1518
- WIRE = "Wire"
1523
+ WIRE = "Wire",
1524
+ NETFLAG = "Netflag",
1525
+ NETPORT = "Netport",
1526
+ NO_CONNECT = "Noconnect",
1527
+ PART = "Part",
1528
+ SHORT_SYMBOL = "Short_symbol",
1529
+ BLOCK_SYMBOL = "Block_symbol",
1530
+ TABLE = "Table",
1531
+ CELL = "Cell",
1532
+ BUSENTRY = "BusEntry",
1533
+ NONELECTRICAL_SYMBOL = "NonElectrical_symbol",
1534
+ OBJ = "Obj",
1535
+ JUNCTION = "Junction",
1536
+ SHEET = "Sheet"
1519
1537
  }
1520
1538
 
1521
1539
  /**
@@ -1773,7 +1791,7 @@ declare interface IDMT_EditorDocumentItem {
1773
1791
  documentType: EDMT_EditorDocumentType;
1774
1792
  /** 文档 UUID */
1775
1793
  uuid: string;
1776
- /** 文档所属工��� UUID */
1794
+ /** 文档所属工程 UUID */
1777
1795
  parentProjectUuid: string;
1778
1796
  }
1779
1797
 
@@ -2771,8 +2789,21 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
2771
2789
  * @returns 圆弧线图元对象
2772
2790
  */
2773
2791
  done(): Promise<IPCB_PrimitiveArc>;
2774
- /* Excluded from this release type: getAdjacentPrimitives */
2775
- /* Excluded from this release type: getEntireTrack */
2792
+ /**
2793
+ * 获取相邻的图元对象
2794
+ *
2795
+ * @beta
2796
+ * @remarks 将会获取与圆弧线直接相连的直线、过孔、圆弧线图元对象
2797
+ * @returns 相邻的直线、过孔、圆弧线图元对象
2798
+ */
2799
+ getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc>>;
2800
+ /**
2801
+ * 获取整段导线
2802
+ *
2803
+ * @beta
2804
+ * @returns 整段导线内的所有直线和圆弧线
2805
+ */
2806
+ getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
2776
2807
  }
2777
2808
 
2778
2809
  /**
@@ -3129,7 +3160,13 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
3129
3160
  * @returns 器件图元对象
3130
3161
  */
3131
3162
  done(): Promise<IPCB_PrimitiveComponent>;
3132
- /* Excluded from this release type: getAllPins */
3163
+ /**
3164
+ * 获取器件关联的所有焊盘
3165
+ *
3166
+ * @beta
3167
+ * @returns 器件焊盘图元数组
3168
+ */
3169
+ getAllPins(): Promise<IPCB_PrimitiveComponentPad[]>;
3133
3170
  /* Excluded from this release type: setState_Component */
3134
3171
  }
3135
3172
 
@@ -3150,7 +3187,13 @@ declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
3150
3187
  /* Excluded from this release type: setState_Layer */
3151
3188
  /* Excluded from this release type: setState_PadNumber */
3152
3189
  /* Excluded from this release type: reset */
3153
- /* Excluded from this release type: done */
3190
+ /**
3191
+ * 将对图元的更改应用到画布
3192
+ *
3193
+ * @beta
3194
+ * @returns 器件焊盘图元对象
3195
+ */
3196
+ done(): Promise<IPCB_PrimitiveComponentPad>;
3154
3197
  }
3155
3198
 
3156
3199
  /**
@@ -3497,11 +3540,41 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3497
3540
  * @returns 是否为异步图元
3498
3541
  */
3499
3542
  isAsync(): boolean;
3500
- /* Excluded from this release type: reset */
3501
- /* Excluded from this release type: done */
3502
- /* Excluded from this release type: convertToPolyline */
3503
- /* Excluded from this release type: convertToPour */
3504
- /* Excluded from this release type: convertToRegion */
3543
+ /**
3544
+ * 将异步图元重置为当前画布状态
3545
+ *
3546
+ * @beta
3547
+ * @returns 填充图元对象
3548
+ */
3549
+ reset(): Promise<IPCB_PrimitiveFill>;
3550
+ /**
3551
+ * 将对图元的更改应用到画布
3552
+ *
3553
+ * @beta
3554
+ * @returns 填充图元对象
3555
+ */
3556
+ done(): Promise<IPCB_PrimitiveFill>;
3557
+ /**
3558
+ * 转换到:折线图元(默认是线条)
3559
+ *
3560
+ * @beta
3561
+ * @returns 折线图元对象
3562
+ */
3563
+ convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
3564
+ /**
3565
+ * 转换到:覆铜边框图元
3566
+ *
3567
+ * @beta
3568
+ * @returns 覆铜边框图元对象
3569
+ */
3570
+ convertToPour(): Promise<IPCB_PrimitivePour>;
3571
+ /**
3572
+ * 转换到:区域图元(默认是禁止区域)
3573
+ *
3574
+ * @beta
3575
+ * @returns 区域图元对象
3576
+ */
3577
+ convertToRegion(): Promise<IPCB_PrimitiveRegion>;
3505
3578
  }
3506
3579
 
3507
3580
  /**
@@ -3556,14 +3629,14 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3556
3629
  * @public
3557
3630
  * @returns BBox 左上点坐标 X
3558
3631
  */
3559
- getState_X(): number;
3632
+ getState_X(): number | undefined;
3560
3633
  /**
3561
3634
  * 获取属性状态:BBox 左上点坐标 Y
3562
3635
  *
3563
3636
  * @public
3564
3637
  * @returns BBox 左上点坐标 Y
3565
3638
  */
3566
- getState_Y(): number;
3639
+ getState_Y(): number | undefined;
3567
3640
  /**
3568
3641
  * 获取属性状态:图像源数据(复杂多边形)
3569
3642
  *
@@ -3577,42 +3650,42 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3577
3650
  * @public
3578
3651
  * @returns 层
3579
3652
  */
3580
- getState_Layer(): TPCB_LayersOfImage;
3653
+ getState_Layer(): TPCB_LayersOfImage | undefined;
3581
3654
  /**
3582
3655
  * 获取属性状态:宽
3583
3656
  *
3584
3657
  * @public
3585
3658
  * @returns 宽
3586
3659
  */
3587
- getState_Width(): number;
3660
+ getState_Width(): number | undefined;
3588
3661
  /**
3589
3662
  * 获取属性状态:高
3590
3663
  *
3591
3664
  * @public
3592
3665
  * @returns 高
3593
3666
  */
3594
- getState_Height(): number;
3667
+ getState_Height(): number | undefined;
3595
3668
  /**
3596
3669
  * 获取属性状态:旋转角度
3597
3670
  *
3598
3671
  * @public
3599
3672
  * @returns 旋转角度
3600
3673
  */
3601
- getState_Rotation(): number;
3674
+ getState_Rotation(): number | undefined;
3602
3675
  /**
3603
3676
  * 获取属性状态:是否水平镜像
3604
3677
  *
3605
3678
  * @public
3606
3679
  * @returns 是否水平镜像
3607
3680
  */
3608
- getState_HorizonMirror(): boolean;
3681
+ getState_HorizonMirror(): boolean | undefined;
3609
3682
  /**
3610
3683
  * 获取属性状态:是否锁定
3611
3684
  *
3612
3685
  * @public
3613
3686
  * @returns 是否锁定
3614
3687
  */
3615
- getState_PrimitiveLock(): boolean;
3688
+ getState_PrimitiveLock(): boolean | undefined;
3616
3689
  /**
3617
3690
  * 设置属性状态:BBox 左上点坐标 X
3618
3691
  *
@@ -3620,7 +3693,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3620
3693
  * @param x - BBox 左上点坐标 X
3621
3694
  * @returns 图像图元对象
3622
3695
  */
3623
- setState_X(x: number): IPCB_PrimitiveImage;
3696
+ setState_X(x: number | undefined): IPCB_PrimitiveImage;
3624
3697
  /**
3625
3698
  * 设置属性状态:BBox 左上点坐标 Y
3626
3699
  *
@@ -3628,7 +3701,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3628
3701
  * @param y - BBox 左上点坐标 Y
3629
3702
  * @returns 图像图元对象
3630
3703
  */
3631
- setState_Y(y: number): IPCB_PrimitiveImage;
3704
+ setState_Y(y: number | undefined): IPCB_PrimitiveImage;
3632
3705
  /**
3633
3706
  * 设置属性状态:层
3634
3707
  *
@@ -3636,7 +3709,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3636
3709
  * @param layer - 层
3637
3710
  * @returns 图像图元对象
3638
3711
  */
3639
- setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveImage;
3712
+ setState_Layer(layer: TPCB_LayersOfImage | undefined): IPCB_PrimitiveImage;
3640
3713
  /**
3641
3714
  * 设置属性状态:宽
3642
3715
  *
@@ -3644,7 +3717,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3644
3717
  * @param width - 宽
3645
3718
  * @returns 图像图元对象
3646
3719
  */
3647
- setState_Width(width: number): IPCB_PrimitiveImage;
3720
+ setState_Width(width: number | undefined): IPCB_PrimitiveImage;
3648
3721
  /**
3649
3722
  * 设置属性状态:高
3650
3723
  *
@@ -3652,7 +3725,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3652
3725
  * @param height - 高
3653
3726
  * @returns 图像图元对象
3654
3727
  */
3655
- setState_Height(height: number): IPCB_PrimitiveImage;
3728
+ setState_Height(height: number | undefined): IPCB_PrimitiveImage;
3656
3729
  /**
3657
3730
  * 设置属性状态:旋转角度
3658
3731
  *
@@ -3660,7 +3733,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3660
3733
  * @param rotation - 旋转角度
3661
3734
  * @returns 图像图元对象
3662
3735
  */
3663
- setState_Rotation(rotation: number): IPCB_PrimitiveImage;
3736
+ setState_Rotation(rotation: number | undefined): IPCB_PrimitiveImage;
3664
3737
  /**
3665
3738
  * 设置属性状态:是否水平镜像
3666
3739
  *
@@ -3668,7 +3741,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3668
3741
  * @param horizonMirror - 是否水平镜像
3669
3742
  * @returns 图像图元对象
3670
3743
  */
3671
- setState_HorizonMirror(horizonMirror: boolean): IPCB_PrimitiveImage;
3744
+ setState_HorizonMirror(horizonMirror: boolean | undefined): IPCB_PrimitiveImage;
3672
3745
  /**
3673
3746
  * 设置属性状态:是否锁定
3674
3747
  *
@@ -3676,7 +3749,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3676
3749
  * @param primitiveLock - 是否锁定
3677
3750
  * @returns 图像图元对象
3678
3751
  */
3679
- setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;
3752
+ setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveImage;
3680
3753
  /**
3681
3754
  * 将图元转换为异步图元
3682
3755
  *
@@ -3914,8 +3987,21 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
3914
3987
  * @returns 直线图元对象
3915
3988
  */
3916
3989
  done(): Promise<IPCB_PrimitiveLine>;
3917
- /* Excluded from this release type: getAdjacentPrimitives */
3918
- /* Excluded from this release type: getEntireTrack */
3990
+ /**
3991
+ * 获取相邻的图元对象
3992
+ *
3993
+ * @beta
3994
+ * @remarks 将会获取与直线两端直接相连的直线、过孔、圆弧线图元对象
3995
+ * @returns 相邻的直线、过孔、圆弧线图元对象
3996
+ */
3997
+ getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc>>;
3998
+ /**
3999
+ * 获取整段导线
4000
+ *
4001
+ * @beta
4002
+ * @returns 整段导线内的所有直线和圆弧线
4003
+ */
4004
+ getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
3919
4005
  }
3920
4006
 
3921
4007
  /**
@@ -3981,7 +4067,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
3981
4067
  */
3982
4068
  getState_TopLeftX(): number | undefined;
3983
4069
  /**
3984
- * 获取属性状态:左上点 Y
4070
+ * 获取属性状态:左上�� Y
3985
4071
  *
3986
4072
  * @public
3987
4073
  * @returns 左上点 Y
@@ -4137,8 +4223,20 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4137
4223
  * @returns 是否为异步图元
4138
4224
  */
4139
4225
  isAsync(): boolean;
4140
- /* Excluded from this release type: reset */
4141
- /* Excluded from this release type: done */
4226
+ /**
4227
+ * 将异步图元重置为当前画布状态
4228
+ *
4229
+ * @beta
4230
+ * @returns 二进制内嵌对象图元对象
4231
+ */
4232
+ reset(): Promise<IPCB_PrimitiveObject>;
4233
+ /**
4234
+ * 将对图元的更改应用到画布
4235
+ *
4236
+ * @beta
4237
+ * @returns 二进制内嵌对象图元对象
4238
+ */
4239
+ done(): Promise<IPCB_PrimitiveObject>;
4142
4240
  }
4143
4241
 
4144
4242
  /**
@@ -4648,7 +4746,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
4648
4746
  */
4649
4747
  setState_Polygon(polygon: IPCB_Polygon): IPCB_PrimitivePolyline;
4650
4748
  /**
4651
- * ���置属性状态:线宽
4749
+ * 设置属性状态:线宽
4652
4750
  *
4653
4751
  * @beta
4654
4752
  * @param lineWidth - 线宽
@@ -4698,9 +4796,27 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
4698
4796
  * @returns 折线图元对象
4699
4797
  */
4700
4798
  done(): Promise<IPCB_PrimitivePolyline>;
4701
- /* Excluded from this release type: convertToFill */
4702
- /* Excluded from this release type: convertToPour */
4703
- /* Excluded from this release type: convertToRegion */
4799
+ /**
4800
+ * 转换到:填充图元
4801
+ *
4802
+ * @beta
4803
+ * @returns 填充图元对象
4804
+ */
4805
+ convertToFill(): Promise<IPCB_PrimitiveFill>;
4806
+ /**
4807
+ * 转换到:覆铜边框图元
4808
+ *
4809
+ * @beta
4810
+ * @returns 覆铜边框图元对象
4811
+ */
4812
+ convertToPour(): Promise<IPCB_PrimitivePour>;
4813
+ /**
4814
+ * 转换到:区域图元
4815
+ *
4816
+ * @beta
4817
+ * @returns 区域图元对象
4818
+ */
4819
+ convertToRegion(): Promise<IPCB_PrimitiveRegion>;
4704
4820
  }
4705
4821
 
4706
4822
  /**
@@ -4817,7 +4933,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4817
4933
  *
4818
4934
  * @beta
4819
4935
  * @param net - 网络名称
4820
- * @returns 覆铜边框图��对象
4936
+ * @returns 覆铜边框图元对象
4821
4937
  */
4822
4938
  setState_Net(net: string): IPCB_PrimitivePour;
4823
4939
  /**
@@ -4905,11 +5021,41 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4905
5021
  * @returns 是否为异步图元
4906
5022
  */
4907
5023
  isAsync(): boolean;
4908
- /* Excluded from this release type: reset */
4909
- /* Excluded from this release type: done */
4910
- /* Excluded from this release type: convertToFill */
4911
- /* Excluded from this release type: convertToPolyline */
4912
- /* Excluded from this release type: convertToRegion */
5024
+ /**
5025
+ * 将异步图元重置为当前画布状态
5026
+ *
5027
+ * @beta
5028
+ * @returns 覆铜边框图元对象
5029
+ */
5030
+ reset(): Promise<IPCB_PrimitivePour>;
5031
+ /**
5032
+ * 将对图元的更改应用到画布
5033
+ *
5034
+ * @beta
5035
+ * @returns 覆铜边框图元对象
5036
+ */
5037
+ done(): Promise<IPCB_PrimitivePour>;
5038
+ /**
5039
+ * 转换到:填充图元(默认是填充区域)
5040
+ *
5041
+ * @beta
5042
+ * @returns 填充图元对象
5043
+ */
5044
+ convertToFill(): Promise<IPCB_PrimitiveFill>;
5045
+ /**
5046
+ * 转换到:折线图元(默认是线条)
5047
+ *
5048
+ * @beta
5049
+ * @returns 折线图元对象
5050
+ */
5051
+ convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
5052
+ /**
5053
+ * 转换到:区域图元(默认是禁止区域)
5054
+ *
5055
+ * @beta
5056
+ * @returns 区域图元对象
5057
+ */
5058
+ convertToRegion(): Promise<IPCB_PrimitiveRegion>;
4913
5059
  }
4914
5060
 
4915
5061
  /**
@@ -5067,11 +5213,41 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
5067
5213
  * @returns 是否为异步图元
5068
5214
  */
5069
5215
  isAsync(): boolean;
5070
- /* Excluded from this release type: reset */
5071
- /* Excluded from this release type: done */
5072
- /* Excluded from this release type: convertToFill */
5073
- /* Excluded from this release type: convertToPolyline */
5074
- /* Excluded from this release type: convertToPour */
5216
+ /**
5217
+ * 将异步图元重置为当前画布状态
5218
+ *
5219
+ * @beta
5220
+ * @returns 区域图元对象
5221
+ */
5222
+ reset(): Promise<IPCB_PrimitiveRegion>;
5223
+ /**
5224
+ * 将对图元的更改应用到画布
5225
+ *
5226
+ * @beta
5227
+ * @returns 区域图元对象
5228
+ */
5229
+ done(): Promise<IPCB_PrimitiveRegion>;
5230
+ /**
5231
+ * 转换到:填充图元
5232
+ *
5233
+ * @beta
5234
+ * @returns 填充图元对象
5235
+ */
5236
+ convertToFill(): Promise<IPCB_PrimitiveFill>;
5237
+ /**
5238
+ * 转换到:折线图元
5239
+ *
5240
+ * @beta
5241
+ * @returns 折线图元对象
5242
+ */
5243
+ convertToPolyline(): Promise<IPCB_PrimitivePolyline>;
5244
+ /**
5245
+ * 转换到:覆铜边框图元
5246
+ *
5247
+ * @beta
5248
+ * @returns 覆铜边框图元对象
5249
+ */
5250
+ convertToPour(): Promise<IPCB_PrimitivePour>;
5075
5251
  }
5076
5252
 
5077
5253
  /**
@@ -5316,7 +5492,14 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
5316
5492
  * @returns 过孔图元对象
5317
5493
  */
5318
5494
  done(): Promise<IPCB_PrimitiveVia>;
5319
- /* Excluded from this release type: getAdjacentPrimitives */
5495
+ /**
5496
+ * 获取相邻的图元对象
5497
+ *
5498
+ * @beta
5499
+ * @remarks 将会获取与过孔直接相连的导线、圆弧线图元对象
5500
+ * @returns 相邻的导线、圆弧线图元对象
5501
+ */
5502
+ getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
5320
5503
  }
5321
5504
 
5322
5505
  /**
@@ -6536,7 +6719,7 @@ declare class LIB_3DModel {
6536
6719
  * @remarks 如希望清除某些属性,则将其的值设置为 `null`
6537
6720
  * @param modelUuid - 3D 模型 UUID
6538
6721
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
6539
- * @param modelName - 3D 模���名称
6722
+ * @param modelName - 3D 模型名称
6540
6723
  * @param classification - 分类
6541
6724
  * @param description - 描述
6542
6725
  * @returns 操作是否成功
@@ -6941,6 +7124,7 @@ declare class LIB_Footprint {
6941
7124
  * @returns 操作是否成功
6942
7125
  */
6943
7126
  modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
7127
+ /* Excluded from this release type: updateDocumentSource */
6944
7128
  /**
6945
7129
  * 获取封装的所有属性
6946
7130
  *
@@ -6990,7 +7174,7 @@ declare class LIB_Footprint {
6990
7174
  * 综合库 / 库列表类
6991
7175
  *
6992
7176
  * @public
6993
- * @remarks 此处所有接口都基于编辑器当前工作区环境,如需切换到其他工作区,请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
7177
+ * @remarks 此处所有���口都基于编辑器当前工作区环境,如需切换到其他工作区,请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
6994
7178
  */
6995
7179
  declare class LIB_LibrariesList {
6996
7180
  /**
@@ -7099,7 +7283,7 @@ declare class LIB_PanelLibrary {
7099
7283
  *
7100
7284
  * @beta
7101
7285
  * @param key - 搜索关键字
7102
- * @param libraryUuid - 库 UUID,默认为系统库,可���使用 {@link LIB_LibrariesList} 内的接口获取
7286
+ * @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
7103
7287
  * @param classification - 分类,默认为全部
7104
7288
  * @param itemsOfPage - 一页搜索结果的数量
7105
7289
  * @param page - 页数
@@ -7158,6 +7342,7 @@ declare class LIB_Symbol {
7158
7342
  * @returns 操作是否成功
7159
7343
  */
7160
7344
  modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
7345
+ /* Excluded from this release type: updateDocumentSource */
7161
7346
  /**
7162
7347
  * 获取符号的所有属性
7163
7348
  *
@@ -7180,7 +7365,7 @@ declare class LIB_Symbol {
7180
7365
  */
7181
7366
  copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newSymbolName?: string): Promise<string | undefined>;
7182
7367
  /**
7183
- * 搜索符号
7368
+ * 搜索���号
7184
7369
  *
7185
7370
  * @beta
7186
7371
  * @param key - 搜索关键字
@@ -7228,6 +7413,15 @@ declare class PCB_Document {
7228
7413
  * @returns 导入操作是否成功
7229
7414
  */
7230
7415
  importOldAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
7416
+ /**
7417
+ * 导入自动布线文件(JSON)
7418
+ *
7419
+ * @beta
7420
+ * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
7421
+ * @param autoRouteFile - 欲导入的 JSON 文件
7422
+ * @returns 导入操作是否成功
7423
+ */
7424
+ importAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
7231
7425
  /**
7232
7426
  * 导入旧版自动布局文件(JSON)
7233
7427
  *
@@ -7374,7 +7568,7 @@ declare class PCB_Drc {
7374
7568
  * @public
7375
7569
  * @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false`,否则返回 `true`
7376
7570
  * @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
7377
- * @returns DRC 检查是否无错误
7571
+ * @returns DRC ���查是否无错误
7378
7572
  */
7379
7573
  check(strict?: boolean, userInterface?: boolean): Promise<boolean>;
7380
7574
  /**
@@ -7474,7 +7668,7 @@ declare class PCB_Drc {
7474
7668
  * 覆写网络规则
7475
7669
  *
7476
7670
  * @beta
7477
- * @remarks 将会覆写当前 PCB 的所有网络规则,请注意数据丢失风险
7671
+ * @remarks 将会覆写当前 PCB 的所有网络规则,请注意数据丢失��险
7478
7672
  * @param netRules - 网络规则
7479
7673
  * @returns 覆写是否成功
7480
7674
  */
@@ -7864,7 +8058,7 @@ declare class PCB_Layer {
7864
8058
  * 新增自定义层
7865
8059
  *
7866
8060
  * @beta
7867
- * @returns 新增的自定义层的图层 ID,如若为 `undefined` 则为新增失败,可能��自定义层数量已达到上限
8061
+ * @returns 新增的自定义层的图层 ID,如若为 `undefined` 则为新增失败,可能是自定义层数量已达到上限
7868
8062
  */
7869
8063
  addCustomLayer(): Promise<TPCB_LayersOfCustom | undefined>;
7870
8064
  /**
@@ -7969,7 +8163,14 @@ declare class PCB_ManufactureData {
7969
8163
  * @returns 坐标文件数据
7970
8164
  */
7971
8165
  getPickAndPlaceFile(fileName?: string, fileType?: 'xlsx' | 'csv', unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.MIL): Promise<File | undefined>;
7972
- /* Excluded from this release type: getFlyingProbeTestFile */
8166
+ /**
8167
+ * 获取飞针测试文件
8168
+ *
8169
+ * @beta
8170
+ * @param fileName - 文件名
8171
+ * @returns 飞针测试文件数据
8172
+ */
8173
+ getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;
7973
8174
  /**
7974
8175
  * 获取 BOM 文件
7975
8176
  *
@@ -8014,8 +8215,49 @@ declare class PCB_ManufactureData {
8014
8215
  layerId: number;
8015
8216
  mirror: boolean;
8016
8217
  }>, objects?: Array<string>): Promise<File | undefined>;
8017
- /* Excluded from this release type: getPdfFile */
8018
- /* Excluded from this release type: getIpcD356AFile */
8218
+ /**
8219
+ * 获取 PDF 文件
8220
+ *
8221
+ * @beta
8222
+ * @remarks
8223
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
8224
+ *
8225
+ * `outputMethod`、`contentConfig`、`watermark` 参数暂不可用,等待后期规划
8226
+ * @param fileName - 文件名
8227
+ * @param outputMethod - 输出方式
8228
+ * @param contentConfig - 内容配置
8229
+ * @param watermark - 水印
8230
+ * @returns PDF 文件数据(或压缩包)
8231
+ */
8232
+ getPdfFile(fileName?: string, outputMethod?: EPCB_PdfOutputMethod, contentConfig?: {
8233
+ displayAttributesAsMenu: boolean;
8234
+ showOutlineOnly: boolean;
8235
+ }, watermark?: {
8236
+ show?: boolean;
8237
+ content?: string;
8238
+ styleConfig?: {
8239
+ color: string;
8240
+ transparency: 'Opaque' | '75%' | '50%' | '25%';
8241
+ font: string;
8242
+ fontSize: string;
8243
+ style: {
8244
+ blood: boolean;
8245
+ italic: boolean;
8246
+ underline: boolean;
8247
+ };
8248
+ slope: 0 | 45 | 90;
8249
+ denseness: 'Single' | 'Sparse' | 'Std' | 'Dense';
8250
+ };
8251
+ }): Promise<File | undefined>;
8252
+ /**
8253
+ * 获取 IPC-D-356A 文件
8254
+ *
8255
+ * @beta
8256
+ * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
8257
+ * @param fileName - 文件名
8258
+ * @returns IPC-D-356A 文件数据
8259
+ */
8260
+ getIpcD356AFile(fileName?: string): Promise<File | undefined>;
8019
8261
  /**
8020
8262
  * 获取 ODB++ 文件
8021
8263
  *
@@ -8087,8 +8329,24 @@ declare class PCB_ManufactureData {
8087
8329
  * @returns 自动布局 JSON 文件数据
8088
8330
  */
8089
8331
  getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
8090
- /* Excluded from this release type: getAltiumDesignerFile */
8091
- /* Excluded from this release type: getPadsFile */
8332
+ /**
8333
+ * 获取 Altium Designer 文件
8334
+ *
8335
+ * @beta
8336
+ * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
8337
+ * @param fileName - 文件名
8338
+ * @returns Altium Designer 文件数据
8339
+ */
8340
+ getAltiumDesignerFile(fileName?: string): Promise<File | undefined>;
8341
+ /**
8342
+ * 获取 PADS 文件
8343
+ *
8344
+ * @beta
8345
+ * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
8346
+ * @param fileName - 文件名
8347
+ * @returns PADS 文件数据
8348
+ */
8349
+ getPadsFile(fileName?: string): Promise<File | undefined>;
8092
8350
  /**
8093
8351
  * 获取 PCB 信息文件
8094
8352
  *
@@ -8098,10 +8356,82 @@ declare class PCB_ManufactureData {
8098
8356
  * @returns PCB 信息文件
8099
8357
  */
8100
8358
  getPcbInfoFile(fileName?: string): Promise<File | undefined>;
8101
- /* Excluded from this release type: placeComponentsOrder */
8102
- /* Excluded from this release type: placeSmtComponentsOrder */
8103
- /* Excluded from this release type: placePcbOrder */
8104
- /* Excluded from this release type: place3DShellOrder */
8359
+ /**
8360
+ * 元件下单
8361
+ *
8362
+ * @beta
8363
+ * @param interactive - 是否启用交互式检查
8364
+ *
8365
+ * 如若启用,则会存在弹窗等待用户进行交互,且无法使用 `ignoreWarning` 参数忽略警告,
8366
+ * 即 `ignoreWarning` 参数将被忽略;
8367
+ *
8368
+ * 如若禁用,则在调用后不会有任何 EDA 内部弹窗,程序执行静默检查,
8369
+ * 如若达成下单条件,将返回 `true` 并在新标签页打开下单页面
8370
+ * @param ignoreWarning - 在非交互式检查时忽略警告
8371
+ *
8372
+ * 如果设置为 `true`,将会忽略所有检查警告项并尽可能生成下单资料;
8373
+ *
8374
+ * 如果设置为 `false`,存在任意警告将中断执行并返回 `false` 的结果
8375
+ * @returns 是否通过下单检查
8376
+ */
8377
+ placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
8378
+ /**
8379
+ * SMT 元件下单
8380
+ *
8381
+ * @beta
8382
+ * @param interactive - 是否启用交互式检查
8383
+ *
8384
+ * 如若启用,则会存在弹窗等待用户进行交互,且无法使用 `ignoreWarning` 参数忽略警告,
8385
+ * 即 `ignoreWarning` 参数将被忽略;
8386
+ *
8387
+ * 如若禁用,则在调用后不会有任何 EDA 内部弹窗,程序执行静默检查,
8388
+ * 如若达成下单条件,将返回 `true` 并在新标签页打开下单页面
8389
+ * @param ignoreWarning - 在非交互式检查时忽略警告
8390
+ *
8391
+ * 如果设置为 `true`,将会忽略所有检查警告项并尽可能生成下单资料;
8392
+ *
8393
+ * 如果设置为 `false`,存在任意警告将中断执行并返回 `false` 的结果
8394
+ * @returns 是否通过下单检查
8395
+ */
8396
+ placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
8397
+ /**
8398
+ * PCB 下单
8399
+ *
8400
+ * @beta
8401
+ * @param interactive - 是否启用交互式检查
8402
+ *
8403
+ * 如若启用,则会存在弹窗等待用户进行交互,且无法使用 `ignoreWarning` 参数忽略警告,
8404
+ * 即 `ignoreWarning` 参数将被忽略;
8405
+ *
8406
+ * 如若禁用,则在调用后不会有任何 EDA 内部弹窗,程序执行静默检查,
8407
+ * 如若达成下单条件,将返回 `true` 并在新标签页打开下单页面
8408
+ * @param ignoreWarning - 在非交互式检查时忽略警告
8409
+ *
8410
+ * 如果设置为 `true`,将会忽略所有检查警告项并尽可能生成下单资料;
8411
+ *
8412
+ * 如果设置为 `false`,存在任意警告将中断执行并返回 `false` 的结果
8413
+ * @returns 是否通过下单检查
8414
+ */
8415
+ placePcbOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
8416
+ /**
8417
+ * 3D 外壳下单
8418
+ *
8419
+ * @beta
8420
+ * @param interactive - 是否启用交互式检查
8421
+ *
8422
+ * 如若启用,则会存在弹窗等待用户进行交互,且无法使用 `ignoreWarning` 参数忽略警告,
8423
+ * 即 `ignoreWarning` 参数将被忽略;
8424
+ *
8425
+ * 如若禁用,则在调用后不会有任何 EDA 内部弹窗,程序执行静默检查,
8426
+ * 如若达成下单条件,将返回 `true` 并在新标签页打开下单页面
8427
+ * @param ignoreWarning - 在非交互式检查时忽略警告
8428
+ *
8429
+ * 如果设置为 `true`,将会忽略所有检查警告项并尽可能生成下单资料;
8430
+ *
8431
+ * 如果设置为 `false`,存在任意警告将中断执行并返回 `false` 的结果
8432
+ * @returns 是否通过下单检查
8433
+ */
8434
+ place3DShellOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
8105
8435
  }
8106
8436
 
8107
8437
  /**
@@ -8202,7 +8532,15 @@ declare class PCB_Net {
8202
8532
  * @returns 操作是否成功
8203
8533
  */
8204
8534
  highlightNet(net: string): Promise<boolean>;
8205
- /* Excluded from this release type: unhighlightNet */
8535
+ /**
8536
+ * 取消高亮网络
8537
+ *
8538
+ * @beta
8539
+ * @remarks 本接口的返回值为结果导向,如果该网络原先未高亮,也将返回 `true`
8540
+ * @param net - 网络名称
8541
+ * @returns 操作是否成功
8542
+ */
8543
+ unhighlightNet(net: string): Promise<boolean>;
8206
8544
  /* Excluded from this release type: unhighlightAllNets */
8207
8545
  /**
8208
8546
  * 获取网表
@@ -8232,7 +8570,19 @@ declare class PCB_Primitive {
8232
8570
  /* Excluded from this release type: getPrimitiveTypeByPrimitiveId */
8233
8571
  /* Excluded from this release type: getPrimitiveByPrimitiveId */
8234
8572
  /* Excluded from this release type: getPrimitivesByPrimitiveId */
8235
- /* Excluded from this release type: getPrimitivesBBox */
8573
+ /**
8574
+ * 获取图元的 BBox
8575
+ *
8576
+ * @beta
8577
+ * @param primitiveIds - 图元 ID 数组或图元对象数组
8578
+ * @returns 图元的 BBox,如若图元不存在或没有 BBox,将会返回 `undefined` 的结果
8579
+ */
8580
+ getPrimitivesBBox(primitiveIds: Array<string | IPCB_Primitive>): Promise<{
8581
+ minX: number;
8582
+ minY: number;
8583
+ maxX: number;
8584
+ maxY: number;
8585
+ } | undefined>;
8236
8586
  }
8237
8587
 
8238
8588
  /**
@@ -8429,7 +8779,14 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
8429
8779
  * @returns 器件图元对象数组
8430
8780
  */
8431
8781
  getAll(layer?: TPCB_LayersOfComponent, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveComponent>>;
8432
- /* Excluded from this release type: getAllPinsByPrimitiveId */
8782
+ /**
8783
+ * 获取器件关联的所有焊盘
8784
+ *
8785
+ * @beta
8786
+ * @param primitiveId - 器件图元 ID
8787
+ * @returns 器件焊盘图元数组
8788
+ */
8789
+ getAllPinsByPrimitiveId(primitiveId: string): Promise<Array<IPCB_PrimitiveComponentPad> | undefined>;
8433
8790
  /* Excluded from this release type: placeComponentWithMouse */
8434
8791
  }
8435
8792
 
@@ -8521,13 +8878,80 @@ declare class PCB_PrimitiveDimension implements IPCB_PrimitiveAPI {
8521
8878
  * @public
8522
8879
  */
8523
8880
  declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
8524
- /* Excluded from this release type: create */
8525
- /* Excluded from this release type: delete */
8526
- /* Excluded from this release type: modify */
8527
- /* Excluded from this release type: get */
8528
- /* Excluded from this release type: get */
8529
- /* Excluded from this release type: getAllPrimitiveId */
8530
- /* Excluded from this release type: getAll */
8881
+ /**
8882
+ * 创建填充
8883
+ *
8884
+ * @beta
8885
+ * @param layer -
8886
+ * @param complexPolygon - 复杂多边形对象
8887
+ * @param net - 网络名称
8888
+ * @param fillMode - 填充模式
8889
+ * @param lineWidth - 线宽
8890
+ * @param primitiveLock - 是否锁定
8891
+ * @returns 填充图元对象
8892
+ */
8893
+ create(layer: TPCB_LayersOfFill, complexPolygon: IPCB_Polygon, net?: string, fillMode?: EPCB_PrimitiveFillMode, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveFill | undefined>;
8894
+ /**
8895
+ * 删除填充
8896
+ *
8897
+ * @beta
8898
+ * @param primitiveIds - 填充的图元 ID 或填充图元对象
8899
+ * @returns 删除操作是否成功
8900
+ */
8901
+ delete(primitiveIds: string | IPCB_PrimitiveFill | Array<string> | Array<IPCB_PrimitiveFill>): Promise<boolean>;
8902
+ /**
8903
+ * 修改填充
8904
+ *
8905
+ * @beta
8906
+ * @param primitiveId - 图元 ID
8907
+ * @param property - 修改参数
8908
+ * @returns 填充图元对象,`undefined` 表示修改失败
8909
+ */
8910
+ modify(primitiveId: string | IPCB_PrimitiveFill, property: {
8911
+ layer?: TPCB_LayersOfFill;
8912
+ complexPolygon?: IPCB_Polygon;
8913
+ net?: string;
8914
+ fillMode?: EPCB_PrimitiveFillMode;
8915
+ lineWidth?: number;
8916
+ primitiveLock?: boolean;
8917
+ }): Promise<IPCB_PrimitiveFill | undefined>;
8918
+ /**
8919
+ * 获取填充
8920
+ *
8921
+ * @beta
8922
+ * @param primitiveIds - 填充的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8923
+ * @returns 填充图元对象,`undefined` 表示获取失败
8924
+ */
8925
+ get(primitiveIds: string): Promise<IPCB_PrimitiveFill | undefined>;
8926
+ /**
8927
+ * 获取填充
8928
+ *
8929
+ * @beta
8930
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
8931
+ * @param primitiveIds - 填充的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8932
+ * @returns 填充图元对象,空数组表示获取失败
8933
+ */
8934
+ get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
8935
+ /**
8936
+ * 获取所有填充的图元 ID
8937
+ *
8938
+ * @beta
8939
+ * @param layer - 层
8940
+ * @param net - 网络名称
8941
+ * @param primitiveLock - 是否锁定
8942
+ * @returns 填充的图元 ID 数组
8943
+ */
8944
+ getAllPrimitiveId(layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean): Promise<Array<string>>;
8945
+ /**
8946
+ * 获取所有填充
8947
+ *
8948
+ * @beta
8949
+ * @param layer - 层
8950
+ * @param net - 网络名称
8951
+ * @param primitiveLock - 是否锁定
8952
+ * @returns 填充图元对象数组
8953
+ */
8954
+ getAll(layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveFill>>;
8531
8955
  }
8532
8956
 
8533
8957
  /**
@@ -8676,7 +9100,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
8676
9100
  * 获取直线
8677
9101
  *
8678
9102
  * @beta
8679
- * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9103
+ * @remarks 如若��入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
8680
9104
  * @param primitiveIds - 直线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8681
9105
  * @returns 直线图元对象,空数组表示获取失败
8682
9106
  */
@@ -8710,13 +9134,86 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
8710
9134
  * @remarks 彩色丝印图像属于二进制内嵌对象,需要使用二进制内嵌对象的方法创建和修改
8711
9135
  */
8712
9136
  declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
8713
- /* Excluded from this release type: create */
8714
- /* Excluded from this release type: delete */
8715
- /* Excluded from this release type: modify */
8716
- /* Excluded from this release type: get */
8717
- /* Excluded from this release type: get */
8718
- /* Excluded from this release type: getAllPrimitiveId */
8719
- /* Excluded from this release type: getAll */
9137
+ /**
9138
+ * 创建二进制内嵌对象
9139
+ *
9140
+ * @beta
9141
+ * @param layer -
9142
+ * @param topLeftX - 左上点 X
9143
+ * @param topLeftY - 左上点 Y
9144
+ * @param binaryData - 二进制数据
9145
+ * @param width - 宽
9146
+ * @param height - 高
9147
+ * @param rotation - 旋转角度
9148
+ * @param mirror - 是否水平镜像
9149
+ * @param fileName - 文件名
9150
+ * @param primitiveLock - 是否锁定
9151
+ * @returns - 二进制内嵌对象图元对象
9152
+ */
9153
+ create(layer: TPCB_LayersOfObject, topLeftX: number, topLeftY: number, binaryData: string, width: number, height: number, rotation?: number, mirror?: boolean, fileName?: string, primitiveLock?: boolean): Promise<IPCB_PrimitiveObject | undefined>;
9154
+ /**
9155
+ * 删除二进制内嵌对象
9156
+ *
9157
+ * @beta
9158
+ * @param primitiveIds - 二进制内嵌对象的图元 ID 或二进制内嵌对象图元对象
9159
+ * @returns 删除操作是否成功
9160
+ */
9161
+ delete(primitiveIds: string | IPCB_PrimitiveObject | Array<string> | Array<IPCB_PrimitiveObject>): Promise<boolean>;
9162
+ /**
9163
+ * 修改二进制内嵌对象
9164
+ *
9165
+ * @beta
9166
+ * @param primitiveId - 图元 ID
9167
+ * @param property - 修改参数
9168
+ * @returns 二进制内嵌对象图元对象,`undefined` 表示修改失败
9169
+ */
9170
+ modify(primitiveId: string | IPCB_PrimitiveObject, property: {
9171
+ layer?: TPCB_LayersOfObject;
9172
+ topLeftX?: number;
9173
+ topLeftY?: number;
9174
+ binaryData?: string;
9175
+ width?: number;
9176
+ height?: number;
9177
+ rotation?: number;
9178
+ mirror?: boolean;
9179
+ fileName?: string;
9180
+ primitiveLock?: boolean;
9181
+ }): Promise<IPCB_PrimitiveObject | undefined>;
9182
+ /**
9183
+ * 获取二进制内嵌对象
9184
+ *
9185
+ * @beta
9186
+ * @param primitiveIds - 二进制内嵌对象的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9187
+ * @returns 二进制内嵌对象图元对象,`undefined` 表示获取失败
9188
+ */
9189
+ get(primitiveIds: string): Promise<IPCB_PrimitiveObject | undefined>;
9190
+ /**
9191
+ * 获取二进制内嵌对象
9192
+ *
9193
+ * @beta
9194
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9195
+ * @param primitiveIds - 二进制内嵌对象的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9196
+ * @returns 二进制内嵌对象图元对象,空数组表示获取失败
9197
+ */
9198
+ get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveObject>>;
9199
+ /**
9200
+ * 获取所有二进制内嵌对象的图元 ID
9201
+ *
9202
+ * @beta
9203
+ * @param layer - 层
9204
+ * @param primitiveLock - 是否锁定
9205
+ * @returns 二进制内嵌对象的图元 ID 数组
9206
+ */
9207
+ getAllPrimitiveId(layer?: TPCB_LayersOfObject, primitiveLock?: boolean): Promise<Array<string>>;
9208
+ /**
9209
+ * 获取所有二进制内嵌对象
9210
+ *
9211
+ * @beta
9212
+ * @param layer - 层
9213
+ * @param primitiveLock - 是否锁定
9214
+ * @returns 二进制内嵌对象图元对象数组
9215
+ */
9216
+ getAll(layer?: TPCB_LayersOfObject, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveObject>>;
8720
9217
  }
8721
9218
 
8722
9219
  /**
@@ -8909,13 +9406,86 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
8909
9406
  * @public
8910
9407
  */
8911
9408
  declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
8912
- /* Excluded from this release type: create */
8913
- /* Excluded from this release type: delete */
8914
- /* Excluded from this release type: modify */
8915
- /* Excluded from this release type: get */
8916
- /* Excluded from this release type: get */
8917
- /* Excluded from this release type: getAllPrimitiveId */
8918
- /* Excluded from this release type: getAll */
9409
+ /**
9410
+ * 创建覆铜边框
9411
+ *
9412
+ * @beta
9413
+ * @param net - 网络名称
9414
+ * @param layer -
9415
+ * @param complexPolygon - 复杂多边形对象
9416
+ * @param pourFillMethod - 覆铜填充方法
9417
+ * @param preserveSilos - 是否保留孤岛
9418
+ * @param pourName - 覆铜名称
9419
+ * @param pourPriority - 覆铜优先级
9420
+ * @param lineWidth - 线宽
9421
+ * @param primitiveLock - 是否锁定
9422
+ * @returns 覆铜边框图元对象
9423
+ */
9424
+ create(net: string, layer: TPCB_LayersOfCopper, complexPolygon: IPCB_Polygon, pourFillMethod?: EPCB_PrimitivePourFillMethod, preserveSilos?: boolean, pourName?: string, pourPriority?: number, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitivePour | undefined>;
9425
+ /**
9426
+ * 删除覆铜边框
9427
+ *
9428
+ * @beta
9429
+ * @param primitiveIds - 覆铜边框的图元 ID 或覆铜边框图元对象
9430
+ * @returns 删除操作是否成功
9431
+ */
9432
+ delete(primitiveIds: string | IPCB_PrimitivePour | Array<string> | Array<IPCB_PrimitivePour>): Promise<boolean>;
9433
+ /**
9434
+ * 修改覆铜边框
9435
+ *
9436
+ * @beta
9437
+ * @param primitiveId - 图元 ID
9438
+ * @param property - 修改参数
9439
+ * @returns 覆铜边框图元对象,`undefined` 表示修改失败
9440
+ */
9441
+ modify(primitiveId: string | IPCB_PrimitivePour, property: {
9442
+ net?: string;
9443
+ layer?: TPCB_LayersOfCopper;
9444
+ complexPolygon?: IPCB_Polygon;
9445
+ pourFillMethod?: EPCB_PrimitivePourFillMethod;
9446
+ preserveSilos?: boolean;
9447
+ pourName?: string;
9448
+ pourPriority?: number;
9449
+ lineWidth?: number;
9450
+ primitiveLock?: boolean;
9451
+ }): Promise<IPCB_PrimitivePour | undefined>;
9452
+ /**
9453
+ * 获取覆铜边框
9454
+ *
9455
+ * @beta
9456
+ * @param primitiveIds - 覆铜边框的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9457
+ * @returns 覆铜边框图元对象,`undefined` 表示获取失败
9458
+ */
9459
+ get(primitiveIds: string): Promise<IPCB_PrimitivePour | undefined>;
9460
+ /**
9461
+ * 获取覆铜边框
9462
+ *
9463
+ * @beta
9464
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9465
+ * @param primitiveIds - 覆铜边框的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9466
+ * @returns 覆铜边框图元对象,空数组表示获取失败
9467
+ */
9468
+ get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePour>>;
9469
+ /**
9470
+ * 获取所有覆铜边框的图元 ID
9471
+ *
9472
+ * @beta
9473
+ * @param net - 网络名称
9474
+ * @param layer - 层
9475
+ * @param primitiveLock - 是否锁定
9476
+ * @returns 覆铜边框的图元 ID 数组
9477
+ */
9478
+ getAllPrimitiveId(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<string>>;
9479
+ /**
9480
+ * 获取所有填充
9481
+ *
9482
+ * @beta
9483
+ * @param net - 网络名称
9484
+ * @param layer - 层
9485
+ * @param primitiveLock - 是否锁定
9486
+ * @returns 覆铜边框图元对象数组
9487
+ */
9488
+ getAll(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePour>>;
8919
9489
  }
8920
9490
 
8921
9491
  /**
@@ -8924,13 +9494,80 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
8924
9494
  * @public
8925
9495
  */
8926
9496
  declare class PCB_PrimitiveRegion implements IPCB_PrimitiveAPI {
8927
- /* Excluded from this release type: create */
8928
- /* Excluded from this release type: delete */
8929
- /* Excluded from this release type: modify */
8930
- /* Excluded from this release type: get */
8931
- /* Excluded from this release type: get */
8932
- /* Excluded from this release type: getAllPrimitiveId */
8933
- /* Excluded from this release type: getAll */
9497
+ /**
9498
+ * 创建区域
9499
+ *
9500
+ * @beta
9501
+ * @param layer -
9502
+ * @param complexPolygon - 复杂多边形对象
9503
+ * @param ruleType - 区域规则类型
9504
+ * @param reginName - 区域名称
9505
+ * @param lineWidth - 线宽
9506
+ * @param primitiveLock - 是否锁定
9507
+ * @returns 区域图元对象
9508
+ */
9509
+ create(layer: TPCB_LayersOfRegion, complexPolygon: IPCB_Polygon, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, regionName?: string, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveRegion | undefined>;
9510
+ /**
9511
+ * 删除区域
9512
+ *
9513
+ * @beta
9514
+ * @param primitiveIds - 区域的图元 ID 或区域图元对象
9515
+ * @returns 删除操作是否成功
9516
+ */
9517
+ delete(primitiveIds: string | IPCB_PrimitiveRegion | Array<string> | Array<IPCB_PrimitiveRegion>): Promise<boolean>;
9518
+ /**
9519
+ * 修改区域
9520
+ *
9521
+ * @beta
9522
+ * @param primitiveId - 图元 ID
9523
+ * @param property - 修改参数
9524
+ * @returns 区域图元对象,`undefined` 表示修改失败
9525
+ */
9526
+ modify(primitiveId: string | IPCB_PrimitiveRegion, property: {
9527
+ layer?: TPCB_LayersOfRegion;
9528
+ complexPolygon?: IPCB_Polygon;
9529
+ ruleType?: Array<EPCB_PrimitiveRegionRuleType>;
9530
+ regionName?: string;
9531
+ lineWidth?: number;
9532
+ primitiveLock?: boolean;
9533
+ }): Promise<IPCB_PrimitiveRegion | undefined>;
9534
+ /**
9535
+ * 获取区域
9536
+ *
9537
+ * @beta
9538
+ * @param primitiveIds - 区域的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9539
+ * @returns 区域图元对象,`undefined` 表示获取失败
9540
+ */
9541
+ get(primitiveIds: string): Promise<IPCB_PrimitiveRegion | undefined>;
9542
+ /**
9543
+ * 获取区域
9544
+ *
9545
+ * @beta
9546
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9547
+ * @param primitiveIds - 区域的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9548
+ * @returns 区域图元对象,空数组表示获取失败
9549
+ */
9550
+ get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveRegion>>;
9551
+ /**
9552
+ * 获取所有区域的图元 ID
9553
+ *
9554
+ * @beta
9555
+ * @param layer - 层
9556
+ * @param ruleType - 区域规则类型,只会匹配所有规则类型均一致的图元
9557
+ * @param primitiveLock - 是否锁定
9558
+ * @returns 区域的图元 ID 数组
9559
+ */
9560
+ getAllPrimitiveId(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<string>>;
9561
+ /**
9562
+ * 获取所有区域
9563
+ *
9564
+ * @beta
9565
+ * @param layer - 层
9566
+ * @param ruleType - 区域规则类型,只会匹配所有规则类型均一致的图元
9567
+ * @param primitiveLock - 是否锁定
9568
+ * @returns 区域图元对象数组
9569
+ */
9570
+ getAll(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveRegion>>;
8934
9571
  }
8935
9572
 
8936
9573
  /**
@@ -9387,7 +10024,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
9387
10024
  *
9388
10025
  * @beta
9389
10026
  * @param busName - 总线名称
9390
- * @param line - 多段线坐标组,每段都是连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线,如若多段线彼此无任何连接则创建将会失败
10027
+ * @param line - 多段线坐标组,每段都是连续的��组 `[x1, y1, x2, y2, x3, y3]` 所描述的线,如若多段线彼此无任何连接则创建将会失败
9391
10028
  * @param color - 总线颜色,`null` 表示默认
9392
10029
  * @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
9393
10030
  * @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
@@ -9477,7 +10114,7 @@ declare class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI {
9477
10114
  * @param centerY - 圆心 Y
9478
10115
  * @param radius - 半径
9479
10116
  * @param color - 颜色,`null` 表示默认
9480
- * @param fillColor - 填充���色,`none` 表示无填充,`null` 表示默认
10117
+ * @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
9481
10118
  * @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
9482
10119
  * @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
9483
10120
  * @returns 圆图元对象
@@ -10611,8 +11248,28 @@ declare class SYS_IFrame {
10611
11248
  * @returns 操作是否成功
10612
11249
  */
10613
11250
  closeIFrame(id?: string): Promise<boolean>;
10614
- /* Excluded from this release type: hideIFrame */
10615
- /* Excluded from this release type: showIFrame */
11251
+ /**
11252
+ * 隐藏内联框架窗口
11253
+ *
11254
+ * @beta
11255
+ * @remarks 本接口为结果导向的:
11256
+ * 如若未找到指定内联框架窗口,接口将会返回 `false`;
11257
+ * 如若在执行操作前该内联框架窗口已处于隐藏状态,接口将会返回 `true`
11258
+ * @param id - 内联框架窗口 ID
11259
+ * @returns 操作是否成功
11260
+ */
11261
+ hideIFrame(id?: string): Promise<boolean>;
11262
+ /**
11263
+ * 显示内联框架窗口
11264
+ *
11265
+ * @beta
11266
+ * @remarks 本接口为结果导向的:
11267
+ * 如若未找到指定内联框架窗口,接口将会返回 `false`;
11268
+ * 如若在执行操作前该内联框架窗口已处于显示状态,接口将会返回 `true`
11269
+ * @param id - 内联框架窗口 ID
11270
+ * @returns 操作是否成功
11271
+ */
11272
+ showIFrame(id?: string): Promise<boolean>;
10616
11273
  }
10617
11274
 
10618
11275
  /**
@@ -10691,7 +11348,7 @@ declare class SYS_Log {
10691
11348
  * 查找条目
10692
11349
  *
10693
11350
  * @public
10694
- * @remarks 如果日志面板处于打开状态,查找操���会同时在前端展现
11351
+ * @remarks 如果日志面板处于打开状态,查找操作会同时在前端展现
10695
11352
  * @param message - 查找内容
10696
11353
  * @param types - 日志类型数组,可以在指定的日志类型内查找
10697
11354
  * @returns 符合查找条件的日志条目数组
@@ -10943,7 +11600,7 @@ declare class SYS_Storage {
10943
11600
  * 获取扩展用户配置
10944
11601
  *
10945
11602
  * @public
10946
- * @remarks 注意:本接口仅扩���有效,在独立脚本环境内调用将始终 `throw Error`
11603
+ * @remarks 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
10947
11604
  * @param key - 配置项
10948
11605
  * @returns 配置项对应的值,不存在将返回 `undefined`
10949
11606
  */
@@ -11033,7 +11690,7 @@ declare class SYS_Timer {
11033
11690
  */
11034
11691
  declare class SYS_ToastMessage {
11035
11692
  /**
11036
- * 显示吐司消息
11693
+ * 显��吐司消息
11037
11694
  *
11038
11695
  * @public
11039
11696
  * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.107",
3
+ "version": "0.1.109",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [