@jlceda/pro-api-types 0.1.101 → 0.1.103
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 +97 -64
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -416,7 +416,7 @@ declare class DMT_Project {
|
|
|
416
416
|
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
417
417
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
418
418
|
* @param description - 工程描述
|
|
419
|
-
* @param collaborationMode -
|
|
419
|
+
* @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则该���数将被忽略
|
|
420
420
|
* @returns 工程 UUID,如若为 `undefined` 则创建失败
|
|
421
421
|
*/
|
|
422
422
|
createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
|
|
@@ -595,7 +595,7 @@ declare class DMT_Schematic {
|
|
|
595
595
|
*/
|
|
596
596
|
getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
598
|
+
* 获取当前原理图图页的详细属性
|
|
599
599
|
*
|
|
600
600
|
* @beta
|
|
601
601
|
* @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
|
|
@@ -1017,7 +1017,7 @@ declare enum EPCB_LayerId {
|
|
|
1017
1017
|
TOP_SOLDER_MASK = 5,
|
|
1018
1018
|
/** 顶层锡膏(助焊)层 */
|
|
1019
1019
|
TOP_PASTE_MASK = 7,
|
|
1020
|
-
/**
|
|
1020
|
+
/** 顶层装配层 */
|
|
1021
1021
|
TOP_ASSEMBLY = 9,
|
|
1022
1022
|
/** 顶层 FPC 补强层 */
|
|
1023
1023
|
TOP_STIFFENER = 58,
|
|
@@ -1433,25 +1433,50 @@ declare enum ESCH_PrimitiveComponentType {
|
|
|
1433
1433
|
NET_LABEL = "netlabel"
|
|
1434
1434
|
}
|
|
1435
1435
|
|
|
1436
|
+
/**
|
|
1437
|
+
* 引脚形状
|
|
1438
|
+
*
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
declare enum ESCH_PrimitivePinShape {
|
|
1442
|
+
/** 无 */
|
|
1443
|
+
NONE = "None",
|
|
1444
|
+
/** 反向 */
|
|
1445
|
+
INVERTED = "Inverted",
|
|
1446
|
+
/** 时钟 */
|
|
1447
|
+
CLOCK = "Clock",
|
|
1448
|
+
/** 反向时钟 */
|
|
1449
|
+
INVERTED_CLOCK = "Inverted Clock"
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1436
1452
|
/**
|
|
1437
1453
|
* 引脚类型
|
|
1438
1454
|
*
|
|
1439
1455
|
* @public
|
|
1440
|
-
* @remarks 引脚图元仅符号编辑器可用,在原理图图页内,关联到符号的引脚被称为 {@link ISCH_PrimitiveComponentPin | 器件引脚图元}
|
|
1441
1456
|
*/
|
|
1442
1457
|
declare enum ESCH_PrimitivePinType {
|
|
1458
|
+
/** 输入 */
|
|
1443
1459
|
IN = "IN",
|
|
1460
|
+
/** 输出 */
|
|
1444
1461
|
OUT = "OUT",
|
|
1462
|
+
/** 双向 */
|
|
1445
1463
|
BI = "BI",
|
|
1464
|
+
/** 无源 */
|
|
1465
|
+
PASSIVE = "Passive",
|
|
1466
|
+
/** 开集电极 */
|
|
1446
1467
|
OPEN_COLLECTOR = "Open Collector",
|
|
1447
|
-
|
|
1468
|
+
/** 开发射极 */
|
|
1448
1469
|
OPEN_EMITTER = "Open Emitter",
|
|
1470
|
+
/** 电源 */
|
|
1449
1471
|
POWER = "Power",
|
|
1472
|
+
/** 地 */
|
|
1473
|
+
GROUND = "Ground",
|
|
1474
|
+
/** 高阻 */
|
|
1450
1475
|
HIZ = "HIZ",
|
|
1451
|
-
|
|
1476
|
+
/** 信号终端 */
|
|
1452
1477
|
TERMINATOR = "Terminator",
|
|
1453
|
-
|
|
1454
|
-
|
|
1478
|
+
/** 未定义 */
|
|
1479
|
+
UNDEFINED = "Undefined"
|
|
1455
1480
|
}
|
|
1456
1481
|
|
|
1457
1482
|
/**
|
|
@@ -3077,7 +3102,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
|
|
|
3077
3102
|
*
|
|
3078
3103
|
* @public
|
|
3079
3104
|
* @remarks
|
|
3080
|
-
*
|
|
3105
|
+
* 器件焊���图元是一个特殊的图元,它指的是在 PCB 画布上关联到封装的焊盘
|
|
3081
3106
|
*
|
|
3082
3107
|
* 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
|
|
3083
3108
|
*/
|
|
@@ -3720,7 +3745,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3720
3745
|
*/
|
|
3721
3746
|
getState_StartX(): number;
|
|
3722
3747
|
/**
|
|
3723
|
-
*
|
|
3748
|
+
* 获取属性状态:起始���置 Y
|
|
3724
3749
|
*
|
|
3725
3750
|
* @public
|
|
3726
3751
|
* @returns 起始位置 Y
|
|
@@ -3902,7 +3927,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3902
3927
|
* 获取属性状态:图元 ID
|
|
3903
3928
|
*
|
|
3904
3929
|
* @public
|
|
3905
|
-
* @returns
|
|
3930
|
+
* @returns 图元 ID
|
|
3906
3931
|
*/
|
|
3907
3932
|
getState_PrimitiveId(): string;
|
|
3908
3933
|
/**
|
|
@@ -3911,21 +3936,21 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3911
3936
|
* @public
|
|
3912
3937
|
* @returns 层
|
|
3913
3938
|
*/
|
|
3914
|
-
getState_Layer(): TPCB_LayersOfObject;
|
|
3939
|
+
getState_Layer(): TPCB_LayersOfObject | undefined;
|
|
3915
3940
|
/**
|
|
3916
3941
|
* 获取属性状态:左上点 X
|
|
3917
3942
|
*
|
|
3918
3943
|
* @public
|
|
3919
3944
|
* @returns 左上点 X
|
|
3920
3945
|
*/
|
|
3921
|
-
getState_TopLeftX(): number;
|
|
3946
|
+
getState_TopLeftX(): number | undefined;
|
|
3922
3947
|
/**
|
|
3923
3948
|
* 获取属性状态:左上点 Y
|
|
3924
3949
|
*
|
|
3925
3950
|
* @public
|
|
3926
3951
|
* @returns 左上点 Y
|
|
3927
3952
|
*/
|
|
3928
|
-
getState_TopLeftY(): number;
|
|
3953
|
+
getState_TopLeftY(): number | undefined;
|
|
3929
3954
|
/**
|
|
3930
3955
|
* 获取属性状态:二进制数据
|
|
3931
3956
|
*
|
|
@@ -3939,42 +3964,42 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3939
3964
|
* @public
|
|
3940
3965
|
* @returns 宽
|
|
3941
3966
|
*/
|
|
3942
|
-
getState_Width(): number;
|
|
3967
|
+
getState_Width(): number | undefined;
|
|
3943
3968
|
/**
|
|
3944
3969
|
* 获取属性状态:高
|
|
3945
3970
|
*
|
|
3946
3971
|
* @public
|
|
3947
3972
|
* @returns 高
|
|
3948
3973
|
*/
|
|
3949
|
-
getState_Height(): number;
|
|
3974
|
+
getState_Height(): number | undefined;
|
|
3950
3975
|
/**
|
|
3951
3976
|
* 获取属性状态:旋转角度
|
|
3952
3977
|
*
|
|
3953
3978
|
* @public
|
|
3954
3979
|
* @returns 旋转角度
|
|
3955
3980
|
*/
|
|
3956
|
-
getState_Rotation(): number;
|
|
3981
|
+
getState_Rotation(): number | undefined;
|
|
3957
3982
|
/**
|
|
3958
3983
|
* 获取属性状态:是否水平镜像
|
|
3959
3984
|
*
|
|
3960
3985
|
* @public
|
|
3961
3986
|
* @returns 是否水平镜像
|
|
3962
3987
|
*/
|
|
3963
|
-
getState_Mirror(): boolean;
|
|
3988
|
+
getState_Mirror(): boolean | undefined;
|
|
3964
3989
|
/**
|
|
3965
3990
|
* 获取属性状态:文件名
|
|
3966
3991
|
*
|
|
3967
3992
|
* @public
|
|
3968
3993
|
* @returns 文件名
|
|
3969
3994
|
*/
|
|
3970
|
-
getState_FileName(): string;
|
|
3995
|
+
getState_FileName(): string | undefined;
|
|
3971
3996
|
/**
|
|
3972
3997
|
* 获取属性状态:是否锁定
|
|
3973
3998
|
*
|
|
3974
3999
|
* @public
|
|
3975
4000
|
* @returns 是否锁定
|
|
3976
4001
|
*/
|
|
3977
|
-
getState_PrimitiveLock(): boolean;
|
|
4002
|
+
getState_PrimitiveLock(): boolean | undefined;
|
|
3978
4003
|
/**
|
|
3979
4004
|
* 设置属性状态:层
|
|
3980
4005
|
*
|
|
@@ -3982,7 +4007,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3982
4007
|
* @param layer - 层
|
|
3983
4008
|
* @returns 二进制内嵌对象图元对象
|
|
3984
4009
|
*/
|
|
3985
|
-
setState_Layer(layer: TPCB_LayersOfObject): IPCB_PrimitiveObject;
|
|
4010
|
+
setState_Layer(layer: TPCB_LayersOfObject | undefined): IPCB_PrimitiveObject;
|
|
3986
4011
|
/**
|
|
3987
4012
|
* 设置属性状态:左上点 X
|
|
3988
4013
|
*
|
|
@@ -3990,7 +4015,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3990
4015
|
* @param topLeftX - 左上点 X
|
|
3991
4016
|
* @returns 二进制内嵌对象图元对象
|
|
3992
4017
|
*/
|
|
3993
|
-
setState_TopLeftX(topLeftX: number): IPCB_PrimitiveObject;
|
|
4018
|
+
setState_TopLeftX(topLeftX: number | undefined): IPCB_PrimitiveObject;
|
|
3994
4019
|
/**
|
|
3995
4020
|
* 设置属性状态:左上点 Y
|
|
3996
4021
|
*
|
|
@@ -3998,7 +4023,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
3998
4023
|
* @param topLeftY - 左上点 Y
|
|
3999
4024
|
* @returns 二进制内嵌对象图元对象
|
|
4000
4025
|
*/
|
|
4001
|
-
setState_TopLeftY(topLeftY: number): IPCB_PrimitiveObject;
|
|
4026
|
+
setState_TopLeftY(topLeftY: number | undefined): IPCB_PrimitiveObject;
|
|
4002
4027
|
/**
|
|
4003
4028
|
* 设置属性状态:二进制数据
|
|
4004
4029
|
*
|
|
@@ -4014,7 +4039,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4014
4039
|
* @param width - 宽
|
|
4015
4040
|
* @returns 二进制内嵌对象图元对象
|
|
4016
4041
|
*/
|
|
4017
|
-
setState_Width(width: number): IPCB_PrimitiveObject;
|
|
4042
|
+
setState_Width(width: number | undefined): IPCB_PrimitiveObject;
|
|
4018
4043
|
/**
|
|
4019
4044
|
* 设置属性状态:高
|
|
4020
4045
|
*
|
|
@@ -4022,7 +4047,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4022
4047
|
* @param height - 高
|
|
4023
4048
|
* @returns 二进制内嵌对象图元对象
|
|
4024
4049
|
*/
|
|
4025
|
-
setState_Height(height: number): IPCB_PrimitiveObject;
|
|
4050
|
+
setState_Height(height: number | undefined): IPCB_PrimitiveObject;
|
|
4026
4051
|
/**
|
|
4027
4052
|
* 设置属性状态:旋转角度
|
|
4028
4053
|
*
|
|
@@ -4030,7 +4055,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4030
4055
|
* @param rotation - 旋转角度
|
|
4031
4056
|
* @returns 二进制内嵌对象图元对象
|
|
4032
4057
|
*/
|
|
4033
|
-
setState_Rotation(rotation: number): IPCB_PrimitiveObject;
|
|
4058
|
+
setState_Rotation(rotation: number | undefined): IPCB_PrimitiveObject;
|
|
4034
4059
|
/**
|
|
4035
4060
|
* 设置属性状态:是否水平镜像
|
|
4036
4061
|
*
|
|
@@ -4038,7 +4063,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4038
4063
|
* @param mirror - 是否水平镜像
|
|
4039
4064
|
* @returns 二进制内嵌对象图元对象
|
|
4040
4065
|
*/
|
|
4041
|
-
setState_Mirror(mirror: boolean): IPCB_PrimitiveObject;
|
|
4066
|
+
setState_Mirror(mirror: boolean | undefined): IPCB_PrimitiveObject;
|
|
4042
4067
|
/**
|
|
4043
4068
|
* 设置属性状态:文件名
|
|
4044
4069
|
*
|
|
@@ -4046,7 +4071,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4046
4071
|
* @param fileName - 文件名
|
|
4047
4072
|
* @returns 二进制内嵌对象图元对象
|
|
4048
4073
|
*/
|
|
4049
|
-
setState_FileName(fileName: string): IPCB_PrimitiveObject;
|
|
4074
|
+
setState_FileName(fileName: string | undefined): IPCB_PrimitiveObject;
|
|
4050
4075
|
/**
|
|
4051
4076
|
* 设置属性状态:是否锁定
|
|
4052
4077
|
*
|
|
@@ -4054,7 +4079,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
|
|
|
4054
4079
|
* @param primitiveLock - 是否锁定
|
|
4055
4080
|
* @returns 二进制内嵌对象图元对象
|
|
4056
4081
|
*/
|
|
4057
|
-
setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveObject;
|
|
4082
|
+
setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveObject;
|
|
4058
4083
|
/**
|
|
4059
4084
|
* 将图元转换为异步图元
|
|
4060
4085
|
*
|
|
@@ -4205,7 +4230,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4205
4230
|
*/
|
|
4206
4231
|
getState_Hole(): TPCB_PrimitivePadHole | null;
|
|
4207
4232
|
/**
|
|
4208
|
-
*
|
|
4233
|
+
* 获取属性���态:孔偏移 X
|
|
4209
4234
|
*
|
|
4210
4235
|
* @public
|
|
4211
4236
|
* @returns 孔偏移 X
|
|
@@ -4476,7 +4501,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4476
4501
|
*
|
|
4477
4502
|
* @public
|
|
4478
4503
|
* @remarks
|
|
4479
|
-
* 当连接方式({@link IPCB_PrimitivePadHeatWelding.connectionMethod | connectionMethod})为直连({@link EPCB_PrimitivePadHeatWeldingConnectionMethod.DIRECT_CONNECTED | DIRECT_CONNECTED})、无连接({@link EPCB_PrimitivePadHeatWeldingConnectionMethod.NON_CONNECTED | NON_CONNECTED}
|
|
4504
|
+
* 当连接方式({@link IPCB_PrimitivePadHeatWelding.connectionMethod | connectionMethod})为直连({@link EPCB_PrimitivePadHeatWeldingConnectionMethod.DIRECT_CONNECTED | DIRECT_CONNECTED})、无连接({@link EPCB_PrimitivePadHeatWeldingConnectionMethod.NON_CONNECTED | NON_CONNECTED})时,发散间距、发散线宽、发散角度的设置将被忽略
|
|
4480
4505
|
*/
|
|
4481
4506
|
declare interface IPCB_PrimitivePadHeatWelding {
|
|
4482
4507
|
/** 连接方式 */
|
|
@@ -4624,7 +4649,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4624
4649
|
*/
|
|
4625
4650
|
isAsync(): boolean;
|
|
4626
4651
|
/**
|
|
4627
|
-
*
|
|
4652
|
+
* 将异��图元重置为当前画布状态
|
|
4628
4653
|
*
|
|
4629
4654
|
* @beta
|
|
4630
4655
|
* @returns 折线图元对象
|
|
@@ -4787,7 +4812,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4787
4812
|
* 设置属性状态:是否保留孤岛
|
|
4788
4813
|
*
|
|
4789
4814
|
* @beta
|
|
4790
|
-
* @param preserveSilos -
|
|
4815
|
+
* @param preserveSilos - 是否保���孤岛
|
|
4791
4816
|
* @returns 覆铜边框图元对象
|
|
4792
4817
|
*/
|
|
4793
4818
|
setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;
|
|
@@ -5242,7 +5267,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
5242
5267
|
*/
|
|
5243
5268
|
isAsync(): boolean;
|
|
5244
5269
|
/**
|
|
5245
|
-
*
|
|
5270
|
+
* 将异步图���重置为当前画布状态
|
|
5246
5271
|
*
|
|
5247
5272
|
* @beta
|
|
5248
5273
|
* @returns 过孔图元对象
|
|
@@ -5697,7 +5722,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
|
|
|
5697
5722
|
uuid: string;
|
|
5698
5723
|
} | undefined;
|
|
5699
5724
|
/**
|
|
5700
|
-
*
|
|
5725
|
+
* 获取属性状态:关联库封装
|
|
5701
5726
|
*
|
|
5702
5727
|
* @public
|
|
5703
5728
|
* @returns 关联库封装
|
|
@@ -5980,7 +6005,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
|
|
|
5980
6005
|
protected pinLength: number;
|
|
5981
6006
|
/** 引脚颜色 */
|
|
5982
6007
|
protected pinColor: string | null;
|
|
5983
|
-
/**
|
|
6008
|
+
/** 引脚形状 */
|
|
5984
6009
|
protected pinShape: string;
|
|
5985
6010
|
/** 引脚类型 */
|
|
5986
6011
|
protected pinType: ESCH_PrimitivePinType;
|
|
@@ -6387,7 +6412,7 @@ declare interface ISYS_FileSystemFileList {
|
|
|
6387
6412
|
isDirectory: boolean;
|
|
6388
6413
|
/** 目录子文件 */
|
|
6389
6414
|
subFiles?: Array<ISYS_FileSystemFileList>;
|
|
6390
|
-
/**
|
|
6415
|
+
/** 相对路径,不包含前面的传入路径和文件名(当没有传入路径时,不存在相对路径),且前后均无斜杠 */
|
|
6391
6416
|
relativePath?: string;
|
|
6392
6417
|
/** 完整路径,包含文件名的绝对路径 */
|
|
6393
6418
|
fullPath: string;
|
|
@@ -6507,7 +6532,7 @@ declare class LIB_3DModel {
|
|
|
6507
6532
|
*
|
|
6508
6533
|
* @beta
|
|
6509
6534
|
* @param key - 搜索关键字
|
|
6510
|
-
* @param libraryUuid - 库 UUID
|
|
6535
|
+
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6511
6536
|
* @param classification - 分类,默认为全部
|
|
6512
6537
|
* @param itemsOfPage - 一页搜索结果的数量
|
|
6513
6538
|
* @param page - 页数
|
|
@@ -6601,7 +6626,7 @@ declare class LIB_Cbb {
|
|
|
6601
6626
|
* 在编辑器打开复用模块符号
|
|
6602
6627
|
*
|
|
6603
6628
|
* @beta
|
|
6604
|
-
* @param cbbUuid -
|
|
6629
|
+
* @param cbbUuid - 复用模块 UUID
|
|
6605
6630
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6606
6631
|
* @param splitScreenId - 分屏 ID,不填写则默认在最后输入焦点的分屏内打开,可以使用 {@link DMT_EditorControl} 内的接口获取
|
|
6607
6632
|
* @returns 标签页 ID,对应 {@link IDMT_EditorTabItem.tabId},可使用 {@link DMT_EditorControl.getSplitScreenIdByTabId} 获取到分屏 ID
|
|
@@ -6701,7 +6726,7 @@ declare class LIB_Classification {
|
|
|
6701
6726
|
*/
|
|
6702
6727
|
deleteByUuid(libraryUuid: string, classificationUuid: string): Promise<boolean>;
|
|
6703
6728
|
/**
|
|
6704
|
-
*
|
|
6729
|
+
* 删除指定索引的分类
|
|
6705
6730
|
*
|
|
6706
6731
|
* @beta
|
|
6707
6732
|
* @param classificationIndex - 分类索引
|
|
@@ -6798,7 +6823,7 @@ declare class LIB_Device {
|
|
|
6798
6823
|
*
|
|
6799
6824
|
* @beta
|
|
6800
6825
|
* @param key - 搜索关键字
|
|
6801
|
-
* @param libraryUuid - 库 UUID
|
|
6826
|
+
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6802
6827
|
* @param classification - 分类,默认为全部
|
|
6803
6828
|
* @param symbolType - 符号类型,默认为全部
|
|
6804
6829
|
* @param itemsOfPage - 一页搜索结果的数量
|
|
@@ -7150,7 +7175,7 @@ declare class LIB_Symbol {
|
|
|
7150
7175
|
*/
|
|
7151
7176
|
declare class PCB_Document {
|
|
7152
7177
|
/**
|
|
7153
|
-
*
|
|
7178
|
+
* 从原理图导入��更
|
|
7154
7179
|
*
|
|
7155
7180
|
* @public
|
|
7156
7181
|
* @param uuid - 原理图 UUID,默认为关联在同一个 Board 下的原理图
|
|
@@ -7260,7 +7285,7 @@ declare class PCB_Document {
|
|
|
7260
7285
|
offsetY: number;
|
|
7261
7286
|
}>;
|
|
7262
7287
|
/**
|
|
7263
|
-
*
|
|
7288
|
+
* 设置画布���点相对于数据原点的偏移坐标
|
|
7264
7289
|
*
|
|
7265
7290
|
* @public
|
|
7266
7291
|
* @remarks
|
|
@@ -7273,7 +7298,7 @@ declare class PCB_Document {
|
|
|
7273
7298
|
* 即 `setCanvasOrigin(0, 0)`;
|
|
7274
7299
|
*
|
|
7275
7300
|
* 此处的单位为数据层面单位,在跨度上等同于画布层面的 mil
|
|
7276
|
-
* @param offsetX -
|
|
7301
|
+
* @param offsetX - 画布原点相对于数据原点的 X 坐标偏移
|
|
7277
7302
|
* @param offsetY - 画布原点相对于数据原点的 Y 坐标偏移
|
|
7278
7303
|
* @returns 操作是否成功
|
|
7279
7304
|
*/
|
|
@@ -7355,6 +7380,7 @@ declare class PCB_Drc {
|
|
|
7355
7380
|
* 保存设计规则配置
|
|
7356
7381
|
*
|
|
7357
7382
|
* @beta
|
|
7383
|
+
* @remarks 只有自定义配置可以覆盖保存,系统配置不允许修改和覆盖
|
|
7358
7384
|
* @param ruleConfiguration - 设计规则配置
|
|
7359
7385
|
* @param configurationName - 配置名称
|
|
7360
7386
|
* @param allowOverwrite - 是否允许覆写同名设计规则配置,`false` 则将在遇到同名设计规则配置时返回 `false`,请注意可能的数据丢失风险
|
|
@@ -7476,7 +7502,7 @@ declare class PCB_Drc {
|
|
|
7476
7502
|
*/
|
|
7477
7503
|
deleteNetClass(netClassName: string): Promise<boolean>;
|
|
7478
7504
|
/**
|
|
7479
|
-
*
|
|
7505
|
+
* 修改网络类的��称
|
|
7480
7506
|
*
|
|
7481
7507
|
* @beta
|
|
7482
7508
|
* @param originalNetClassName - 原网络类名称
|
|
@@ -7510,7 +7536,7 @@ declare class PCB_Drc {
|
|
|
7510
7536
|
*/
|
|
7511
7537
|
getAllNetClasses(): Promise<Array<IPCB_NetClassItem>>;
|
|
7512
7538
|
/**
|
|
7513
|
-
*
|
|
7539
|
+
* 创建差分对
|
|
7514
7540
|
*
|
|
7515
7541
|
* @beta
|
|
7516
7542
|
* @param differentialPairName - 差分对名称
|
|
@@ -7663,7 +7689,14 @@ declare class PCB_Drc {
|
|
|
7663
7689
|
* @returns 所有焊盘对组的详细属性
|
|
7664
7690
|
*/
|
|
7665
7691
|
getAllPadPairGroups(): Promise<Array<IPCB_PadPairGroupItem>>;
|
|
7666
|
-
|
|
7692
|
+
/**
|
|
7693
|
+
* 获取焊盘对组最短导线长度
|
|
7694
|
+
*
|
|
7695
|
+
* @beta
|
|
7696
|
+
* @param padPairGroupName - 焊盘对组名称
|
|
7697
|
+
* @returns 所有焊盘对的最短导线长度
|
|
7698
|
+
*/
|
|
7699
|
+
getPadPairGroupMinWireLength(padPairGroupName: string): Promise<Array<IPCB_PadPairMinWireLengthItem>>;
|
|
7667
7700
|
}
|
|
7668
7701
|
|
|
7669
7702
|
/**
|
|
@@ -7712,7 +7745,7 @@ declare class PCB_Layer {
|
|
|
7712
7745
|
*
|
|
7713
7746
|
* @public
|
|
7714
7747
|
* @param layer - 层
|
|
7715
|
-
* @returns
|
|
7748
|
+
* @returns 操作是否成功,不��在指定层将返回 `false`
|
|
7716
7749
|
*/
|
|
7717
7750
|
selectLayer(layer: TPCB_LayersInTheSelectable): Promise<boolean>;
|
|
7718
7751
|
/**
|
|
@@ -8090,7 +8123,7 @@ declare class PCB_MathPolygon {
|
|
|
8090
8123
|
*/
|
|
8091
8124
|
declare class PCB_Net {
|
|
8092
8125
|
/**
|
|
8093
|
-
*
|
|
8126
|
+
* 获取所有���络的网络名称
|
|
8094
8127
|
*
|
|
8095
8128
|
* @beta
|
|
8096
8129
|
* @returns 网络名称数组
|
|
@@ -9069,6 +9102,7 @@ declare class SCH_Drc {
|
|
|
9069
9102
|
* 检查 DRC
|
|
9070
9103
|
*
|
|
9071
9104
|
* @public
|
|
9105
|
+
* @remarks 如若检查结果存在 **错误** 或以上级别,将会始终呼出底部 DRC 窗口,无视 `userInterface` 参数
|
|
9072
9106
|
* @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false`,否则返回 `true`
|
|
9073
9107
|
* @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
|
|
9074
9108
|
* @returns DRC 检查是否无错误
|
|
@@ -9382,7 +9416,7 @@ declare class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI {
|
|
|
9382
9416
|
* @param centerY - 圆心 Y
|
|
9383
9417
|
* @param radius - 半径
|
|
9384
9418
|
* @param color - 颜色,`null` 表示默认
|
|
9385
|
-
* @param fillColor - 填充颜色,`none` 表示无填充,`null`
|
|
9419
|
+
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9386
9420
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9387
9421
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
9388
9422
|
* @returns 圆图元对象
|
|
@@ -9677,6 +9711,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
9677
9711
|
* 原理图 & 符号 / 引脚图元类
|
|
9678
9712
|
*
|
|
9679
9713
|
* @public
|
|
9714
|
+
* @remarks 引脚图元仅符号编辑器可用,在原理图图页内,关联到符号的引脚被称为 {@link ISCH_PrimitiveComponentPin | 器件引脚图元}
|
|
9680
9715
|
*/
|
|
9681
9716
|
declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
|
|
9682
9717
|
/**
|
|
@@ -9690,7 +9725,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
|
|
|
9690
9725
|
* @param rotation - 旋转角度,可选 `0` `90` `180` `270`
|
|
9691
9726
|
* @param pinLength - 引脚长度
|
|
9692
9727
|
* @param pinColor - 引脚颜色,`null` 表示默认
|
|
9693
|
-
* @param
|
|
9728
|
+
* @param pinShape - 引脚形状
|
|
9694
9729
|
* @param pinType - 引脚类型
|
|
9695
9730
|
* @returns 引脚图元对象
|
|
9696
9731
|
*/
|
|
@@ -9715,7 +9750,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
|
|
|
9715
9750
|
* @param rotation - 旋转角度,可选 `0` `90` `180` `270`
|
|
9716
9751
|
* @param pinLength - 引脚长度
|
|
9717
9752
|
* @param pinColor - 引脚颜色,`null` 表示默认
|
|
9718
|
-
* @param
|
|
9753
|
+
* @param pinShape - 引脚形状
|
|
9719
9754
|
* @param pinType - 引脚类型
|
|
9720
9755
|
* @returns 引脚图元对象
|
|
9721
9756
|
*/
|
|
@@ -9733,18 +9768,16 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
|
|
|
9733
9768
|
* 获取所有引脚的图元 ID
|
|
9734
9769
|
*
|
|
9735
9770
|
* @beta
|
|
9736
|
-
* @remarks 当处于符号编辑器时,componentPrimitiveId 应始终为 undefined
|
|
9737
9771
|
* @returns 引脚的图元 ID 数组
|
|
9738
9772
|
*/
|
|
9739
|
-
getAllPrimitiveId(
|
|
9773
|
+
getAllPrimitiveId(): Promise<Array<string>>;
|
|
9740
9774
|
/**
|
|
9741
9775
|
* 获取所有引脚
|
|
9742
9776
|
*
|
|
9743
9777
|
* @beta
|
|
9744
|
-
* @remarks 当处于符号编辑器时,componentPrimitiveId 应始终为 undefined
|
|
9745
9778
|
* @returns 引脚图元对象数组
|
|
9746
9779
|
*/
|
|
9747
|
-
getAll(
|
|
9780
|
+
getAll(): Promise<Array<ISCH_PrimitivePin>>;
|
|
9748
9781
|
}
|
|
9749
9782
|
|
|
9750
9783
|
/**
|
|
@@ -9853,7 +9886,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
|
|
|
9853
9886
|
* @param height - 高
|
|
9854
9887
|
* @param cornerRadius - 圆角半径
|
|
9855
9888
|
* @param rotation - 旋转角度,绕左上点旋转,可选 `0` `90` `180` `270`
|
|
9856
|
-
* @param color - 颜色,`null`
|
|
9889
|
+
* @param color - 颜色,`null` 表示默认
|
|
9857
9890
|
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9858
9891
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9859
9892
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
@@ -10210,7 +10243,7 @@ declare class SYS_Environment {
|
|
|
10210
10243
|
*/
|
|
10211
10244
|
isProPrivateEdition(): boolean;
|
|
10212
10245
|
/**
|
|
10213
|
-
*
|
|
10246
|
+
* 是否���在线模式
|
|
10214
10247
|
*
|
|
10215
10248
|
* @public
|
|
10216
10249
|
* @returns 是否为在线模式
|
|
@@ -10255,7 +10288,7 @@ declare class SYS_FileManager {
|
|
|
10255
10288
|
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
|
|
10256
10289
|
* @param fileName - 文件名
|
|
10257
10290
|
* @param password - 加密密码
|
|
10258
|
-
* @returns 文档文件数据,`undefined`
|
|
10291
|
+
* @returns 文档文件数据,`undefined` 表示当前未打开文档或数据获取失败
|
|
10259
10292
|
*/
|
|
10260
10293
|
getDocumentFile(fileName?: string, password?: string): Promise<File | undefined>;
|
|
10261
10294
|
/**
|
|
@@ -10340,7 +10373,7 @@ declare class SYS_FileSystem {
|
|
|
10340
10373
|
private extensionUuid?;
|
|
10341
10374
|
/* Excluded from this release type: __constructor */
|
|
10342
10375
|
/**
|
|
10343
|
-
*
|
|
10376
|
+
* 打开读入文件窗口
|
|
10344
10377
|
*
|
|
10345
10378
|
* @beta
|
|
10346
10379
|
* @param filenameExtensions - 文件扩展名
|
|
@@ -10413,7 +10446,7 @@ declare class SYS_I18n {
|
|
|
10413
10446
|
*
|
|
10414
10447
|
* @public
|
|
10415
10448
|
* @remarks
|
|
10416
|
-
* 可以使用 `${1}`
|
|
10449
|
+
* 可以使用 `${1}` 格式的占位符表���参数;
|
|
10417
10450
|
*
|
|
10418
10451
|
* 语言优先级:当前显示语言 \> 系统默认语言 \> 数据集中第一个搜索到的包含该文本标签的语言 \> 文本标签(tag)
|
|
10419
10452
|
* @param tag - 文本标签,对应多语言文件键值对中的键
|
|
@@ -10452,7 +10485,7 @@ declare class SYS_I18n {
|
|
|
10452
10485
|
* @public
|
|
10453
10486
|
* @remarks 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
10454
10487
|
* @param language - 语言
|
|
10455
|
-
* @param source -
|
|
10488
|
+
* @param source - 欲导入的多语言数据对象
|
|
10456
10489
|
* @returns 导入是否成功
|
|
10457
10490
|
*/
|
|
10458
10491
|
importMultilingual(language: string, source: ISYS_LanguageKeyValuePairs): boolean;
|
|
@@ -10640,7 +10673,7 @@ declare class SYS_PanelControl {
|
|
|
10640
10673
|
* 打开左侧面板
|
|
10641
10674
|
*
|
|
10642
10675
|
* @public
|
|
10643
|
-
* @param tab -
|
|
10676
|
+
* @param tab - 标签页,如若不指定则不��换标签页
|
|
10644
10677
|
*/
|
|
10645
10678
|
openLeftPanel(tab?: ESYS_LeftPanelTab): void;
|
|
10646
10679
|
/**
|
|
@@ -10704,7 +10737,7 @@ declare class SYS_PanelControl {
|
|
|
10704
10737
|
*/
|
|
10705
10738
|
closeBottomPanel(): void;
|
|
10706
10739
|
/**
|
|
10707
|
-
*
|
|
10740
|
+
* 切换底部面板锁定状态
|
|
10708
10741
|
*
|
|
10709
10742
|
* @public
|
|
10710
10743
|
* @param state - 是否锁定,如若不指定则反置当前状态
|