@jlceda/pro-api-types 0.1.86 → 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 +21 -17
- 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>;
|
|
@@ -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;
|
|
@@ -2292,7 +2292,7 @@ declare interface ILIB_SymbolSearchItem {
|
|
|
2292
2292
|
*
|
|
2293
2293
|
* @public
|
|
2294
2294
|
* @remarks
|
|
2295
|
-
*
|
|
2295
|
+
* 复杂多边形可以包含多个单多边形,通过 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule | fill-rule} 将其组合,以实现多边形的布尔运算。
|
|
2296
2296
|
* 目前嘉立创 EDA 专业版固定使用 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule#nonzero | nonzero} 这个 fill-rule。
|
|
2297
2297
|
*/
|
|
2298
2298
|
declare class IPCB_ComplexPolygon {
|
|
@@ -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 编号匹配多个结果
|
|
@@ -7577,7 +7581,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
|
|
|
7577
7581
|
* @param lineWidth - 线宽
|
|
7578
7582
|
* @param interactiveMode - 交互模式
|
|
7579
7583
|
* @param primitiveLock - 是否锁定
|
|
7580
|
-
* @returns
|
|
7584
|
+
* @returns ���弧线图元对象
|
|
7581
7585
|
*/
|
|
7582
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>;
|
|
7583
7587
|
/**
|
|
@@ -7988,7 +7992,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
|
|
|
7988
7992
|
* @beta
|
|
7989
7993
|
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
|
|
7990
7994
|
* @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
7991
|
-
* @returns
|
|
7995
|
+
* @returns 导线图元对象,空数组表示获取���败
|
|
7992
7996
|
*/
|
|
7993
7997
|
get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveLine>>;
|
|
7994
7998
|
/**
|
|
@@ -9008,7 +9012,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
9008
9012
|
*
|
|
9009
9013
|
* @beta
|
|
9010
9014
|
* @param componentType - 器件类型
|
|
9011
|
-
* @returns
|
|
9015
|
+
* @returns 器件图元对���数组
|
|
9012
9016
|
*/
|
|
9013
9017
|
getAll(componentType?: string, allSchematicPages?: boolean): Promise<Array<ISCH_PrimitiveComponent>>;
|
|
9014
9018
|
/* Excluded from this release type: getAllPinsByPrimitiveId */
|
|
@@ -9352,10 +9356,10 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
|
|
|
9352
9356
|
*/
|
|
9353
9357
|
modify(primitiveId: string | ISCH_PrimitiveWire, line?: WireNetGroupCreateOptions['line'], net?: WireNetGroupCreateOptions['net'], color?: WireNetGroupCreateOptions['color'], lineWidth?: WireNetGroupCreateOptions['lineWidth'], lineType?: WireNetGroupCreateOptions['lineType']): ISCH_PrimitiveWire | undefined;
|
|
9354
9358
|
/**
|
|
9355
|
-
*
|
|
9359
|
+
* 获取导���
|
|
9356
9360
|
*
|
|
9357
9361
|
* @beta
|
|
9358
|
-
* @param primitiveIds - 导线的图元 ID
|
|
9362
|
+
* @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
9359
9363
|
* @returns 导线图元对象
|
|
9360
9364
|
*/
|
|
9361
9365
|
get(primitiveIds: string): ISCH_PrimitiveWire | undefined;
|
|
@@ -9464,7 +9468,7 @@ declare class SYS_ClientUrl {
|
|
|
9464
9468
|
* 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
|
|
9465
9469
|
* @param url - 请求地址
|
|
9466
9470
|
* @param method - 请求方法
|
|
9467
|
-
* @param data - 请求发送的数据,可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象,如果 method 为 `HEAD` 或 `GET
|
|
9471
|
+
* @param data - 请求发送的数据,可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象,如果 method 为 `HEAD` 或 `GET`,本���数将被忽略
|
|
9468
9472
|
* @param options - 请求参数
|
|
9469
9473
|
* @param succeedCallFn - 请求成功后回调的函数
|
|
9470
9474
|
* @returns Fetch 的返回结果
|
|
@@ -9671,7 +9675,7 @@ declare class SYS_FileSystem {
|
|
|
9671
9675
|
}
|
|
9672
9676
|
|
|
9673
9677
|
/**
|
|
9674
|
-
*
|
|
9678
|
+
* 系�� / 字体管理类
|
|
9675
9679
|
*
|
|
9676
9680
|
* @public
|
|
9677
9681
|
* @remarks 配置嘉立创 EDA 专业版允许调用的系统字体列表
|
|
@@ -10293,7 +10297,7 @@ declare class SYS_WebSocket {
|
|
|
10293
10297
|
* 可以用来执行前检测 WebSocket 连接是否正常,但需要注意 **不要尝试相同 ID 不同参数的连接**,这会造成混乱:
|
|
10294
10298
|
* 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接,那么其余参数的变更将不会被应用
|
|
10295
10299
|
*
|
|
10296
|
-
*
|
|
10300
|
+
* 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用��始终 `throw Error`
|
|
10297
10301
|
* @param id - 自定义 WebSocket ID
|
|
10298
10302
|
* @param serviceUri - WebSocket 服务地址
|
|
10299
10303
|
* @param receiveMessageCallFn - 接收到消息时的回调函数
|
|
@@ -10620,7 +10624,7 @@ declare type TPCB_PrimitivePadHole = [EPCB_PrimitivePadHoleType, number, number]
|
|
|
10620
10624
|
*
|
|
10621
10625
|
* @public
|
|
10622
10626
|
* @remarks
|
|
10623
|
-
*
|
|
10627
|
+
* 焊盘当前存在以下��种 {@link EPCB_PrimitivePadShapeType | 外形种类}:
|
|
10624
10628
|
*
|
|
10625
10629
|
* ① 圆形
|
|
10626
10630
|
*
|