@jlceda/pro-api-types 0.1.88 → 0.1.90
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 +56 -25
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -413,7 +413,7 @@ declare class DMT_Project {
|
|
|
413
413
|
* @beta
|
|
414
414
|
* @param projectFriendlyName - 工程友好名称
|
|
415
415
|
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生成
|
|
416
|
-
* @param teamUuid - 团队 UUID
|
|
416
|
+
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
417
417
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
418
418
|
* @param description - 工程描述
|
|
419
419
|
* @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则该参数将被忽略
|
|
@@ -1227,6 +1227,20 @@ declare enum EPCB_PcbPlateType {
|
|
|
1227
1227
|
FPC = 2
|
|
1228
1228
|
}
|
|
1229
1229
|
|
|
1230
|
+
/**
|
|
1231
|
+
* PDF 输出方式
|
|
1232
|
+
*
|
|
1233
|
+
* @public
|
|
1234
|
+
*/
|
|
1235
|
+
declare enum EPCB_PdfOutputMethod {
|
|
1236
|
+
/** 单个多页 PDF */
|
|
1237
|
+
MULTI_PAGE_PDF = "A Multi Page PDF",
|
|
1238
|
+
/** 多个单页 PDF(将会输出包含所有分解图层 PDF 文件的压缩包) */
|
|
1239
|
+
MULTIPLE_SINGLE_PAGE_PDF = "Multiple Single Page PDF",
|
|
1240
|
+
/** 单个单页 PDF(将会输出包含每层一个 PDF 文件的压缩包) */
|
|
1241
|
+
SINGLE_PAGE_PDF = "A Single Page PDF"
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1230
1244
|
/**
|
|
1231
1245
|
* 圆弧交互模式
|
|
1232
1246
|
*
|
|
@@ -2105,7 +2119,7 @@ declare interface ILIB_DeviceSearchItem {
|
|
|
2105
2119
|
footprintName?: string;
|
|
2106
2120
|
/** 关联封装 UUID */
|
|
2107
2121
|
footprintUuid?: string;
|
|
2108
|
-
/** 关联 3D
|
|
2122
|
+
/** 关联 3D 模型名称 */
|
|
2109
2123
|
model3DName?: string;
|
|
2110
2124
|
/** 关联 3D 模型 UUID */
|
|
2111
2125
|
model3DUuid?: string;
|
|
@@ -2293,7 +2307,7 @@ declare interface ILIB_SymbolSearchItem {
|
|
|
2293
2307
|
*
|
|
2294
2308
|
* @public
|
|
2295
2309
|
* @remarks
|
|
2296
|
-
*
|
|
2310
|
+
* 复杂多边形可以包含多个单多边形,通过 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule | fill-rule} 将其组合,以实现多边形的布尔运算。
|
|
2297
2311
|
* 目前嘉立创 EDA 专业版固定使用 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule#nonzero | nonzero} 这个 fill-rule。
|
|
2298
2312
|
*/
|
|
2299
2313
|
declare class IPCB_ComplexPolygon {
|
|
@@ -2394,6 +2408,18 @@ declare interface IPCB_PadPairGroupItem {
|
|
|
2394
2408
|
padPairs: Array<[string, string]>;
|
|
2395
2409
|
}
|
|
2396
2410
|
|
|
2411
|
+
/**
|
|
2412
|
+
* 焊盘对最短导线长度属性
|
|
2413
|
+
*
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2416
|
+
declare interface IPCB_PadPairMinWireLengthItem {
|
|
2417
|
+
/** 焊盘对数组 */
|
|
2418
|
+
padPairs: Array<[string, string]>;
|
|
2419
|
+
/** 最短导线长度 */
|
|
2420
|
+
minWireLength: number;
|
|
2421
|
+
}
|
|
2422
|
+
|
|
2397
2423
|
/**
|
|
2398
2424
|
* 单多边形
|
|
2399
2425
|
*
|
|
@@ -2578,7 +2604,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
|
|
|
2578
2604
|
*/
|
|
2579
2605
|
setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveArc;
|
|
2580
2606
|
/**
|
|
2581
|
-
*
|
|
2607
|
+
* ��置属性状态:起始位置 X
|
|
2582
2608
|
*
|
|
2583
2609
|
* @beta
|
|
2584
2610
|
* @param startX - 起始位置 X
|
|
@@ -3209,7 +3235,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
|
|
|
3209
3235
|
* 获取属性状态:图像源数据(复杂多边形)
|
|
3210
3236
|
*
|
|
3211
3237
|
* @public
|
|
3212
|
-
* @returns
|
|
3238
|
+
* @returns ���像源数据(复杂多边形)
|
|
3213
3239
|
*/
|
|
3214
3240
|
getState_ComplexPolygon(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;
|
|
3215
3241
|
/**
|
|
@@ -3378,7 +3404,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3378
3404
|
private startY;
|
|
3379
3405
|
/** 终止位置 X */
|
|
3380
3406
|
private endX;
|
|
3381
|
-
/**
|
|
3407
|
+
/** 终止��置 Y */
|
|
3382
3408
|
private endY;
|
|
3383
3409
|
/** 线宽 */
|
|
3384
3410
|
private lineWidth;
|
|
@@ -3408,7 +3434,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3408
3434
|
*/
|
|
3409
3435
|
getState_Net(): string;
|
|
3410
3436
|
/**
|
|
3411
|
-
*
|
|
3437
|
+
* 获取属性状态:层
|
|
3412
3438
|
*
|
|
3413
3439
|
* @public
|
|
3414
3440
|
* @returns 层
|
|
@@ -3863,7 +3889,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
3863
3889
|
* @beta
|
|
3864
3890
|
* @remarks 如若孔不存在,则属性将不会被修改
|
|
3865
3891
|
* @param metallization - 是否金属化孔壁
|
|
3866
|
-
* @returns
|
|
3892
|
+
* @returns 焊盘图元对象
|
|
3867
3893
|
*/
|
|
3868
3894
|
setState_Metallization(metallization: boolean): IPCB_PrimitivePad;
|
|
3869
3895
|
/**
|
|
@@ -4005,7 +4031,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4005
4031
|
*/
|
|
4006
4032
|
getState_PrimitiveId(): string;
|
|
4007
4033
|
/**
|
|
4008
|
-
*
|
|
4034
|
+
* 获取属性状态:网络名称
|
|
4009
4035
|
*
|
|
4010
4036
|
* @public
|
|
4011
4037
|
* @returns 网络名称
|
|
@@ -4455,7 +4481,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
|
|
|
4455
4481
|
*/
|
|
4456
4482
|
setState_LineWidth(lineWidth: number): IPCB_PrimitiveRegion;
|
|
4457
4483
|
/**
|
|
4458
|
-
*
|
|
4484
|
+
* 设��属性状态:是否锁定
|
|
4459
4485
|
*
|
|
4460
4486
|
* @beta
|
|
4461
4487
|
* @param primitiveLock - 是否锁定
|
|
@@ -4638,7 +4664,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
4638
4664
|
*
|
|
4639
4665
|
* @beta
|
|
4640
4666
|
* @param x - 坐标 X
|
|
4641
|
-
* @returns
|
|
4667
|
+
* @returns 过孔图元对象
|
|
4642
4668
|
*/
|
|
4643
4669
|
setState_X(x: number): IPCB_PrimitiveVia;
|
|
4644
4670
|
/**
|
|
@@ -5671,7 +5697,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
|
|
|
5671
5697
|
private content;
|
|
5672
5698
|
/** 旋转角度 */
|
|
5673
5699
|
private rotation;
|
|
5674
|
-
/**
|
|
5700
|
+
/** 文本颜色 */
|
|
5675
5701
|
private textColor;
|
|
5676
5702
|
/** 字体名称 */
|
|
5677
5703
|
private fontName;
|
|
@@ -6683,7 +6709,7 @@ declare class PCB_Document {
|
|
|
6683
6709
|
* 建议调用本方法并设置偏移量为零,
|
|
6684
6710
|
* 即 `setCanvasOrigin(0, 0)`;
|
|
6685
6711
|
*
|
|
6686
|
-
*
|
|
6712
|
+
* 此处的单位为数据层面单位,在跨度上等��于画布层面的 mil
|
|
6687
6713
|
* @param offsetX - 画布原点相对于数据原点的 X 坐标偏移
|
|
6688
6714
|
* @param offsetY - 画布原点相对于数据原点的 Y 坐标偏移
|
|
6689
6715
|
* @returns 操作是否成功
|
|
@@ -7070,6 +7096,7 @@ declare class PCB_Drc {
|
|
|
7070
7096
|
* @returns 所有焊盘对组的详细属性
|
|
7071
7097
|
*/
|
|
7072
7098
|
getAllPadPairGroups(): Promise<Array<IPCB_PadPairGroupItem>>;
|
|
7099
|
+
/* Excluded from this release type: getPadPairGroupMinWireLength */
|
|
7073
7100
|
}
|
|
7074
7101
|
|
|
7075
7102
|
/**
|
|
@@ -7185,7 +7212,7 @@ declare class PCB_Layer {
|
|
|
7185
7212
|
*
|
|
7186
7213
|
* @beta
|
|
7187
7214
|
* @remarks
|
|
7188
|
-
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC
|
|
7215
|
+
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC 补强层图层。
|
|
7189
7216
|
*
|
|
7190
7217
|
* 请注意:
|
|
7191
7218
|
*
|
|
@@ -7350,6 +7377,8 @@ declare class PCB_ManufactureData {
|
|
|
7350
7377
|
layerId: number;
|
|
7351
7378
|
mirror: boolean;
|
|
7352
7379
|
}>, objects?: Array<string>): Promise<File | undefined>;
|
|
7380
|
+
/* Excluded from this release type: getPdfFile */
|
|
7381
|
+
/* Excluded from this release type: getIpcD356AFile */
|
|
7353
7382
|
/**
|
|
7354
7383
|
* 获取 ODB++ 文件
|
|
7355
7384
|
*
|
|
@@ -7360,7 +7389,7 @@ declare class PCB_ManufactureData {
|
|
|
7360
7389
|
* @param otherData - 其它
|
|
7361
7390
|
* @param layers - 导出层,默认则按照嘉立创生产需求导出
|
|
7362
7391
|
* @param objects - 导出对象,默认则按照嘉立创生产需求导出
|
|
7363
|
-
* @returns ODB++
|
|
7392
|
+
* @returns ODB++ 文件数据
|
|
7364
7393
|
*/
|
|
7365
7394
|
getOpenDatabaseDoublePlusFile(fileName?: string, unit?: ESYS_Unit.INCH, otherData?: {
|
|
7366
7395
|
metallizedDrilledHoles?: boolean;
|
|
@@ -7421,6 +7450,8 @@ declare class PCB_ManufactureData {
|
|
|
7421
7450
|
* @returns 自动布局 JSON 文件数据
|
|
7422
7451
|
*/
|
|
7423
7452
|
getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
|
|
7453
|
+
/* Excluded from this release type: getAltiumDesignerFile */
|
|
7454
|
+
/* Excluded from this release type: getPadsFile */
|
|
7424
7455
|
/**
|
|
7425
7456
|
* 获取 PCB 信息文件
|
|
7426
7457
|
*
|
|
@@ -7581,7 +7612,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
|
|
|
7581
7612
|
* @param arcAngle - 圆弧角度
|
|
7582
7613
|
* @param lineWidth - 线宽
|
|
7583
7614
|
* @param interactiveMode - 交互模式
|
|
7584
|
-
* @param primitiveLock -
|
|
7615
|
+
* @param primitiveLock - 是否锁定
|
|
7585
7616
|
* @returns 圆弧线图元对象
|
|
7586
7617
|
*/
|
|
7587
7618
|
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>;
|
|
@@ -8404,7 +8435,7 @@ declare class SCH_Document {
|
|
|
8404
8435
|
* 保存文档
|
|
8405
8436
|
*
|
|
8406
8437
|
* @public
|
|
8407
|
-
* @returns
|
|
8438
|
+
* @returns 保存操作是否成功,保存失败、上传��败等错误均返回 `false`
|
|
8408
8439
|
*/
|
|
8409
8440
|
save(): Promise<boolean>;
|
|
8410
8441
|
}
|
|
@@ -8509,7 +8540,7 @@ declare class SCH_ManufactureData {
|
|
|
8509
8540
|
*/
|
|
8510
8541
|
placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
|
|
8511
8542
|
/**
|
|
8512
|
-
* SMT
|
|
8543
|
+
* SMT ��件下单
|
|
8513
8544
|
*
|
|
8514
8545
|
* @beta
|
|
8515
8546
|
* @param interactive - 是否启用交互式检查
|
|
@@ -8819,7 +8850,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
8819
8850
|
*
|
|
8820
8851
|
* @beta
|
|
8821
8852
|
* @param component - 关联库器件
|
|
8822
|
-
* @returns
|
|
8853
|
+
* @returns 操作是否成功
|
|
8823
8854
|
*/
|
|
8824
8855
|
setNetFlagComponentUuid_Ground(component: {
|
|
8825
8856
|
libraryUuid: string;
|
|
@@ -8988,7 +9019,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
8988
9019
|
*
|
|
8989
9020
|
* @beta
|
|
8990
9021
|
* @param primitiveIds - 器件的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
8991
|
-
* @returns
|
|
9022
|
+
* @returns 器��图元对象,`undefined` 表示获取失败
|
|
8992
9023
|
*/
|
|
8993
9024
|
get(primitiveIds: string): Promise<ISCH_PrimitiveComponent | undefined>;
|
|
8994
9025
|
/**
|
|
@@ -9082,7 +9113,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
|
|
|
9082
9113
|
* 获取所有引脚的图元 ID
|
|
9083
9114
|
*
|
|
9084
9115
|
* @beta
|
|
9085
|
-
* @remarks
|
|
9116
|
+
* @remarks 当��于符号编辑器时,componentPrimitiveId 应始终为 undefined
|
|
9086
9117
|
* @returns 引脚的图元 ID 数组
|
|
9087
9118
|
*/
|
|
9088
9119
|
getAllPrimitiveId(componentPrimitiveId?: string | ISCH_PrimitiveComponent): Promise<Array<string>>;
|
|
@@ -9107,7 +9138,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
|
|
|
9107
9138
|
*
|
|
9108
9139
|
* @beta
|
|
9109
9140
|
* @param line - 坐标组,连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线
|
|
9110
|
-
* @param color - 颜色,`null`
|
|
9141
|
+
* @param color - 颜色,`null` 表示默认
|
|
9111
9142
|
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9112
9143
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9113
9144
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
@@ -9176,7 +9207,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
|
|
|
9176
9207
|
* @param height - 高
|
|
9177
9208
|
* @param cornerRadius - 圆角半径
|
|
9178
9209
|
* @param rotation - 旋转角度,绕左上点旋转,可选 `0` `90` `180` `270`
|
|
9179
|
-
* @param color - 颜色,`null`
|
|
9210
|
+
* @param color - 颜色,`null` ���示默认
|
|
9180
9211
|
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9181
9212
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9182
9213
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
@@ -9655,7 +9686,7 @@ declare class SYS_FileSystem {
|
|
|
9655
9686
|
private allowExternalInteractions?;
|
|
9656
9687
|
/* Excluded from this release type: __constructor */
|
|
9657
9688
|
/**
|
|
9658
|
-
*
|
|
9689
|
+
* 打开读入文��窗口
|
|
9659
9690
|
*
|
|
9660
9691
|
* @beta
|
|
9661
9692
|
* @param filenameExtensions - 文件扩展名
|
|
@@ -10030,7 +10061,7 @@ declare class SYS_ShortcutKey {
|
|
|
10030
10061
|
* @param shortcutKey - 快捷键,数组中包含多个元素则解析为组合快捷键,将按规则排序后存入缓存
|
|
10031
10062
|
* @param title - 快捷键标题,快捷键的友好名称
|
|
10032
10063
|
* @param callbackFn - 回调函数
|
|
10033
|
-
* @returns
|
|
10064
|
+
* @returns 注册操作���否成功
|
|
10034
10065
|
*/
|
|
10035
10066
|
registerShortcutKey(shortcutKey: TShortcutKeys, title: string, callbackFn: (shortcutKey: TShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;
|
|
10036
10067
|
/**
|