@jlceda/pro-api-types 0.1.87 → 0.1.88

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 +28 -27
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -413,10 +413,10 @@ declare class DMT_Project {
413
413
  * @beta
414
414
  * @param projectFriendlyName - 工程友好名称
415
415
  * @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生成
416
- * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
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
 
@@ -1410,7 +1410,8 @@ declare enum ESCH_PrimitiveComponentType {
1410
1410
  /** 无电气标识 */
1411
1411
  NON_ELECTRICAL_FLAG = "nonElectrical_symbol",
1412
1412
  /** 短接标识 */
1413
- SHORT_CIRCUIT_FLAG = "short_symbol"
1413
+ SHORT_CIRCUIT_FLAG = "short_symbol",
1414
+ NET_LABEL = "netlabel"
1414
1415
  }
1415
1416
 
1416
1417
  /**
@@ -1749,7 +1750,7 @@ declare interface IDMT_EditorTabItem {
1749
1750
  title: string;
1750
1751
  /** 标签页 ID */
1751
1752
  tabId: string;
1752
- /** 标签页是���可拖动 */
1753
+ /** 标签页是否可拖动 */
1753
1754
  draggable: boolean;
1754
1755
  /** 标签页是否可关闭 */
1755
1756
  isAbleDelete: boolean;
@@ -2104,7 +2105,7 @@ declare interface ILIB_DeviceSearchItem {
2104
2105
  footprintName?: string;
2105
2106
  /** 关联封装 UUID */
2106
2107
  footprintUuid?: string;
2107
- /** 关联 3D 模型名称 */
2108
+ /** 关联 3D 模型名�� */
2108
2109
  model3DName?: string;
2109
2110
  /** 关联 3D 模型 UUID */
2110
2111
  model3DUuid?: string;
@@ -2292,7 +2293,7 @@ declare interface ILIB_SymbolSearchItem {
2292
2293
  *
2293
2294
  * @public
2294
2295
  * @remarks
2295
- * 复杂多边形可以包含多个单多边形,通过 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule | fill-rule} 将其组合,以实现多边形的布尔运算。
2296
+ * ���杂多边形可以包含多个单多边形,通过 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule | fill-rule} 将其组合,以实现多边形的布尔运算。
2296
2297
  * 目前嘉立创 EDA 专业版固定使用 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule#nonzero | nonzero} 这个 fill-rule。
2297
2298
  */
2298
2299
  declare class IPCB_ComplexPolygon {
@@ -2604,7 +2605,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
2604
2605
  * 设置属性状态:终止位置 Y
2605
2606
  *
2606
2607
  * @beta
2607
- * @param endY - 终止���置 Y
2608
+ * @param endY - 终止位置 Y
2608
2609
  * @returns 圆弧线图元对象
2609
2610
  */
2610
2611
  setState_EndY(endY: number): IPCB_PrimitiveArc;
@@ -3407,7 +3408,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
3407
3408
  */
3408
3409
  getState_Net(): string;
3409
3410
  /**
3410
- * 获取属性状态:层
3411
+ * ��取属性状态:层
3411
3412
  *
3412
3413
  * @public
3413
3414
  * @returns 层
@@ -3862,7 +3863,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
3862
3863
  * @beta
3863
3864
  * @remarks 如若孔不存在,则属性将不会被修改
3864
3865
  * @param metallization - 是否金属化孔壁
3865
- * @returns 焊盘图元对象
3866
+ * @returns 焊盘图元���象
3866
3867
  */
3867
3868
  setState_Metallization(metallization: boolean): IPCB_PrimitivePad;
3868
3869
  /**
@@ -4004,7 +4005,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
4004
4005
  */
4005
4006
  getState_PrimitiveId(): string;
4006
4007
  /**
4007
- * 获取属性状态:网络名称
4008
+ * 获取属性状态:网络���称
4008
4009
  *
4009
4010
  * @public
4010
4011
  * @returns 网络名称
@@ -4637,7 +4638,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
4637
4638
  *
4638
4639
  * @beta
4639
4640
  * @param x - 坐标 X
4640
- * @returns 过孔图元对象
4641
+ * @returns ���孔图元对象
4641
4642
  */
4642
4643
  setState_X(x: number): IPCB_PrimitiveVia;
4643
4644
  /**
@@ -4776,7 +4777,7 @@ declare class ISCH_PrimitiveArc implements ISCH_Primitive {
4776
4777
  private readonly primitiveType;
4777
4778
  /** 图元 ID */
4778
4779
  private primitiveId?;
4779
- /** ��始点 X */
4780
+ /** 起始点 X */
4780
4781
  private startX;
4781
4782
  /** 起始点 Y */
4782
4783
  private startY;
@@ -5670,7 +5671,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
5670
5671
  private content;
5671
5672
  /** 旋转角度 */
5672
5673
  private rotation;
5673
- /** 文本颜色 */
5674
+ /** 文本颜��� */
5674
5675
  private textColor;
5675
5676
  /** 字体名称 */
5676
5677
  private fontName;
@@ -7184,7 +7185,7 @@ declare class PCB_Layer {
7184
7185
  *
7185
7186
  * @beta
7186
7187
  * @remarks
7187
- * 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC 补强层图层。
7188
+ * 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC 补��层图层。
7188
7189
  *
7189
7190
  * 请注意:
7190
7191
  *
@@ -7359,7 +7360,7 @@ declare class PCB_ManufactureData {
7359
7360
  * @param otherData - 其它
7360
7361
  * @param layers - 导出层,默认则按照嘉立创生产需求导出
7361
7362
  * @param objects - 导出对象,默认则按照嘉立创生产需求导出
7362
- * @returns ODB++ 文件数据
7363
+ * @returns ODB++ 文件数��
7363
7364
  */
7364
7365
  getOpenDatabaseDoublePlusFile(fileName?: string, unit?: ESYS_Unit.INCH, otherData?: {
7365
7366
  metallizedDrilledHoles?: boolean;
@@ -7580,8 +7581,8 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
7580
7581
  * @param arcAngle - 圆弧角度
7581
7582
  * @param lineWidth - 线宽
7582
7583
  * @param interactiveMode - 交互模式
7583
- * @param primitiveLock - 是否锁定
7584
- * @returns ���弧线图元对象
7584
+ * @param primitiveLock - ���否锁定
7585
+ * @returns 圆弧线图元对象
7585
7586
  */
7586
7587
  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>;
7587
7588
  /**
@@ -7992,7 +7993,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
7992
7993
  * @beta
7993
7994
  * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
7994
7995
  * @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
7995
- * @returns 导线图元对象,空数组表示获取���败
7996
+ * @returns 导线图元对象,空数组表示获取失败
7996
7997
  */
7997
7998
  get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveLine>>;
7998
7999
  /**
@@ -8818,7 +8819,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
8818
8819
  *
8819
8820
  * @beta
8820
8821
  * @param component - 关联库器件
8821
- * @returns 操作是否成功
8822
+ * @returns 操作是否���功
8822
8823
  */
8823
8824
  setNetFlagComponentUuid_Ground(component: {
8824
8825
  libraryUuid: string;
@@ -9012,7 +9013,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
9012
9013
  *
9013
9014
  * @beta
9014
9015
  * @param componentType - 器件类型
9015
- * @returns 器件图元对���数组
9016
+ * @returns 器件图元对象数组
9016
9017
  */
9017
9018
  getAll(componentType?: string, allSchematicPages?: boolean): Promise<Array<ISCH_PrimitiveComponent>>;
9018
9019
  /* Excluded from this release type: getAllPinsByPrimitiveId */
@@ -9106,7 +9107,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
9106
9107
  *
9107
9108
  * @beta
9108
9109
  * @param line - 坐标组,连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线
9109
- * @param color - 颜色,`null` 表示默认
9110
+ * @param color - 颜色,`null` 表示���认
9110
9111
  * @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
9111
9112
  * @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
9112
9113
  * @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
@@ -9356,7 +9357,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
9356
9357
  */
9357
9358
  modify(primitiveId: string | ISCH_PrimitiveWire, line?: WireNetGroupCreateOptions['line'], net?: WireNetGroupCreateOptions['net'], color?: WireNetGroupCreateOptions['color'], lineWidth?: WireNetGroupCreateOptions['lineWidth'], lineType?: WireNetGroupCreateOptions['lineType']): ISCH_PrimitiveWire | undefined;
9358
9359
  /**
9359
- * 获取导���
9360
+ * 获取导线
9360
9361
  *
9361
9362
  * @beta
9362
9363
  * @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
@@ -9468,7 +9469,7 @@ declare class SYS_ClientUrl {
9468
9469
  * 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
9469
9470
  * @param url - 请求地址
9470
9471
  * @param method - 请求方法
9471
- * @param data - 请求发送的数据,可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象,如果 method 为 `HEAD` 或 `GET`,本���数将被忽略
9472
+ * @param data - 请求发送的数据,可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象,如果 method 为 `HEAD` 或 `GET`,本参数将被忽略
9472
9473
  * @param options - 请求参数
9473
9474
  * @param succeedCallFn - 请求成功后回调的函数
9474
9475
  * @returns Fetch 的返回结果
@@ -9675,7 +9676,7 @@ declare class SYS_FileSystem {
9675
9676
  }
9676
9677
 
9677
9678
  /**
9678
- * 系�� / 字体管理类
9679
+ * 系统 / 字体管理类
9679
9680
  *
9680
9681
  * @public
9681
9682
  * @remarks 配置嘉立创 EDA 专业版允许调用的系统字体列表
@@ -10297,7 +10298,7 @@ declare class SYS_WebSocket {
10297
10298
  * 可以用来执行前检测 WebSocket 连接是否正常,但需要注意 **不要尝试相同 ID 不同参数的连接**,这会造成混乱:
10298
10299
  * 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接,那么其余参数的变更将不会被应用
10299
10300
  *
10300
- * 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用��始终 `throw Error`
10301
+ * 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
10301
10302
  * @param id - 自定义 WebSocket ID
10302
10303
  * @param serviceUri - WebSocket 服务地址
10303
10304
  * @param receiveMessageCallFn - 接收到消息时的回调函数
@@ -10624,7 +10625,7 @@ declare type TPCB_PrimitivePadHole = [EPCB_PrimitivePadHoleType, number, number]
10624
10625
  *
10625
10626
  * @public
10626
10627
  * @remarks
10627
- * 焊盘当前存在以下��种 {@link EPCB_PrimitivePadShapeType | 外形种类}:
10628
+ * 焊盘当前存在以下四种 {@link EPCB_PrimitivePadShapeType | 外形种类}:
10628
10629
  *
10629
10630
  * ① 圆形
10630
10631
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.87",
3
+ "version": "0.1.88",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [