@jlceda/pro-api-types 0.1.127 → 0.1.128

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 +45 -17
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
86
86
  *
87
87
  * @beta
88
88
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
89
- * @param libraryType - 库类型,支持符号和封装
89
+ * @param libraryType - ���类型,支持符号和封装
90
90
  * @param uuid - 符号、封装 UUID
91
91
  * @param splitScreenId - 分屏 ID,即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
92
92
  * @returns 标签页 ID,如若为 `undefined`,则打开文档失败
@@ -380,7 +380,7 @@ declare class DMT_Panel {
380
380
  * 获取当前面板的详细属性
381
381
  *
382
382
  * @public
383
- * @remarks 将��获取当前打开且拥有最后输入焦点的面板的详细属性
383
+ * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
384
384
  * @returns 面板的详细属性,如若为 `undefined` 则获取失败
385
385
  */
386
386
  getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
@@ -2893,7 +2893,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
2893
2893
  private net;
2894
2894
  /** 层 */
2895
2895
  private layer;
2896
- /** 起��位置 X */
2896
+ /** 起始位置 X */
2897
2897
  private startX;
2898
2898
  /** 起始位置 Y */
2899
2899
  private startY;
@@ -4786,7 +4786,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4786
4786
  */
4787
4787
  setState_Layer(layer: TPCB_LayersOfPad): IPCB_PrimitivePad;
4788
4788
  /**
4789
- * 设置属性状态:焊盘编号
4789
+ * 设置属性��态:焊盘编号
4790
4790
  *
4791
4791
  * @beta
4792
4792
  * @param padNumber - 焊盘编号
@@ -7021,7 +7021,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
7021
7021
  */
7022
7022
  getState_UniqueId(): string | undefined;
7023
7023
  /**
7024
- * ���取属性状态:制造商
7024
+ * 获取属性状态:制造商
7025
7025
  *
7026
7026
  * @public
7027
7027
  * @returns 制造商
@@ -7628,7 +7628,7 @@ declare class ISCH_PrimitivePolygon implements ISCH_Primitive {
7628
7628
  */
7629
7629
  reset(): Promise<ISCH_PrimitivePolygon>;
7630
7630
  /**
7631
- * 将对图元的更改应用到画布
7631
+ * ��对图元的更改应用到画布
7632
7632
  *
7633
7633
  * @beta
7634
7634
  * @returns 多边形图元对象
@@ -8519,7 +8519,7 @@ declare class LIB_Cbb {
8519
8519
  * @beta
8520
8520
  * @param cbbUuid - 复用模块 UUID
8521
8521
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
8522
- * @param splitScreenId - 分屏 ID,不填写则默认在最后输入焦点的分屏内打开,可��使用 {@link DMT_EditorControl} 内的接口获取
8522
+ * @param splitScreenId - 分屏 ID,不填写则默认在最后输入焦点的分屏内打开,可���使用 {@link DMT_EditorControl} 内的接口获取
8523
8523
  * @returns 标签页 ID,对应 {@link IDMT_EditorTabItem.tabId},可使用 {@link DMT_EditorControl.getSplitScreenIdByTabId} 获取到分屏 ID
8524
8524
  */
8525
8525
  openSymbolInEditor(cbbUuid: string, libraryUuid: string, splitScreenId?: string): Promise<string | undefined>;
@@ -8886,7 +8886,7 @@ declare class LIB_Footprint {
8886
8886
  */
8887
8887
  declare class LIB_LibrariesList {
8888
8888
  /**
8889
- * 获取���统库的 UUID
8889
+ * 获取系统库的 UUID
8890
8890
  *
8891
8891
  * @beta
8892
8892
  * @returns 系统库的 UUID
@@ -9916,10 +9916,38 @@ declare class PCB_ManufactureData {
9916
9916
  * @returns 飞针测试文件数据
9917
9917
  */
9918
9918
  getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;
9919
- /* Excluded from this release type: getBomTemplates */
9920
- /* Excluded from this release type: uploadBomTemplateFile */
9921
- /* Excluded from this release type: getBomTemplateFile */
9922
- /* Excluded from this release type: deleteBomTemplate */
9919
+ /**
9920
+ * 获取 BOM 模板列表
9921
+ *
9922
+ * @beta
9923
+ * @returns BOM 模板列表
9924
+ */
9925
+ getBomTemplates(): Promise<string[]>;
9926
+ /**
9927
+ * 上传 BOM 模板文件
9928
+ *
9929
+ * @beta
9930
+ * @param templateFile - BOM 模板文件
9931
+ * @param template - BOM 模板名称,如若为 `undefined` 则自动从 `templateFile` 中取值
9932
+ * @returns BOM 模板名称
9933
+ */
9934
+ uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;
9935
+ /**
9936
+ * 获取 BOM 模板文件
9937
+ *
9938
+ * @beta
9939
+ * @param template - BOM 模板名称
9940
+ * @returns BOM 模板文件
9941
+ */
9942
+ getBomTemplateFile(template: string): Promise<File | undefined>;
9943
+ /**
9944
+ * 删除 BOM 模板
9945
+ *
9946
+ * @beta
9947
+ * @param template - BOM 模板名称
9948
+ * @returns 操作是否成功
9949
+ */
9950
+ deleteBomTemplate(template: string): Promise<boolean>;
9923
9951
  /**
9924
9952
  * 获取 BOM 文件
9925
9953
  *
@@ -10234,7 +10262,7 @@ declare class PCB_MathPolygon {
10234
10262
  * @param imageHeight - 图像高度
10235
10263
  * @param tolerance - 容差,取值范围 `0`-`1`
10236
10264
  * @param simplification - 简化,取值范围 `0`-`1`
10237
- * @param smoothing - 平���,取值范围 `0`-`1.33`
10265
+ * @param smoothing - 平滑,取值范围 `0`-`1.33`
10238
10266
  * @param despeckling - 去斑,取值范围 `0`-`5`
10239
10267
  * @param inversion - 是否反相
10240
10268
  * @returns 复杂多边形对象
@@ -11869,7 +11897,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
11869
11897
  * 获取所有总线的图元 ID
11870
11898
  *
11871
11899
  * @beta
11872
- * @returns 总���的图元 ID 数组
11900
+ * @returns 总线的图元 ID 数组
11873
11901
  */
11874
11902
  getAllPrimitiveId(): Promise<Array<string>>;
11875
11903
  /**
@@ -12616,7 +12644,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
12616
12644
  *
12617
12645
  * @beta
12618
12646
  * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
12619
- * @param primitiveIds - 多边形的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
12647
+ * @param primitiveIds - 多边形的图元 ID,可以为字符串或字符串数组,如若为���组,则返回的也是数组
12620
12648
  * @returns 多边形图元对象,空数组表示获取失败
12621
12649
  */
12622
12650
  get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitivePolygon>>;
@@ -13432,7 +13460,7 @@ declare class SYS_IFrame {
13432
13460
  * 内联框架需要展示 {@link htmlFileName} 的内容,该 HTML 从扩展包内获取,并已在安装时被存储至 IndexedDB 中
13433
13461
  *
13434
13462
  * 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
13435
- * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的��径
13463
+ * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
13436
13464
  * @param width - 内联框架窗口的宽度
13437
13465
  * @param height - 内联框架窗口的高度
13438
13466
  * @param id - 内联框架窗口 ID,用于关闭内联框架窗口
@@ -13916,7 +13944,7 @@ declare class SYS_ToastMessage {
13916
13944
  * @param messageType - 消息类型
13917
13945
  * @param timer - 自动关闭倒计时秒数,`0` 为不自动关闭
13918
13946
  * @param bottomPanel - 展开底部信息面板
13919
- * @param buttonTitle - 回调按钮标题
13947
+ * @param buttonTitle - ��调按钮标题
13920
13948
  * @param buttonCallbackFn - 回调函数内容,字符串形式,会被自动解析并执行
13921
13949
  */
13922
13950
  showMessage(message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.127",
3
+ "version": "0.1.128",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [