@jlceda/pro-api-types 0.1.85 → 0.1.87
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 +27 -35
- 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 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
|
|
@@ -1187,7 +1187,7 @@ declare enum EPCB_LayerId {
|
|
|
1187
1187
|
SHELL_3D_TOP = 54,
|
|
1188
1188
|
/** 3D 外壳底层 */
|
|
1189
1189
|
SHELL_3D_BOTTOM = 55,
|
|
1190
|
-
/**
|
|
1190
|
+
/** 钻孔图层 */
|
|
1191
1191
|
DRILL_DRAWING = 56
|
|
1192
1192
|
}
|
|
1193
1193
|
|
|
@@ -1749,7 +1749,7 @@ declare interface IDMT_EditorTabItem {
|
|
|
1749
1749
|
title: string;
|
|
1750
1750
|
/** 标签页 ID */
|
|
1751
1751
|
tabId: string;
|
|
1752
|
-
/**
|
|
1752
|
+
/** 标签页是���可拖动 */
|
|
1753
1753
|
draggable: boolean;
|
|
1754
1754
|
/** 标签页是否可关闭 */
|
|
1755
1755
|
isAbleDelete: boolean;
|
|
@@ -2604,7 +2604,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
|
|
|
2604
2604
|
* 设置属性状态:终止位置 Y
|
|
2605
2605
|
*
|
|
2606
2606
|
* @beta
|
|
2607
|
-
* @param endY -
|
|
2607
|
+
* @param endY - 终止���置 Y
|
|
2608
2608
|
* @returns 圆弧线图元对象
|
|
2609
2609
|
*/
|
|
2610
2610
|
setState_EndY(endY: number): IPCB_PrimitiveArc;
|
|
@@ -4776,7 +4776,7 @@ declare class ISCH_PrimitiveArc implements ISCH_Primitive {
|
|
|
4776
4776
|
private readonly primitiveType;
|
|
4777
4777
|
/** 图元 ID */
|
|
4778
4778
|
private primitiveId?;
|
|
4779
|
-
/**
|
|
4779
|
+
/** ��始点 X */
|
|
4780
4780
|
private startX;
|
|
4781
4781
|
/** 起始点 Y */
|
|
4782
4782
|
private startY;
|
|
@@ -6241,7 +6241,9 @@ declare class LIB_Device {
|
|
|
6241
6241
|
* @remarks
|
|
6242
6242
|
* 默认情况下,如果在同一个库内匹配到多个相同 C 编号的器件,将只会返回第一个结果;
|
|
6243
6243
|
*
|
|
6244
|
-
* 如果希望返回多个结果,请将 `allowMultiMatch` 置为 `true
|
|
6244
|
+
* 如果希望返回多个结果,请将 `allowMultiMatch` 置为 `true`;
|
|
6245
|
+
*
|
|
6246
|
+
* 私有化部署环境暂无法使用本接口
|
|
6245
6247
|
* @param lcscIds - 立创 C 编号
|
|
6246
6248
|
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6247
6249
|
* @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个结果
|
|
@@ -6255,7 +6257,9 @@ declare class LIB_Device {
|
|
|
6255
6257
|
* @remarks
|
|
6256
6258
|
* 默认情况下,如果在同一个库内匹配到多个相同 C 编号的器件,将只会返回第一个结果;
|
|
6257
6259
|
*
|
|
6258
|
-
* 如果希望返回多个结果,请将 `allowMultiMatch` 置为 `true
|
|
6260
|
+
* 如果希望返回多个结果,请将 `allowMultiMatch` 置为 `true`;
|
|
6261
|
+
*
|
|
6262
|
+
* 私有化部署环境暂无法使用本接口
|
|
6259
6263
|
* @param lcscIds - 立创 C 编号数组
|
|
6260
6264
|
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
6261
6265
|
* @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个结果
|
|
@@ -7158,7 +7162,7 @@ declare class PCB_Layer {
|
|
|
7158
7162
|
* @param numberOfLayers - 层数
|
|
7159
7163
|
* @returns 操作是否成功
|
|
7160
7164
|
*/
|
|
7161
|
-
setTheNumberOfCopperLayers(numberOfLayers:
|
|
7165
|
+
setTheNumberOfCopperLayers(numberOfLayers: 2 | 4 | 6 | 8 | 10 | 12 | 14 | 16 | 18 | 20 | 22 | 24 | 26 | 28 | 30 | 32): Promise<boolean>;
|
|
7162
7166
|
/**
|
|
7163
7167
|
* 设置层颜色配置
|
|
7164
7168
|
*
|
|
@@ -7553,14 +7557,8 @@ declare class PCB_Net {
|
|
|
7553
7557
|
declare class PCB_Primitive {
|
|
7554
7558
|
/* Excluded from this release type: getPrimitiveTypeByPrimitiveId */
|
|
7555
7559
|
/* Excluded from this release type: getPrimitiveByPrimitiveId */
|
|
7556
|
-
|
|
7557
|
-
|
|
7558
|
-
*
|
|
7559
|
-
* @public
|
|
7560
|
-
* @param ids - 图元 ID 数组
|
|
7561
|
-
* @returns 所有图元的所有属性
|
|
7562
|
-
*/
|
|
7563
|
-
getPrimitivesByPrimitiveId(ids: Array<string>): Promise<Array<IPCB_Primitive>>;
|
|
7560
|
+
/* Excluded from this release type: getPrimitivesByPrimitiveId */
|
|
7561
|
+
/* Excluded from this release type: getPrimitivesBBox */
|
|
7564
7562
|
}
|
|
7565
7563
|
|
|
7566
7564
|
/**
|
|
@@ -7583,7 +7581,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
|
|
|
7583
7581
|
* @param lineWidth - 线宽
|
|
7584
7582
|
* @param interactiveMode - 交互模式
|
|
7585
7583
|
* @param primitiveLock - 是否锁定
|
|
7586
|
-
* @returns
|
|
7584
|
+
* @returns ���弧线图元对象
|
|
7587
7585
|
*/
|
|
7588
7586
|
create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, arcAngle: number, lineWidth?: number, interactiveMode?: EPCB_PrimitiveArcInteractiveMode, primitiveLock?: boolean): Promise<IPCB_PrimitiveArc | undefined>;
|
|
7589
7587
|
/**
|
|
@@ -7994,7 +7992,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
|
|
|
7994
7992
|
* @beta
|
|
7995
7993
|
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
|
|
7996
7994
|
* @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
7997
|
-
* @returns
|
|
7995
|
+
* @returns 导线图元对象,空数组表示获取���败
|
|
7998
7996
|
*/
|
|
7999
7997
|
get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveLine>>;
|
|
8000
7998
|
/**
|
|
@@ -8578,14 +8576,8 @@ declare class SCH_Primitive {
|
|
|
8578
8576
|
* @returns 图元的所有属性
|
|
8579
8577
|
*/
|
|
8580
8578
|
getPrimitiveByPrimitiveId(id: string): Promise<ISCH_Primitive | undefined>;
|
|
8581
|
-
|
|
8582
|
-
|
|
8583
|
-
*
|
|
8584
|
-
* @public
|
|
8585
|
-
* @param ids - 图元 ID 数组
|
|
8586
|
-
* @returns 所有图元的所有属性
|
|
8587
|
-
*/
|
|
8588
|
-
getPrimitivesByPrimitiveId(ids: Array<string>): Promise<Array<ISCH_Primitive>>;
|
|
8579
|
+
/* Excluded from this release type: getPrimitivesByPrimitiveId */
|
|
8580
|
+
/* Excluded from this release type: getPrimitivesBBox */
|
|
8589
8581
|
}
|
|
8590
8582
|
|
|
8591
8583
|
/**
|
|
@@ -9020,7 +9012,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
9020
9012
|
*
|
|
9021
9013
|
* @beta
|
|
9022
9014
|
* @param componentType - 器件类型
|
|
9023
|
-
* @returns
|
|
9015
|
+
* @returns 器件图元对���数组
|
|
9024
9016
|
*/
|
|
9025
9017
|
getAll(componentType?: string, allSchematicPages?: boolean): Promise<Array<ISCH_PrimitiveComponent>>;
|
|
9026
9018
|
/* Excluded from this release type: getAllPinsByPrimitiveId */
|
|
@@ -9113,7 +9105,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
|
|
|
9113
9105
|
* 创建多边形
|
|
9114
9106
|
*
|
|
9115
9107
|
* @beta
|
|
9116
|
-
* @param line -
|
|
9108
|
+
* @param line - 坐标组,连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线
|
|
9117
9109
|
* @param color - 颜色,`null` 表示默认
|
|
9118
9110
|
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9119
9111
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
@@ -9364,7 +9356,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
|
|
|
9364
9356
|
*/
|
|
9365
9357
|
modify(primitiveId: string | ISCH_PrimitiveWire, line?: WireNetGroupCreateOptions['line'], net?: WireNetGroupCreateOptions['net'], color?: WireNetGroupCreateOptions['color'], lineWidth?: WireNetGroupCreateOptions['lineWidth'], lineType?: WireNetGroupCreateOptions['lineType']): ISCH_PrimitiveWire | undefined;
|
|
9366
9358
|
/**
|
|
9367
|
-
*
|
|
9359
|
+
* 获取导���
|
|
9368
9360
|
*
|
|
9369
9361
|
* @beta
|
|
9370
9362
|
* @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
@@ -9476,7 +9468,7 @@ declare class SYS_ClientUrl {
|
|
|
9476
9468
|
* 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
|
|
9477
9469
|
* @param url - 请求地址
|
|
9478
9470
|
* @param method - 请求方法
|
|
9479
|
-
* @param data -
|
|
9471
|
+
* @param data - 请求发送的数据,可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象,如果 method 为 `HEAD` 或 `GET`,本���数将被忽略
|
|
9480
9472
|
* @param options - 请求参数
|
|
9481
9473
|
* @param succeedCallFn - 请求成功后回调的函数
|
|
9482
9474
|
* @returns Fetch 的返回结果
|
|
@@ -9601,7 +9593,7 @@ declare class SYS_FileManager {
|
|
|
9601
9593
|
* 修改文档源码
|
|
9602
9594
|
*
|
|
9603
9595
|
* @beta
|
|
9604
|
-
* @param source -
|
|
9596
|
+
* @param source - 文档源码
|
|
9605
9597
|
* @returns 是否修改成功,如果输入的文档源码格式错误,将返回 `false` 的结果
|
|
9606
9598
|
*/
|
|
9607
9599
|
setDocumentSource(source: string): Promise<boolean>;
|
|
@@ -9683,7 +9675,7 @@ declare class SYS_FileSystem {
|
|
|
9683
9675
|
}
|
|
9684
9676
|
|
|
9685
9677
|
/**
|
|
9686
|
-
*
|
|
9678
|
+
* 系�� / 字体管理类
|
|
9687
9679
|
*
|
|
9688
9680
|
* @public
|
|
9689
9681
|
* @remarks 配置嘉立创 EDA 专业版允许调用的系统字体列表
|
|
@@ -10305,7 +10297,7 @@ declare class SYS_WebSocket {
|
|
|
10305
10297
|
* 可以用来执行前检测 WebSocket 连接是否正常,但需要注意 **不要尝试相同 ID 不同参数的连接**,这会造成混乱:
|
|
10306
10298
|
* 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接,那么其余参数的变更将不会被应用
|
|
10307
10299
|
*
|
|
10308
|
-
*
|
|
10300
|
+
* 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用��始终 `throw Error`
|
|
10309
10301
|
* @param id - 自定义 WebSocket ID
|
|
10310
10302
|
* @param serviceUri - WebSocket 服务地址
|
|
10311
10303
|
* @param receiveMessageCallFn - 接收到消息时的回调函数
|
|
@@ -10632,7 +10624,7 @@ declare type TPCB_PrimitivePadHole = [EPCB_PrimitivePadHoleType, number, number]
|
|
|
10632
10624
|
*
|
|
10633
10625
|
* @public
|
|
10634
10626
|
* @remarks
|
|
10635
|
-
*
|
|
10627
|
+
* 焊盘当前存在以下��种 {@link EPCB_PrimitivePadShapeType | 外形种类}:
|
|
10636
10628
|
*
|
|
10637
10629
|
* ① 圆形
|
|
10638
10630
|
*
|