@jlceda/pro-api-types 0.1.104 → 0.1.105
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 +24 -24
- 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,
|
|
@@ -3102,7 +3102,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
|
|
|
3102
3102
|
*
|
|
3103
3103
|
* @public
|
|
3104
3104
|
* @remarks
|
|
3105
|
-
*
|
|
3105
|
+
* 器件��盘图元是一个特殊的图元,它指的是在 PCB 画布上关联到封装的焊盘
|
|
3106
3106
|
*
|
|
3107
3107
|
* 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
|
|
3108
3108
|
*/
|
|
@@ -3578,7 +3578,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
|
|
|
3578
3578
|
*/
|
|
3579
3579
|
getState_PrimitiveLock(): boolean;
|
|
3580
3580
|
/**
|
|
3581
|
-
*
|
|
3581
|
+
* 设���属性状态:BBox 左上点坐标 X
|
|
3582
3582
|
*
|
|
3583
3583
|
* @beta
|
|
3584
3584
|
* @param x - BBox 左上点坐标 X
|
|
@@ -3745,7 +3745,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3745
3745
|
*/
|
|
3746
3746
|
getState_StartX(): number;
|
|
3747
3747
|
/**
|
|
3748
|
-
*
|
|
3748
|
+
* 获取属性状态:起��位置 Y
|
|
3749
3749
|
*
|
|
3750
3750
|
* @public
|
|
3751
3751
|
* @returns 起始位置 Y
|
|
@@ -4230,7 +4230,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4230
4230
|
*/
|
|
4231
4231
|
getState_Hole(): TPCB_PrimitivePadHole | null;
|
|
4232
4232
|
/**
|
|
4233
|
-
*
|
|
4233
|
+
* 获取属��状态:孔偏移 X
|
|
4234
4234
|
*
|
|
4235
4235
|
* @public
|
|
4236
4236
|
* @returns 孔偏移 X
|
|
@@ -4358,7 +4358,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4358
4358
|
* 设置属性状态:网络
|
|
4359
4359
|
*
|
|
4360
4360
|
* @beta
|
|
4361
|
-
* @remarks 本接口仅在 PCB 编辑器可用,空字符串与 `undefined`
|
|
4361
|
+
* @remarks 本接口仅在 PCB 编辑器可用,空字符串与 `undefined` 均被���为空网络
|
|
4362
4362
|
* @param net - 网络名称
|
|
4363
4363
|
* @returns 焊盘图元对象
|
|
4364
4364
|
*/
|
|
@@ -4488,7 +4488,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4488
4488
|
*/
|
|
4489
4489
|
reset(): Promise<IPCB_PrimitivePad>;
|
|
4490
4490
|
/**
|
|
4491
|
-
*
|
|
4491
|
+
* 将对图元的更改应用到���布
|
|
4492
4492
|
*
|
|
4493
4493
|
* @beta
|
|
4494
4494
|
* @returns 尺寸标注图元对象
|
|
@@ -4649,7 +4649,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4649
4649
|
*/
|
|
4650
4650
|
isAsync(): boolean;
|
|
4651
4651
|
/**
|
|
4652
|
-
*
|
|
4652
|
+
* 将异步图元重置为当前画布状态
|
|
4653
4653
|
*
|
|
4654
4654
|
* @beta
|
|
4655
4655
|
* @returns 折线图元对象
|
|
@@ -4812,7 +4812,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
|
|
|
4812
4812
|
* 设置属性状态:是否保留孤岛
|
|
4813
4813
|
*
|
|
4814
4814
|
* @beta
|
|
4815
|
-
* @param preserveSilos -
|
|
4815
|
+
* @param preserveSilos - 是否��留孤岛
|
|
4816
4816
|
* @returns 覆铜边框图元对象
|
|
4817
4817
|
*/
|
|
4818
4818
|
setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;
|
|
@@ -5104,7 +5104,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
5104
5104
|
*/
|
|
5105
5105
|
getState_PrimitiveType(): EPCB_PrimitiveType;
|
|
5106
5106
|
/**
|
|
5107
|
-
*
|
|
5107
|
+
* 获取属性状态���图元 ID
|
|
5108
5108
|
*
|
|
5109
5109
|
* @public
|
|
5110
5110
|
* @returns 图元 ID
|
|
@@ -5267,7 +5267,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
5267
5267
|
*/
|
|
5268
5268
|
isAsync(): boolean;
|
|
5269
5269
|
/**
|
|
5270
|
-
*
|
|
5270
|
+
* 将异步��元重置为当前画布状态
|
|
5271
5271
|
*
|
|
5272
5272
|
* @beta
|
|
5273
5273
|
* @returns 过孔图元对象
|
|
@@ -6387,7 +6387,7 @@ declare class ISCH_PrimitiveWire implements ISCH_Primitive {
|
|
|
6387
6387
|
*/
|
|
6388
6388
|
isAsync(): boolean;
|
|
6389
6389
|
/**
|
|
6390
|
-
*
|
|
6390
|
+
* 将异步图元重置为当前画布状态
|
|
6391
6391
|
*
|
|
6392
6392
|
* @beta
|
|
6393
6393
|
*/
|
|
@@ -7285,7 +7285,7 @@ declare class PCB_Document {
|
|
|
7285
7285
|
offsetY: number;
|
|
7286
7286
|
}>;
|
|
7287
7287
|
/**
|
|
7288
|
-
*
|
|
7288
|
+
* 设置画��原点相对于数据原点的偏移坐标
|
|
7289
7289
|
*
|
|
7290
7290
|
* @public
|
|
7291
7291
|
* @remarks
|
|
@@ -7745,7 +7745,7 @@ declare class PCB_Layer {
|
|
|
7745
7745
|
*
|
|
7746
7746
|
* @public
|
|
7747
7747
|
* @param layer - 层
|
|
7748
|
-
* @returns
|
|
7748
|
+
* @returns 操作是否成功,不存在指定层将返回 `false`
|
|
7749
7749
|
*/
|
|
7750
7750
|
selectLayer(layer: TPCB_LayersInTheSelectable): Promise<boolean>;
|
|
7751
7751
|
/**
|
|
@@ -8123,7 +8123,7 @@ declare class PCB_MathPolygon {
|
|
|
8123
8123
|
*/
|
|
8124
8124
|
declare class PCB_Net {
|
|
8125
8125
|
/**
|
|
8126
|
-
*
|
|
8126
|
+
* 获取所��网络的网络名称
|
|
8127
8127
|
*
|
|
8128
8128
|
* @beta
|
|
8129
8129
|
* @returns 网络名称数组
|
|
@@ -8345,7 +8345,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
|
|
|
8345
8345
|
* @param primitiveLock - 是否锁定
|
|
8346
8346
|
* @param addIntoBom - 是否加入 BOM
|
|
8347
8347
|
* @param designator - 位号
|
|
8348
|
-
* @param name - 名称,`null`
|
|
8348
|
+
* @param name - 名称,`null` 表示留���
|
|
8349
8349
|
* @param uniqueId - 唯一 ID,`null` 表示留空
|
|
8350
8350
|
* @param manufacturer - 制造商,`null` 表示留空
|
|
8351
8351
|
* @param manufacturerId - 制造商编号,`null` 表示留空
|
|
@@ -8653,7 +8653,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
|
|
|
8653
8653
|
* 获取直线
|
|
8654
8654
|
*
|
|
8655
8655
|
* @beta
|
|
8656
|
-
* @remarks 如若传入多个图元 ID,任意图元 ID
|
|
8656
|
+
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传���的图元 ID 数量的图元对象
|
|
8657
8657
|
* @param primitiveIds - 直线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
8658
8658
|
* @returns 直线图元对象,空数组表示获取失败
|
|
8659
8659
|
*/
|
|
@@ -10243,7 +10243,7 @@ declare class SYS_Environment {
|
|
|
10243
10243
|
*/
|
|
10244
10244
|
isProPrivateEdition(): boolean;
|
|
10245
10245
|
/**
|
|
10246
|
-
*
|
|
10246
|
+
* 是��为在线模式
|
|
10247
10247
|
*
|
|
10248
10248
|
* @public
|
|
10249
10249
|
* @returns 是否为在线模式
|
|
@@ -10446,7 +10446,7 @@ declare class SYS_I18n {
|
|
|
10446
10446
|
*
|
|
10447
10447
|
* @public
|
|
10448
10448
|
* @remarks
|
|
10449
|
-
* 可以使用 `${1}`
|
|
10449
|
+
* 可以使用 `${1}` 格式的占位符��示参数;
|
|
10450
10450
|
*
|
|
10451
10451
|
* 语言优先级:当前显示语言 \> 系统默认语言 \> 数据集中第一个搜索到的包含该文本标签的语言 \> 文本标签(tag)
|
|
10452
10452
|
* @param tag - 文本标签,对应多语言文件键值对中的键
|
|
@@ -10548,7 +10548,7 @@ declare class SYS_IFrame {
|
|
|
10548
10548
|
* 关闭当前扩展打开的所有内联框架窗口;
|
|
10549
10549
|
*
|
|
10550
10550
|
* 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
10551
|
-
* @param id - 内联框架窗口 ID,如若传入 `undefined
|
|
10551
|
+
* @param id - 内联框架窗口 ID,如若传入 `undefined`,将关闭由本扩展打��的所有内联框架窗口
|
|
10552
10552
|
* @returns 操作是否成功
|
|
10553
10553
|
*/
|
|
10554
10554
|
closeIFrame(id?: string): Promise<boolean>;
|
|
@@ -10684,7 +10684,7 @@ declare class SYS_MessageBox {
|
|
|
10684
10684
|
}
|
|
10685
10685
|
|
|
10686
10686
|
/**
|
|
10687
|
-
*
|
|
10687
|
+
* ���统 / 面板控制类
|
|
10688
10688
|
*
|
|
10689
10689
|
* @public
|
|
10690
10690
|
*/
|
|
@@ -10826,7 +10826,7 @@ declare class SYS_Storage {
|
|
|
10826
10826
|
* 获取扩展所有用户配置
|
|
10827
10827
|
*
|
|
10828
10828
|
* @public
|
|
10829
|
-
* @remarks
|
|
10829
|
+
* @remarks 注意:本接��仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
10830
10830
|
* @returns 扩展所有用户配置信息
|
|
10831
10831
|
*/
|
|
10832
10832
|
getExtensionAllUserConfigs(): {
|