@jlceda/pro-api-types 0.1.106 → 0.1.108
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.
- package/index.d.ts +803 -121
- 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
|
|
199
|
+
* @returns 文���夹 UUID,如若为 `undefined` 则创建失败
|
|
200
200
|
*/
|
|
201
201
|
createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
|
|
202
202
|
/**
|
|
@@ -1342,6 +1342,20 @@ declare enum EPCB_PrimitivePadShapeType {
|
|
|
1342
1342
|
POLYLINE_COMPLEX_POLYGON = "POLYGON"
|
|
1343
1343
|
}
|
|
1344
1344
|
|
|
1345
|
+
/**
|
|
1346
|
+
* 覆铜填充方法
|
|
1347
|
+
*
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
declare enum EPCB_PrimitivePourFillMethod {
|
|
1351
|
+
/** 45 度网格 */
|
|
1352
|
+
GRID45 = "45grid",
|
|
1353
|
+
/** 90 度网格 */
|
|
1354
|
+
GRID = "90grid",
|
|
1355
|
+
/** 实心填充 */
|
|
1356
|
+
SOLID = "solid"
|
|
1357
|
+
}
|
|
1358
|
+
|
|
1345
1359
|
/**
|
|
1346
1360
|
* 区域图元区域规则类型
|
|
1347
1361
|
*
|
|
@@ -1506,7 +1520,20 @@ declare enum ESCH_PrimitiveType {
|
|
|
1506
1520
|
/** 文本 */
|
|
1507
1521
|
TEXT = "Text",
|
|
1508
1522
|
/** 导线 */
|
|
1509
|
-
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"
|
|
1510
1537
|
}
|
|
1511
1538
|
|
|
1512
1539
|
/**
|
|
@@ -2762,8 +2789,21 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
|
|
|
2762
2789
|
* @returns 圆弧线图元对象
|
|
2763
2790
|
*/
|
|
2764
2791
|
done(): Promise<IPCB_PrimitiveArc>;
|
|
2765
|
-
|
|
2766
|
-
|
|
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>>;
|
|
2767
2807
|
}
|
|
2768
2808
|
|
|
2769
2809
|
/**
|
|
@@ -3120,7 +3160,13 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
|
|
|
3120
3160
|
* @returns 器件图元对象
|
|
3121
3161
|
*/
|
|
3122
3162
|
done(): Promise<IPCB_PrimitiveComponent>;
|
|
3123
|
-
|
|
3163
|
+
/**
|
|
3164
|
+
* 获取器件关联的所有焊盘
|
|
3165
|
+
*
|
|
3166
|
+
* @beta
|
|
3167
|
+
* @returns 器件焊盘图元数组
|
|
3168
|
+
*/
|
|
3169
|
+
getAllPins(): Promise<IPCB_PrimitiveComponentPad[]>;
|
|
3124
3170
|
/* Excluded from this release type: setState_Component */
|
|
3125
3171
|
}
|
|
3126
3172
|
|
|
@@ -3141,7 +3187,13 @@ declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
|
|
|
3141
3187
|
/* Excluded from this release type: setState_Layer */
|
|
3142
3188
|
/* Excluded from this release type: setState_PadNumber */
|
|
3143
3189
|
/* Excluded from this release type: reset */
|
|
3144
|
-
|
|
3190
|
+
/**
|
|
3191
|
+
* 将对图元的更改应用到画布
|
|
3192
|
+
*
|
|
3193
|
+
* @beta
|
|
3194
|
+
* @returns 器件焊盘图元对象
|
|
3195
|
+
*/
|
|
3196
|
+
done(): Promise<IPCB_PrimitiveComponentPad>;
|
|
3145
3197
|
}
|
|
3146
3198
|
|
|
3147
3199
|
/**
|
|
@@ -3377,6 +3429,13 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3377
3429
|
* @returns 图元 ID
|
|
3378
3430
|
*/
|
|
3379
3431
|
getState_PrimitiveId(): string;
|
|
3432
|
+
/**
|
|
3433
|
+
* 获取属性状态:网络名称
|
|
3434
|
+
*
|
|
3435
|
+
* @public
|
|
3436
|
+
* @returns 网络名称
|
|
3437
|
+
*/
|
|
3438
|
+
getState_Net(): string | undefined;
|
|
3380
3439
|
/**
|
|
3381
3440
|
* 获取属性状态:层
|
|
3382
3441
|
*
|
|
@@ -3391,13 +3450,6 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3391
3450
|
* @returns 复杂多边形
|
|
3392
3451
|
*/
|
|
3393
3452
|
getState_ComplexPolygon(): IPCB_Polygon;
|
|
3394
|
-
/**
|
|
3395
|
-
* 获取属性状态:网络名称
|
|
3396
|
-
*
|
|
3397
|
-
* @public
|
|
3398
|
-
* @returns 网络名称
|
|
3399
|
-
*/
|
|
3400
|
-
getState_Net(): string | undefined;
|
|
3401
3453
|
/**
|
|
3402
3454
|
* 获取属性状态:填充模式
|
|
3403
3455
|
*
|
|
@@ -3413,7 +3465,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3413
3465
|
*/
|
|
3414
3466
|
getState_LineWidth(): number;
|
|
3415
3467
|
/**
|
|
3416
|
-
*
|
|
3468
|
+
* 获取属性状态:是否锁定
|
|
3417
3469
|
*
|
|
3418
3470
|
* @public
|
|
3419
3471
|
* @returns 是否锁定
|
|
@@ -3488,11 +3540,41 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3488
3540
|
* @returns 是否为异步图元
|
|
3489
3541
|
*/
|
|
3490
3542
|
isAsync(): boolean;
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
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>;
|
|
3496
3578
|
}
|
|
3497
3579
|
|
|
3498
3580
|
/**
|
|
@@ -3740,7 +3822,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3740
3822
|
* 获取属性状态:图元类型
|
|
3741
3823
|
*
|
|
3742
3824
|
* @public
|
|
3743
|
-
* @returns
|
|
3825
|
+
* @returns 图元类型
|
|
3744
3826
|
*/
|
|
3745
3827
|
getState_PrimitiveType(): EPCB_PrimitiveType;
|
|
3746
3828
|
/**
|
|
@@ -3905,8 +3987,21 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3905
3987
|
* @returns 直线图元对象
|
|
3906
3988
|
*/
|
|
3907
3989
|
done(): Promise<IPCB_PrimitiveLine>;
|
|
3908
|
-
|
|
3909
|
-
|
|
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>>;
|
|
3910
4005
|
}
|
|
3911
4006
|
|
|
3912
4007
|
/**
|
|
@@ -4128,8 +4223,20 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4128
4223
|
* @returns 是否为异步图元
|
|
4129
4224
|
*/
|
|
4130
4225
|
isAsync(): boolean;
|
|
4131
|
-
|
|
4132
|
-
|
|
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>;
|
|
4133
4240
|
}
|
|
4134
4241
|
|
|
4135
4242
|
/**
|
|
@@ -4285,7 +4392,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4285
4392
|
*/
|
|
4286
4393
|
getState_Metallization(): boolean;
|
|
4287
4394
|
/**
|
|
4288
|
-
*
|
|
4395
|
+
* ���取属性状态:焊盘功能
|
|
4289
4396
|
*
|
|
4290
4397
|
* @public
|
|
4291
4398
|
* @returns 焊盘功能
|
|
@@ -4689,9 +4796,27 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4689
4796
|
* @returns 折线图元对象
|
|
4690
4797
|
*/
|
|
4691
4798
|
done(): Promise<IPCB_PrimitivePolyline>;
|
|
4692
|
-
|
|
4693
|
-
|
|
4694
|
-
|
|
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>;
|
|
4695
4820
|
}
|
|
4696
4821
|
|
|
4697
4822
|
/**
|
|
@@ -4834,7 +4959,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4834
4959
|
* @param pourFillMethod - 覆铜填充方法
|
|
4835
4960
|
* @returns 覆铜边框图元对象
|
|
4836
4961
|
*/
|
|
4837
|
-
setState_PourFillMethod(pourFillMethod:
|
|
4962
|
+
setState_PourFillMethod(pourFillMethod: EPCB_PrimitivePourFillMethod): IPCB_PrimitivePour;
|
|
4838
4963
|
/**
|
|
4839
4964
|
* 设置属性状态:是否保留孤岛
|
|
4840
4965
|
*
|
|
@@ -4896,11 +5021,41 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4896
5021
|
* @returns 是否为异步图元
|
|
4897
5022
|
*/
|
|
4898
5023
|
isAsync(): boolean;
|
|
4899
|
-
|
|
4900
|
-
|
|
4901
|
-
|
|
4902
|
-
|
|
4903
|
-
|
|
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>;
|
|
4904
5059
|
}
|
|
4905
5060
|
|
|
4906
5061
|
/**
|
|
@@ -5058,11 +5213,41 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
|
|
|
5058
5213
|
* @returns 是否为异步图元
|
|
5059
5214
|
*/
|
|
5060
5215
|
isAsync(): boolean;
|
|
5061
|
-
|
|
5062
|
-
|
|
5063
|
-
|
|
5064
|
-
|
|
5065
|
-
|
|
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>;
|
|
5066
5251
|
}
|
|
5067
5252
|
|
|
5068
5253
|
/**
|
|
@@ -5307,7 +5492,14 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
5307
5492
|
* @returns 过孔图元对象
|
|
5308
5493
|
*/
|
|
5309
5494
|
done(): Promise<IPCB_PrimitiveVia>;
|
|
5310
|
-
|
|
5495
|
+
/**
|
|
5496
|
+
* 获取相邻的图元对象
|
|
5497
|
+
*
|
|
5498
|
+
* @beta
|
|
5499
|
+
* @remarks 将会获取与过孔直接相连的导线、圆弧线图元对象
|
|
5500
|
+
* @returns 相邻的导线、圆弧线图元对象
|
|
5501
|
+
*/
|
|
5502
|
+
getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
|
|
5311
5503
|
}
|
|
5312
5504
|
|
|
5313
5505
|
/**
|
|
@@ -6910,6 +7102,7 @@ declare class LIB_Footprint {
|
|
|
6910
7102
|
* @returns 封装 UUID
|
|
6911
7103
|
*/
|
|
6912
7104
|
create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
|
|
7105
|
+
/* Excluded from this release type: createByDocumentSource */
|
|
6913
7106
|
/**
|
|
6914
7107
|
* 删除封装
|
|
6915
7108
|
*
|
|
@@ -7127,6 +7320,7 @@ declare class LIB_Symbol {
|
|
|
7127
7320
|
* @returns 符号 UUID
|
|
7128
7321
|
*/
|
|
7129
7322
|
create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
|
|
7323
|
+
/* Excluded from this release type: createByDocumentSource */
|
|
7130
7324
|
/**
|
|
7131
7325
|
* 删除符号
|
|
7132
7326
|
*
|
|
@@ -7219,6 +7413,15 @@ declare class PCB_Document {
|
|
|
7219
7413
|
* @returns 导入操作是否成功
|
|
7220
7414
|
*/
|
|
7221
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>;
|
|
7222
7425
|
/**
|
|
7223
7426
|
* 导入旧版自动布局文件(JSON)
|
|
7224
7427
|
*
|
|
@@ -7271,7 +7474,7 @@ declare class PCB_Document {
|
|
|
7271
7474
|
* 输入画布坐标返回该坐标对应的数据坐标
|
|
7272
7475
|
*
|
|
7273
7476
|
* @public
|
|
7274
|
-
* @remarks 嘉立创 EDA
|
|
7477
|
+
* @remarks 嘉立创 EDA 前端显示的坐标均为画布原点;嘉立�� EDA API 使用的均为数据原点;在创建 PCB 时,默认画布原点等于数据原点
|
|
7275
7478
|
* @param canvasOriginX - 画布原点 X
|
|
7276
7479
|
* @param canvasOriginY - 画布原点 Y
|
|
7277
7480
|
* @returns 数据原点坐标
|
|
@@ -7840,7 +8043,7 @@ declare class PCB_Layer {
|
|
|
7840
8043
|
*
|
|
7841
8044
|
* @beta
|
|
7842
8045
|
* @remarks
|
|
7843
|
-
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC
|
|
8046
|
+
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板���将会新增 FPC 补强层图层。
|
|
7844
8047
|
*
|
|
7845
8048
|
* 请注意:
|
|
7846
8049
|
*
|
|
@@ -7960,7 +8163,14 @@ declare class PCB_ManufactureData {
|
|
|
7960
8163
|
* @returns 坐标文件数据
|
|
7961
8164
|
*/
|
|
7962
8165
|
getPickAndPlaceFile(fileName?: string, fileType?: 'xlsx' | 'csv', unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.MIL): Promise<File | undefined>;
|
|
7963
|
-
|
|
8166
|
+
/**
|
|
8167
|
+
* 获取飞针测试文件
|
|
8168
|
+
*
|
|
8169
|
+
* @beta
|
|
8170
|
+
* @param fileName - 文件名
|
|
8171
|
+
* @returns 飞针测试文件数据
|
|
8172
|
+
*/
|
|
8173
|
+
getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;
|
|
7964
8174
|
/**
|
|
7965
8175
|
* 获取 BOM 文件
|
|
7966
8176
|
*
|
|
@@ -8005,8 +8215,49 @@ declare class PCB_ManufactureData {
|
|
|
8005
8215
|
layerId: number;
|
|
8006
8216
|
mirror: boolean;
|
|
8007
8217
|
}>, objects?: Array<string>): Promise<File | undefined>;
|
|
8008
|
-
|
|
8009
|
-
|
|
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>;
|
|
8010
8261
|
/**
|
|
8011
8262
|
* 获取 ODB++ 文件
|
|
8012
8263
|
*
|
|
@@ -8078,63 +8329,151 @@ declare class PCB_ManufactureData {
|
|
|
8078
8329
|
* @returns 自动布局 JSON 文件数据
|
|
8079
8330
|
*/
|
|
8080
8331
|
getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
|
|
8081
|
-
/* Excluded from this release type: getAltiumDesignerFile */
|
|
8082
|
-
/* Excluded from this release type: getPadsFile */
|
|
8083
8332
|
/**
|
|
8084
|
-
* 获取
|
|
8333
|
+
* 获取 Altium Designer 文件
|
|
8085
8334
|
*
|
|
8086
8335
|
* @beta
|
|
8087
8336
|
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
|
|
8088
8337
|
* @param fileName - 文件名
|
|
8089
|
-
* @returns
|
|
8338
|
+
* @returns Altium Designer 文件数据
|
|
8090
8339
|
*/
|
|
8091
|
-
|
|
8092
|
-
/* Excluded from this release type: placeComponentsOrder */
|
|
8093
|
-
/* Excluded from this release type: placeSmtComponentsOrder */
|
|
8094
|
-
/* Excluded from this release type: placePcbOrder */
|
|
8095
|
-
/* Excluded from this release type: place3DShellOrder */
|
|
8096
|
-
}
|
|
8097
|
-
|
|
8098
|
-
/**
|
|
8099
|
-
* PCB & 封装 / 多边形数学类
|
|
8100
|
-
*
|
|
8101
|
-
* @public
|
|
8102
|
-
*/
|
|
8103
|
-
declare class PCB_MathPolygon {
|
|
8340
|
+
getAltiumDesignerFile(fileName?: string): Promise<File | undefined>;
|
|
8104
8341
|
/**
|
|
8105
|
-
*
|
|
8342
|
+
* 获取 PADS 文件
|
|
8106
8343
|
*
|
|
8107
|
-
* @
|
|
8108
|
-
* @
|
|
8109
|
-
* @
|
|
8344
|
+
* @beta
|
|
8345
|
+
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
|
|
8346
|
+
* @param fileName - 文件名
|
|
8347
|
+
* @returns PADS 文件数据
|
|
8110
8348
|
*/
|
|
8111
|
-
|
|
8349
|
+
getPadsFile(fileName?: string): Promise<File | undefined>;
|
|
8112
8350
|
/**
|
|
8113
|
-
*
|
|
8351
|
+
* 获取 PCB 信息文件
|
|
8114
8352
|
*
|
|
8115
|
-
* @
|
|
8116
|
-
* @
|
|
8117
|
-
* @
|
|
8353
|
+
* @beta
|
|
8354
|
+
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
|
|
8355
|
+
* @param fileName - 文件名
|
|
8356
|
+
* @returns PCB 信息文件
|
|
8118
8357
|
*/
|
|
8119
|
-
|
|
8358
|
+
getPcbInfoFile(fileName?: string): Promise<File | undefined>;
|
|
8120
8359
|
/**
|
|
8121
|
-
*
|
|
8360
|
+
* 元件下单
|
|
8122
8361
|
*
|
|
8123
|
-
* @
|
|
8124
|
-
* @param
|
|
8125
|
-
*
|
|
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 是否通过下单检查
|
|
8126
8376
|
*/
|
|
8127
|
-
|
|
8128
|
-
/* Excluded from this release type: calculateWidth */
|
|
8129
|
-
/* Excluded from this release type: calculateHeight */
|
|
8377
|
+
placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
|
|
8130
8378
|
/**
|
|
8131
|
-
*
|
|
8379
|
+
* SMT 元件下单
|
|
8132
8380
|
*
|
|
8133
8381
|
* @beta
|
|
8134
|
-
* @param
|
|
8135
|
-
*
|
|
8136
|
-
*
|
|
8137
|
-
*
|
|
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>;
|
|
8435
|
+
}
|
|
8436
|
+
|
|
8437
|
+
/**
|
|
8438
|
+
* PCB & 封装 / 多边形数学类
|
|
8439
|
+
*
|
|
8440
|
+
* @public
|
|
8441
|
+
*/
|
|
8442
|
+
declare class PCB_MathPolygon {
|
|
8443
|
+
/**
|
|
8444
|
+
* 创建单多边形
|
|
8445
|
+
*
|
|
8446
|
+
* @public
|
|
8447
|
+
* @param polygon - 单多边形数据
|
|
8448
|
+
* @returns 单多边形对象,`undefined` 表示数据不合法
|
|
8449
|
+
*/
|
|
8450
|
+
createPolygon(polygon: TPCB_PolygonSourceArray): IPCB_Polygon | undefined;
|
|
8451
|
+
/**
|
|
8452
|
+
* 创建复杂多边形
|
|
8453
|
+
*
|
|
8454
|
+
* @public
|
|
8455
|
+
* @param complexPolygon - 复杂多边形数据
|
|
8456
|
+
* @returns 复杂多边形对象,`undefined` 表示数据不合法
|
|
8457
|
+
*/
|
|
8458
|
+
createComplexPolygon(complexPolygon: TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | Array<IPCB_Polygon>): IPCB_ComplexPolygon | undefined;
|
|
8459
|
+
/**
|
|
8460
|
+
* 拆分单多边形
|
|
8461
|
+
*
|
|
8462
|
+
* @public
|
|
8463
|
+
* @param complexPolygons - 复杂多边形
|
|
8464
|
+
* @returns 单多边形数组
|
|
8465
|
+
*/
|
|
8466
|
+
splitPolygon(...complexPolygons: Array<IPCB_ComplexPolygon>): Array<IPCB_Polygon>;
|
|
8467
|
+
/* Excluded from this release type: calculateWidth */
|
|
8468
|
+
/* Excluded from this release type: calculateHeight */
|
|
8469
|
+
/**
|
|
8470
|
+
* 将图像转换为复杂多边形对象
|
|
8471
|
+
*
|
|
8472
|
+
* @beta
|
|
8473
|
+
* @param imageBlob - 图像 Blob 文件,可以使用 {@link SYS_FileSystem.openReadFileDialog} 方法从文件系统读取文件
|
|
8474
|
+
* @param imageWidth - 图像宽度
|
|
8475
|
+
* @param imageHeight - 图像高度
|
|
8476
|
+
* @param tolerance - 容差,取值范围 `0`-`1`
|
|
8138
8477
|
* @param simplification - 简化,取值范围 `0`-`1`
|
|
8139
8478
|
* @param smoothing - 平滑,取值范围 `0`-`1.33`
|
|
8140
8479
|
* @param despeckling - 去斑,取值范围 `0`-`5`
|
|
@@ -8193,7 +8532,15 @@ declare class PCB_Net {
|
|
|
8193
8532
|
* @returns 操作是否成功
|
|
8194
8533
|
*/
|
|
8195
8534
|
highlightNet(net: string): Promise<boolean>;
|
|
8196
|
-
|
|
8535
|
+
/**
|
|
8536
|
+
* 取消高亮网络
|
|
8537
|
+
*
|
|
8538
|
+
* @beta
|
|
8539
|
+
* @remarks 本接口的返回值为结果导向,如果该网络原先未高亮,也将返回 `true`
|
|
8540
|
+
* @param net - 网络名称
|
|
8541
|
+
* @returns 操作是否成功
|
|
8542
|
+
*/
|
|
8543
|
+
unhighlightNet(net: string): Promise<boolean>;
|
|
8197
8544
|
/* Excluded from this release type: unhighlightAllNets */
|
|
8198
8545
|
/**
|
|
8199
8546
|
* 获取网表
|
|
@@ -8223,7 +8570,19 @@ declare class PCB_Primitive {
|
|
|
8223
8570
|
/* Excluded from this release type: getPrimitiveTypeByPrimitiveId */
|
|
8224
8571
|
/* Excluded from this release type: getPrimitiveByPrimitiveId */
|
|
8225
8572
|
/* Excluded from this release type: getPrimitivesByPrimitiveId */
|
|
8226
|
-
|
|
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>;
|
|
8227
8586
|
}
|
|
8228
8587
|
|
|
8229
8588
|
/**
|
|
@@ -8420,7 +8779,14 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
|
|
|
8420
8779
|
* @returns 器件图元对象数组
|
|
8421
8780
|
*/
|
|
8422
8781
|
getAll(layer?: TPCB_LayersOfComponent, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveComponent>>;
|
|
8423
|
-
|
|
8782
|
+
/**
|
|
8783
|
+
* 获取器件关联的所有焊盘
|
|
8784
|
+
*
|
|
8785
|
+
* @beta
|
|
8786
|
+
* @param primitiveId - 器件图元 ID
|
|
8787
|
+
* @returns 器件焊盘图元数组
|
|
8788
|
+
*/
|
|
8789
|
+
getAllPinsByPrimitiveId(primitiveId: string): Promise<Array<IPCB_PrimitiveComponentPad> | undefined>;
|
|
8424
8790
|
/* Excluded from this release type: placeComponentWithMouse */
|
|
8425
8791
|
}
|
|
8426
8792
|
|
|
@@ -8512,13 +8878,80 @@ declare class PCB_PrimitiveDimension implements IPCB_PrimitiveAPI {
|
|
|
8512
8878
|
* @public
|
|
8513
8879
|
*/
|
|
8514
8880
|
declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
|
|
8515
|
-
|
|
8516
|
-
|
|
8517
|
-
|
|
8518
|
-
|
|
8519
|
-
|
|
8520
|
-
|
|
8521
|
-
|
|
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>>;
|
|
8522
8955
|
}
|
|
8523
8956
|
|
|
8524
8957
|
/**
|
|
@@ -8701,13 +9134,86 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
|
|
|
8701
9134
|
* @remarks 彩色丝印图像属于二进制内嵌对象,需要使用二进制内嵌对象的方法创建和修改
|
|
8702
9135
|
*/
|
|
8703
9136
|
declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
|
|
8704
|
-
|
|
8705
|
-
|
|
8706
|
-
|
|
8707
|
-
|
|
8708
|
-
|
|
8709
|
-
|
|
8710
|
-
|
|
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>>;
|
|
8711
9217
|
}
|
|
8712
9218
|
|
|
8713
9219
|
/**
|
|
@@ -8900,13 +9406,86 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
|
|
|
8900
9406
|
* @public
|
|
8901
9407
|
*/
|
|
8902
9408
|
declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
|
|
8903
|
-
|
|
8904
|
-
|
|
8905
|
-
|
|
8906
|
-
|
|
8907
|
-
|
|
8908
|
-
|
|
8909
|
-
|
|
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>>;
|
|
8910
9489
|
}
|
|
8911
9490
|
|
|
8912
9491
|
/**
|
|
@@ -8915,13 +9494,80 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
|
|
|
8915
9494
|
* @public
|
|
8916
9495
|
*/
|
|
8917
9496
|
declare class PCB_PrimitiveRegion implements IPCB_PrimitiveAPI {
|
|
8918
|
-
|
|
8919
|
-
|
|
8920
|
-
|
|
8921
|
-
|
|
8922
|
-
|
|
8923
|
-
|
|
8924
|
-
|
|
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>>;
|
|
8925
9571
|
}
|
|
8926
9572
|
|
|
8927
9573
|
/**
|
|
@@ -9024,7 +9670,13 @@ declare class PCB_SelectControl {
|
|
|
9024
9670
|
* @returns 所有已选中图元的图元 ID
|
|
9025
9671
|
*/
|
|
9026
9672
|
getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
|
|
9027
|
-
|
|
9673
|
+
/**
|
|
9674
|
+
* 查询所有已选中图元的图元对象
|
|
9675
|
+
*
|
|
9676
|
+
* @beta
|
|
9677
|
+
* @returns 所有已选中图元的图元对象
|
|
9678
|
+
*/
|
|
9679
|
+
getAllSelectedPrimitives(): Promise<Array<IPCB_Primitive>>;
|
|
9028
9680
|
/**
|
|
9029
9681
|
* 查询选中图元的所有参数
|
|
9030
9682
|
*
|
|
@@ -9059,7 +9711,16 @@ declare class PCB_SelectControl {
|
|
|
9059
9711
|
* @returns 操作是否成功
|
|
9060
9712
|
*/
|
|
9061
9713
|
clearSelected(): Promise<boolean>;
|
|
9062
|
-
|
|
9714
|
+
/**
|
|
9715
|
+
* 获取当前鼠标在画布上的位置
|
|
9716
|
+
*
|
|
9717
|
+
* @beta
|
|
9718
|
+
* @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
|
|
9719
|
+
*/
|
|
9720
|
+
getCurrentMousePosition(): Promise<{
|
|
9721
|
+
x: number;
|
|
9722
|
+
y: number;
|
|
9723
|
+
} | undefined>;
|
|
9063
9724
|
}
|
|
9064
9725
|
|
|
9065
9726
|
/**
|
|
@@ -10088,8 +10749,20 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
|
|
|
10088
10749
|
* @remarks 获取或操作选择的元素
|
|
10089
10750
|
*/
|
|
10090
10751
|
declare class SCH_SelectControl {
|
|
10091
|
-
|
|
10092
|
-
|
|
10752
|
+
/**
|
|
10753
|
+
* 查询所有已选中图元的图元 ID
|
|
10754
|
+
*
|
|
10755
|
+
* @beta
|
|
10756
|
+
* @returns 所有已选中图元的图元 ID
|
|
10757
|
+
*/
|
|
10758
|
+
getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
|
|
10759
|
+
/**
|
|
10760
|
+
* 查询所有已选中图元的图元对象
|
|
10761
|
+
*
|
|
10762
|
+
* @beta
|
|
10763
|
+
* @returns 所有已选中图元的图元对象
|
|
10764
|
+
*/
|
|
10765
|
+
getAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;
|
|
10093
10766
|
/**
|
|
10094
10767
|
* 查询选中图元的图元 ID
|
|
10095
10768
|
*
|
|
@@ -10133,7 +10806,16 @@ declare class SCH_SelectControl {
|
|
|
10133
10806
|
* @returns 操作是否成功
|
|
10134
10807
|
*/
|
|
10135
10808
|
clearSelected(): boolean;
|
|
10136
|
-
|
|
10809
|
+
/**
|
|
10810
|
+
* 获取当前鼠标在画布上的位置
|
|
10811
|
+
*
|
|
10812
|
+
* @beta
|
|
10813
|
+
* @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
|
|
10814
|
+
*/
|
|
10815
|
+
getCurrentMousePosition(): Promise<{
|
|
10816
|
+
x: number;
|
|
10817
|
+
y: number;
|
|
10818
|
+
} | undefined>;
|
|
10137
10819
|
}
|
|
10138
10820
|
|
|
10139
10821
|
/**
|
|
@@ -10391,7 +11073,7 @@ declare class SYS_FileSystem {
|
|
|
10391
11073
|
*
|
|
10392
11074
|
* @beta
|
|
10393
11075
|
* @param filenameExtensions - 文件扩展名
|
|
10394
|
-
* @returns File
|
|
11076
|
+
* @returns File 格式��件
|
|
10395
11077
|
*/
|
|
10396
11078
|
openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
|
|
10397
11079
|
/**
|