@jlceda/pro-api-types 0.1.89 → 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.
Files changed (2) hide show
  1. package/index.d.ts +53 -22
  2. 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
 
@@ -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;
@@ -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
- * 设置属性状态:起始位置 X
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
  /**
@@ -3241,7 +3267,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3241
3267
  */
3242
3268
  getState_Rotation(): number;
3243
3269
  /**
3244
- * 获取属��状态:是否水平镜像
3270
+ * 获取属性状态:是否水平镜像
3245
3271
  *
3246
3272
  * @public
3247
3273
  * @returns 是否水平镜像
@@ -3378,7 +3404,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
3378
3404
  private startY;
3379
3405
  /** 终止位置 X */
3380
3406
  private endX;
3381
- /** 终止位置 Y */
3407
+ /** 终止��置 Y */
3382
3408
  private endY;
3383
3409
  /** 线宽 */
3384
3410
  private lineWidth;
@@ -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 - 是否锁定
@@ -6683,7 +6709,7 @@ declare class PCB_Document {
6683
6709
  * 建议调用本方法并设置偏移量为零,
6684
6710
  * 即 `setCanvasOrigin(0, 0)`;
6685
6711
  *
6686
- * 此处的单位为数据层面单位,在跨度上等同于画布层面的 mil
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
  *
@@ -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
  *
@@ -7679,7 +7710,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
7679
7710
  *
7680
7711
  * @beta
7681
7712
  * @param primitiveIds - 器件的图元 ID 或器件图元对象
7682
- * @returns 删��操作是否成功
7713
+ * @returns 删除操作是否成功
7683
7714
  */
7684
7715
  delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;
7685
7716
  /**
@@ -8295,7 +8326,7 @@ declare class PCB_PrimitiveVia implements IPCB_PrimitiveAPI {
8295
8326
  * @beta
8296
8327
  * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
8297
8328
  * @param primitiveIds - 过孔的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8298
- * @returns 过孔图元对象,空数组表示获取失��
8329
+ * @returns 过孔图元对象,空数组表示获取失败
8299
8330
  */
8300
8331
  get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveVia>>;
8301
8332
  /**
@@ -8404,7 +8435,7 @@ declare class SCH_Document {
8404
8435
  * 保存文档
8405
8436
  *
8406
8437
  * @public
8407
- * @returns 保存操作是否成功,保存失败、上传失败等错误均返回 `false`
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 - 是否启用交互式检查
@@ -8988,7 +9019,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
8988
9019
  *
8989
9020
  * @beta
8990
9021
  * @param primitiveIds - 器件的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8991
- * @returns 器件图元对象,`undefined` 表示获取失败
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 当处于符号编辑器时,componentPrimitiveId 应始终为 undefined
9116
+ * @remarks 当��于符号编辑器时,componentPrimitiveId 应始终为 undefined
9086
9117
  * @returns 引脚的图元 ID 数组
9087
9118
  */
9088
9119
  getAllPrimitiveId(componentPrimitiveId?: string | ISCH_PrimitiveComponent): Promise<Array<string>>;
@@ -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
  /**
@@ -10298,7 +10329,7 @@ declare class SYS_WebSocket {
10298
10329
  * 可以用来执行前检测 WebSocket 连接是否正常,但需要注意 **不要尝试相同 ID 不同参数的连接**,这会造成混乱:
10299
10330
  * 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接,那么其余参数的变更将不会被应用
10300
10331
  *
10301
- * 注意:本接口需要使用者启用扩展的外部���互权限,如若未启用将始终 `throw Error`
10332
+ * 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
10302
10333
  * @param id - 自定义 WebSocket ID
10303
10334
  * @param serviceUri - WebSocket 服务地址
10304
10335
  * @param receiveMessageCallFn - 接收到消息时的回调函数
@@ -10377,7 +10408,7 @@ declare class SYS_Window {
10377
10408
  declare type TPCB_LayersInTheSelectable = TPCB_LayersOfInner | TPCB_LayersOfCustom | EPCB_LayerId.TOP | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.TOP_STIFFENER | EPCB_LayerId.BOTTOM | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.BOTTOM_STIFFENER | EPCB_LayerId.BOARD_OUTLINE | EPCB_LayerId.MULTI | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.DRILL_DRAWING | EPCB_LayerId.RATLINE | EPCB_LayerId.COMPONENT_SHAPE | EPCB_LayerId.COMPONENT_MARKING | EPCB_LayerId.PIN_SOLDERING | EPCB_LayerId.PIN_FLOATING | EPCB_LayerId.SHELL_3D_OUTLINE | EPCB_LayerId.SHELL_3D_TOP | EPCB_LayerId.SHELL_3D_BOTTOM;
10378
10409
 
10379
10410
  /**
10380
- * ��件所属层
10411
+ * 器件所属层
10381
10412
  *
10382
10413
  * @public
10383
10414
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.89",
3
+ "version": "0.1.90",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [