@jlceda/pro-api-types 0.1.120 → 0.1.121
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 +19 -33
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -410,7 +410,7 @@ declare class DMT_Project {
|
|
|
410
410
|
*
|
|
411
411
|
* @beta
|
|
412
412
|
* @param projectFriendlyName - 工程友好名称
|
|
413
|
-
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线
|
|
413
|
+
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好���称自动生成
|
|
414
414
|
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
415
415
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
416
416
|
* @param description - 工程描述
|
|
@@ -763,8 +763,7 @@ declare class EDA {
|
|
|
763
763
|
sch_PrimitiveArc: SCH_PrimitiveArc;
|
|
764
764
|
sch_PrimitiveBus: SCH_PrimitiveBus;
|
|
765
765
|
sch_PrimitiveCircle: SCH_PrimitiveCircle;
|
|
766
|
-
sch_PrimitiveComponent: SCH_PrimitiveComponent;
|
|
767
|
-
sch_PrimitiveComponent3: SCH_PrimitiveComponent3;
|
|
766
|
+
sch_PrimitiveComponent: SCH_PrimitiveComponent | SCH_PrimitiveComponent3;
|
|
768
767
|
sch_PrimitivePin: SCH_PrimitivePin;
|
|
769
768
|
sch_PrimitivePolygon: SCH_PrimitivePolygon;
|
|
770
769
|
sch_PrimitiveRectangle: SCH_PrimitiveRectangle;
|
|
@@ -1185,7 +1184,7 @@ declare enum EPCB_LayerId {
|
|
|
1185
1184
|
CUSTOM_30 = 100,
|
|
1186
1185
|
/** 夹层(介电基板)1 */
|
|
1187
1186
|
SUBSTRATE_1 = 101,
|
|
1188
|
-
/**
|
|
1187
|
+
/** 孔层(焊���、过孔的内孔) */
|
|
1189
1188
|
HOLE = 47,
|
|
1190
1189
|
/** 元件外形层 */
|
|
1191
1190
|
COMPONENT_SHAPE = 48,
|
|
@@ -1596,20 +1595,7 @@ declare enum ESCH_PrimitiveType {
|
|
|
1596
1595
|
/** 文本 */
|
|
1597
1596
|
TEXT = "Text",
|
|
1598
1597
|
/** 导线 */
|
|
1599
|
-
WIRE = "Wire"
|
|
1600
|
-
NETFLAG = "Netflag",
|
|
1601
|
-
NETPORT = "Netport",
|
|
1602
|
-
NO_CONNECT = "Noconnect",
|
|
1603
|
-
PART = "Part",
|
|
1604
|
-
SHORT_SYMBOL = "Short_symbol",
|
|
1605
|
-
BLOCK_SYMBOL = "Block_symbol",
|
|
1606
|
-
TABLE = "Table",
|
|
1607
|
-
CELL = "Cell",
|
|
1608
|
-
BUSENTRY = "BusEntry",
|
|
1609
|
-
NONELECTRICAL_SYMBOL = "NonElectrical_symbol",
|
|
1610
|
-
OBJ = "Obj",
|
|
1611
|
-
JUNCTION = "Junction",
|
|
1612
|
-
SHEET = "Sheet"
|
|
1598
|
+
WIRE = "Wire"
|
|
1613
1599
|
}
|
|
1614
1600
|
|
|
1615
1601
|
/**
|
|
@@ -4691,7 +4677,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4691
4677
|
* 设置属性状态:网络
|
|
4692
4678
|
*
|
|
4693
4679
|
* @beta
|
|
4694
|
-
* @remarks
|
|
4680
|
+
* @remarks 本接���仅在 PCB 编辑器可用,空字符串与 `undefined` 均被视为空网络
|
|
4695
4681
|
* @param net - 网络名称
|
|
4696
4682
|
* @returns 焊盘图元对象
|
|
4697
4683
|
*/
|
|
@@ -6083,7 +6069,7 @@ declare class ISCH_PrimitiveBus implements ISCH_Primitive {
|
|
|
6083
6069
|
*/
|
|
6084
6070
|
setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveBus;
|
|
6085
6071
|
/**
|
|
6086
|
-
*
|
|
6072
|
+
* 将图元转换为异步图元
|
|
6087
6073
|
*
|
|
6088
6074
|
* @public
|
|
6089
6075
|
* @returns 总线图元对象
|
|
@@ -8320,7 +8306,7 @@ declare class LIB_Cbb {
|
|
|
8320
8306
|
*
|
|
8321
8307
|
* @beta
|
|
8322
8308
|
* @remarks 如希望清除某些属性,则将其的值设置为 `null`
|
|
8323
|
-
* @param cbbUuid -
|
|
8309
|
+
* @param cbbUuid - 复��模块 UUID
|
|
8324
8310
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
8325
8311
|
* @param cbbName - 复用模块名称
|
|
8326
8312
|
* @param classification - 分类
|
|
@@ -8399,7 +8385,7 @@ declare class LIB_Classification {
|
|
|
8399
8385
|
*/
|
|
8400
8386
|
createPrimary(libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationName: string): Promise<ILIB_ClassificationIndex | undefined>;
|
|
8401
8387
|
/**
|
|
8402
|
-
*
|
|
8388
|
+
* 创建二级分类
|
|
8403
8389
|
*
|
|
8404
8390
|
* @beta
|
|
8405
8391
|
* @param libraryUuid - 库 UUID
|
|
@@ -8684,7 +8670,7 @@ declare class LIB_Footprint {
|
|
|
8684
8670
|
* 更新封装的文档源码
|
|
8685
8671
|
*
|
|
8686
8672
|
* @beta
|
|
8687
|
-
* @param footprintUuid -
|
|
8673
|
+
* @param footprintUuid - 封�� UUID
|
|
8688
8674
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
8689
8675
|
* @param documentSource - 文档源码
|
|
8690
8676
|
* @returns 是否更新成功
|
|
@@ -9399,7 +9385,7 @@ declare class PCB_Drc {
|
|
|
9399
9385
|
*/
|
|
9400
9386
|
modifyDifferentialPairNegativeNet(differentialPairName: string, negativeNet: string): Promise<boolean>;
|
|
9401
9387
|
/**
|
|
9402
|
-
*
|
|
9388
|
+
* 获取所���差分对的详细属性
|
|
9403
9389
|
*
|
|
9404
9390
|
* @beta
|
|
9405
9391
|
* @returns 所有差分对的详细属性
|
|
@@ -9592,7 +9578,7 @@ declare class PCB_Layer {
|
|
|
9592
9578
|
* 将层设置为不可见
|
|
9593
9579
|
*
|
|
9594
9580
|
* @beta
|
|
9595
|
-
* @param layer -
|
|
9581
|
+
* @param layer - 层,如若不指定任何层则默认为所有层
|
|
9596
9582
|
* @param setOtherLayerVisible - 是否将其它层设置为可见
|
|
9597
9583
|
* @returns 操作是否成功
|
|
9598
9584
|
*/
|
|
@@ -10943,7 +10929,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
|
|
|
10943
10929
|
* @beta
|
|
10944
10930
|
* @param layer - 层
|
|
10945
10931
|
* @param net - 网络名称
|
|
10946
|
-
* @param primitiveLock -
|
|
10932
|
+
* @param primitiveLock - 是否���定
|
|
10947
10933
|
* @returns 焊盘图元对象数组
|
|
10948
10934
|
*/
|
|
10949
10935
|
getAll(layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitivePad>>;
|
|
@@ -11566,7 +11552,7 @@ declare class SCH_Primitive {
|
|
|
11566
11552
|
getPrimitiveByPrimitiveId(id: string): Promise<ISCH_Primitive | undefined>;
|
|
11567
11553
|
/* Excluded from this release type: getPrimitivesByPrimitiveId */
|
|
11568
11554
|
/**
|
|
11569
|
-
*
|
|
11555
|
+
* 获取图元的 BBox
|
|
11570
11556
|
*
|
|
11571
11557
|
* @beta
|
|
11572
11558
|
* @param primitiveIds - 图元 ID 数组或图元对象数组
|
|
@@ -11949,7 +11935,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
11949
11935
|
* @param direction - 端口方向
|
|
11950
11936
|
* @param net - 网络名称
|
|
11951
11937
|
* @param x - 坐标 X
|
|
11952
|
-
* @param y -
|
|
11938
|
+
* @param y - 坐标 Y
|
|
11953
11939
|
* @param rotation - 旋转角度
|
|
11954
11940
|
* @param mirror - 是否镜像
|
|
11955
11941
|
* @returns 器件图元对象
|
|
@@ -12323,7 +12309,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
|
|
|
12323
12309
|
* @remarks
|
|
12324
12310
|
* 本接口模拟前端点击放置按钮,指定的器件将绑定到当前鼠标,并在用户后续点击时放置于画布
|
|
12325
12311
|
*
|
|
12326
|
-
*
|
|
12312
|
+
* 本接口的返回时机并不会等待用户的放置操作,一旦器件被绑定到鼠标,本接口将立即返回 `true` 的结果
|
|
12327
12313
|
* @param component - 关联库器件
|
|
12328
12314
|
* @returns 是否找到器件
|
|
12329
12315
|
*/
|
|
@@ -13600,7 +13586,7 @@ declare class SYS_ShortcutKey {
|
|
|
13600
13586
|
* @param callbackFn - 回调函数
|
|
13601
13587
|
* @returns 注册操作是否成功
|
|
13602
13588
|
*/
|
|
13603
|
-
registerShortcutKey(shortcutKey:
|
|
13589
|
+
registerShortcutKey(shortcutKey: TSYS_ShortcutKeys, title: string, callbackFn: (shortcutKey: TSYS_ShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;
|
|
13604
13590
|
/**
|
|
13605
13591
|
* 反注册快捷键
|
|
13606
13592
|
*
|
|
@@ -13608,7 +13594,7 @@ declare class SYS_ShortcutKey {
|
|
|
13608
13594
|
* @param shortcutKey - 快捷键,不区分传入的排列顺序,将自动排序并查询匹配的快捷键
|
|
13609
13595
|
* @returns 反注册操作是否成功
|
|
13610
13596
|
*/
|
|
13611
|
-
unregisterShortcutKey(shortcutKey:
|
|
13597
|
+
unregisterShortcutKey(shortcutKey: TSYS_ShortcutKeys): Promise<boolean>;
|
|
13612
13598
|
/**
|
|
13613
13599
|
* 查询快捷键列表
|
|
13614
13600
|
*
|
|
@@ -13617,7 +13603,7 @@ declare class SYS_ShortcutKey {
|
|
|
13617
13603
|
* @returns 快捷键列表
|
|
13618
13604
|
*/
|
|
13619
13605
|
getShortcutKeys(includeSystem?: boolean): Promise<Array<{
|
|
13620
|
-
shortcutKey:
|
|
13606
|
+
shortcutKey: TSYS_ShortcutKeys;
|
|
13621
13607
|
title: string;
|
|
13622
13608
|
documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType>;
|
|
13623
13609
|
scene: Array<ESYS_ShortcutKeyEffectiveEditorScene>;
|
|
@@ -14263,6 +14249,6 @@ declare type TPCB_PrimitiveSpecialPadShape = Array<[number, number, TPCB_Primiti
|
|
|
14263
14249
|
*
|
|
14264
14250
|
* @public
|
|
14265
14251
|
*/
|
|
14266
|
-
declare type
|
|
14252
|
+
declare type TSYS_ShortcutKeys = Array<'SHIFT' | 'LEFT_SHIFT' | 'RIGHT_SHIFT' | 'FN' | 'ALT' | 'LEFT_ALT' | 'RIGHT_ALT' | 'CONTROL' | 'LEFT_CONTROL' | 'RIGHT_CONTROL' | 'COMMAND' | 'WIN' | 'OPTION' | 'SUPER' | 'TAB' | 'SPACE' | 'UP' | 'DOWN' | 'LEFT' | 'RIGHT' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'F13' | 'F14' | 'F15' | 'F16' | 'F17' | 'F18' | 'F19' | 'F20' | '`' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '0' | '-' | '=' | 'Q' | 'W' | 'E' | 'R' | 'T' | 'Y' | 'U' | 'I' | 'O' | 'P' | '[' | ']' | 'A' | 'S' | 'D' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | ';' | "'" | '\\' | 'Z' | 'X' | 'C' | 'V' | 'B' | 'N' | 'M' | ',' | '.' | '/'>;
|
|
14267
14253
|
|
|
14268
14254
|
|