@jlceda/pro-api-types 0.1.106 → 0.1.107
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 +72 -27
- 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
|
/**
|
|
@@ -311,7 +311,7 @@ declare class DMT_Panel {
|
|
|
311
311
|
*
|
|
312
312
|
* @public
|
|
313
313
|
* @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
|
|
314
|
-
* @returns
|
|
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,6 +1342,15 @@ declare enum EPCB_PrimitivePadShapeType {
|
|
|
1342
1342
|
POLYLINE_COMPLEX_POLYGON = "POLYGON"
|
|
1343
1343
|
}
|
|
1344
1344
|
|
|
1345
|
+
declare enum EPCB_PrimitivePourFillMethod {
|
|
1346
|
+
/** 填充样式 - 45度网格 */
|
|
1347
|
+
GRID45 = "45grid",
|
|
1348
|
+
/** 填充样式 - 90度网格 */
|
|
1349
|
+
GRID = "90grid",
|
|
1350
|
+
/** 填充样式 - 实心填充 */
|
|
1351
|
+
SOLID = "solid"
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1345
1354
|
/**
|
|
1346
1355
|
* 区域图元区域规则类型
|
|
1347
1356
|
*
|
|
@@ -1764,7 +1773,7 @@ declare interface IDMT_EditorDocumentItem {
|
|
|
1764
1773
|
documentType: EDMT_EditorDocumentType;
|
|
1765
1774
|
/** 文档 UUID */
|
|
1766
1775
|
uuid: string;
|
|
1767
|
-
/**
|
|
1776
|
+
/** 文档所属工��� UUID */
|
|
1768
1777
|
parentProjectUuid: string;
|
|
1769
1778
|
}
|
|
1770
1779
|
|
|
@@ -3377,6 +3386,13 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3377
3386
|
* @returns 图元 ID
|
|
3378
3387
|
*/
|
|
3379
3388
|
getState_PrimitiveId(): string;
|
|
3389
|
+
/**
|
|
3390
|
+
* 获取属性状态:网络名称
|
|
3391
|
+
*
|
|
3392
|
+
* @public
|
|
3393
|
+
* @returns 网络名称
|
|
3394
|
+
*/
|
|
3395
|
+
getState_Net(): string | undefined;
|
|
3380
3396
|
/**
|
|
3381
3397
|
* 获取属性状态:层
|
|
3382
3398
|
*
|
|
@@ -3391,13 +3407,6 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3391
3407
|
* @returns 复杂多边形
|
|
3392
3408
|
*/
|
|
3393
3409
|
getState_ComplexPolygon(): IPCB_Polygon;
|
|
3394
|
-
/**
|
|
3395
|
-
* 获取属性状态:网络名称
|
|
3396
|
-
*
|
|
3397
|
-
* @public
|
|
3398
|
-
* @returns 网络名称
|
|
3399
|
-
*/
|
|
3400
|
-
getState_Net(): string | undefined;
|
|
3401
3410
|
/**
|
|
3402
3411
|
* 获取属性状态:填充模式
|
|
3403
3412
|
*
|
|
@@ -3413,7 +3422,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
|
|
|
3413
3422
|
*/
|
|
3414
3423
|
getState_LineWidth(): number;
|
|
3415
3424
|
/**
|
|
3416
|
-
*
|
|
3425
|
+
* 获取属性状态:是否锁定
|
|
3417
3426
|
*
|
|
3418
3427
|
* @public
|
|
3419
3428
|
* @returns 是否锁定
|
|
@@ -3740,7 +3749,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3740
3749
|
* 获取属性状态:图元类型
|
|
3741
3750
|
*
|
|
3742
3751
|
* @public
|
|
3743
|
-
* @returns
|
|
3752
|
+
* @returns 图元类型
|
|
3744
3753
|
*/
|
|
3745
3754
|
getState_PrimitiveType(): EPCB_PrimitiveType;
|
|
3746
3755
|
/**
|
|
@@ -4639,7 +4648,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4639
4648
|
*/
|
|
4640
4649
|
setState_Polygon(polygon: IPCB_Polygon): IPCB_PrimitivePolyline;
|
|
4641
4650
|
/**
|
|
4642
|
-
*
|
|
4651
|
+
* ���置属性状态:线宽
|
|
4643
4652
|
*
|
|
4644
4653
|
* @beta
|
|
4645
4654
|
* @param lineWidth - 线宽
|
|
@@ -4808,7 +4817,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4808
4817
|
*
|
|
4809
4818
|
* @beta
|
|
4810
4819
|
* @param net - 网络名称
|
|
4811
|
-
* @returns
|
|
4820
|
+
* @returns 覆铜边框图��对象
|
|
4812
4821
|
*/
|
|
4813
4822
|
setState_Net(net: string): IPCB_PrimitivePour;
|
|
4814
4823
|
/**
|
|
@@ -4834,7 +4843,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4834
4843
|
* @param pourFillMethod - 覆铜填充方法
|
|
4835
4844
|
* @returns 覆铜边框图元对象
|
|
4836
4845
|
*/
|
|
4837
|
-
setState_PourFillMethod(pourFillMethod:
|
|
4846
|
+
setState_PourFillMethod(pourFillMethod: EPCB_PrimitivePourFillMethod): IPCB_PrimitivePour;
|
|
4838
4847
|
/**
|
|
4839
4848
|
* 设置属性状态:是否保留孤岛
|
|
4840
4849
|
*
|
|
@@ -6527,7 +6536,7 @@ declare class LIB_3DModel {
|
|
|
6527
6536
|
* @remarks 如希望清除某些属性,则将其的值设置为 `null`
|
|
6528
6537
|
* @param modelUuid - 3D 模型 UUID
|
|
6529
6538
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6530
|
-
* @param modelName - 3D
|
|
6539
|
+
* @param modelName - 3D 模���名称
|
|
6531
6540
|
* @param classification - 分类
|
|
6532
6541
|
* @param description - 描述
|
|
6533
6542
|
* @returns 操作是否成功
|
|
@@ -7090,7 +7099,7 @@ declare class LIB_PanelLibrary {
|
|
|
7090
7099
|
*
|
|
7091
7100
|
* @beta
|
|
7092
7101
|
* @param key - 搜索关键字
|
|
7093
|
-
* @param libraryUuid - 库 UUID
|
|
7102
|
+
* @param libraryUuid - 库 UUID,默认为系统库,可���使用 {@link LIB_LibrariesList} 内的接口获取
|
|
7094
7103
|
* @param classification - 分类,默认为全部
|
|
7095
7104
|
* @param itemsOfPage - 一页搜索结果的数量
|
|
7096
7105
|
* @param page - 页数
|
|
@@ -7855,7 +7864,7 @@ declare class PCB_Layer {
|
|
|
7855
7864
|
* 新增自定义层
|
|
7856
7865
|
*
|
|
7857
7866
|
* @beta
|
|
7858
|
-
* @returns 新增的自定义层的图层 ID,如若为 `undefined`
|
|
7867
|
+
* @returns 新增的自定义层的图层 ID,如若为 `undefined` 则为新增失败,可能��自定义层数量已达到上限
|
|
7859
7868
|
*/
|
|
7860
7869
|
addCustomLayer(): Promise<TPCB_LayersOfCustom | undefined>;
|
|
7861
7870
|
/**
|
|
@@ -9024,7 +9033,13 @@ declare class PCB_SelectControl {
|
|
|
9024
9033
|
* @returns 所有已选中图元的图元 ID
|
|
9025
9034
|
*/
|
|
9026
9035
|
getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
|
|
9027
|
-
|
|
9036
|
+
/**
|
|
9037
|
+
* 查询所有已选中图元的图元对象
|
|
9038
|
+
*
|
|
9039
|
+
* @beta
|
|
9040
|
+
* @returns 所有已选中图元的图元对象
|
|
9041
|
+
*/
|
|
9042
|
+
getAllSelectedPrimitives(): Promise<Array<IPCB_Primitive>>;
|
|
9028
9043
|
/**
|
|
9029
9044
|
* 查询选中图元的所有参数
|
|
9030
9045
|
*
|
|
@@ -9059,7 +9074,16 @@ declare class PCB_SelectControl {
|
|
|
9059
9074
|
* @returns 操作是否成功
|
|
9060
9075
|
*/
|
|
9061
9076
|
clearSelected(): Promise<boolean>;
|
|
9062
|
-
|
|
9077
|
+
/**
|
|
9078
|
+
* 获取当前鼠标在画布上的位置
|
|
9079
|
+
*
|
|
9080
|
+
* @beta
|
|
9081
|
+
* @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
|
|
9082
|
+
*/
|
|
9083
|
+
getCurrentMousePosition(): Promise<{
|
|
9084
|
+
x: number;
|
|
9085
|
+
y: number;
|
|
9086
|
+
} | undefined>;
|
|
9063
9087
|
}
|
|
9064
9088
|
|
|
9065
9089
|
/**
|
|
@@ -9453,7 +9477,7 @@ declare class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI {
|
|
|
9453
9477
|
* @param centerY - 圆心 Y
|
|
9454
9478
|
* @param radius - 半径
|
|
9455
9479
|
* @param color - 颜色,`null` 表示默认
|
|
9456
|
-
* @param fillColor -
|
|
9480
|
+
* @param fillColor - 填充���色,`none` 表示无填充,`null` 表示默认
|
|
9457
9481
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9458
9482
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
9459
9483
|
* @returns 圆图元对象
|
|
@@ -10088,8 +10112,20 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
|
|
|
10088
10112
|
* @remarks 获取或操作选择的元素
|
|
10089
10113
|
*/
|
|
10090
10114
|
declare class SCH_SelectControl {
|
|
10091
|
-
|
|
10092
|
-
|
|
10115
|
+
/**
|
|
10116
|
+
* 查询所有已选中图元的图元 ID
|
|
10117
|
+
*
|
|
10118
|
+
* @beta
|
|
10119
|
+
* @returns 所有已选中图元的图元 ID
|
|
10120
|
+
*/
|
|
10121
|
+
getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
|
|
10122
|
+
/**
|
|
10123
|
+
* 查询所有已选中图元的图元对象
|
|
10124
|
+
*
|
|
10125
|
+
* @beta
|
|
10126
|
+
* @returns 所有已选中图元的图元对象
|
|
10127
|
+
*/
|
|
10128
|
+
getAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;
|
|
10093
10129
|
/**
|
|
10094
10130
|
* 查询选中图元的图元 ID
|
|
10095
10131
|
*
|
|
@@ -10133,7 +10169,16 @@ declare class SCH_SelectControl {
|
|
|
10133
10169
|
* @returns 操作是否成功
|
|
10134
10170
|
*/
|
|
10135
10171
|
clearSelected(): boolean;
|
|
10136
|
-
|
|
10172
|
+
/**
|
|
10173
|
+
* 获取当前鼠标在画布上的位置
|
|
10174
|
+
*
|
|
10175
|
+
* @beta
|
|
10176
|
+
* @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
|
|
10177
|
+
*/
|
|
10178
|
+
getCurrentMousePosition(): Promise<{
|
|
10179
|
+
x: number;
|
|
10180
|
+
y: number;
|
|
10181
|
+
} | undefined>;
|
|
10137
10182
|
}
|
|
10138
10183
|
|
|
10139
10184
|
/**
|
|
@@ -10646,7 +10691,7 @@ declare class SYS_Log {
|
|
|
10646
10691
|
* 查找条目
|
|
10647
10692
|
*
|
|
10648
10693
|
* @public
|
|
10649
|
-
* @remarks
|
|
10694
|
+
* @remarks 如果日志面板处于打开状态,查找操���会同时在前端展现
|
|
10650
10695
|
* @param message - 查找内容
|
|
10651
10696
|
* @param types - 日志类型数组,可以在指定的日志类型内查找
|
|
10652
10697
|
* @returns 符合查找条件的日志条目数组
|
|
@@ -10898,7 +10943,7 @@ declare class SYS_Storage {
|
|
|
10898
10943
|
* 获取扩展用户配置
|
|
10899
10944
|
*
|
|
10900
10945
|
* @public
|
|
10901
|
-
* @remarks
|
|
10946
|
+
* @remarks 注意:本接口仅扩���有效,在独立脚本环境内调用将始终 `throw Error`
|
|
10902
10947
|
* @param key - 配置项
|
|
10903
10948
|
* @returns 配置项对应的值,不存在将返回 `undefined`
|
|
10904
10949
|
*/
|