@jlceda/pro-api-types 0.2.36 → 0.2.37
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 +25 -33
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -498,7 +498,7 @@ declare global {
|
|
|
498
498
|
* 搜索符号
|
|
499
499
|
*
|
|
500
500
|
* @beta
|
|
501
|
-
* @param key -
|
|
501
|
+
* @param key - ���索关键字
|
|
502
502
|
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
503
503
|
* @param classification - 分类,默认为全部
|
|
504
504
|
* @param symbolType - 符号类型,默认为全部
|
|
@@ -547,8 +547,8 @@ declare global {
|
|
|
547
547
|
page: Array<IDMT_SchematicPageItem>;
|
|
548
548
|
/** 所属工程 UUID */
|
|
549
549
|
parentProjectUuid: string;
|
|
550
|
-
/**
|
|
551
|
-
|
|
550
|
+
/** 所属板子名称 */
|
|
551
|
+
parentBoardName?: string;
|
|
552
552
|
/** 复用模块原理图关联的模块符号 */
|
|
553
553
|
cbbSymbol?: ILIB_SymbolItem;
|
|
554
554
|
}
|
|
@@ -1880,7 +1880,7 @@ declare global {
|
|
|
1880
1880
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
1881
1881
|
* @param targetLibraryUuid - 目标库 UUID
|
|
1882
1882
|
* @param targetClassification - 目标库内的分类
|
|
1883
|
-
* @param newModelName - 新 3D
|
|
1883
|
+
* @param newModelName - 新 3D 模型名称,如若目标库内存在���名 3D 模型将导致复制失败
|
|
1884
1884
|
* @returns 目标库内新 3D 模型的 UUID
|
|
1885
1885
|
*/
|
|
1886
1886
|
copy(modelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newModelName?: string): Promise<string | undefined>;
|
|
@@ -3371,7 +3371,7 @@ declare global {
|
|
|
3371
3371
|
* 保存文档
|
|
3372
3372
|
*
|
|
3373
3373
|
* @public
|
|
3374
|
-
* @returns
|
|
3374
|
+
* @returns 保存操作是否成功,保存失败、上���失败等错误均返回 `false`
|
|
3375
3375
|
*/
|
|
3376
3376
|
save(uuid: string): Promise<boolean>;
|
|
3377
3377
|
/**
|
|
@@ -5546,7 +5546,7 @@ declare global {
|
|
|
5546
5546
|
* 获取 JRouter 专用自动布线文件(JSON)
|
|
5547
5547
|
*
|
|
5548
5548
|
* @beta
|
|
5549
|
-
* @remarks 可以使用 {@link SYS_FileSystem.saveFile}
|
|
5549
|
+
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口���文件导出到本地文件系统
|
|
5550
5550
|
* @param fileName - 文件名
|
|
5551
5551
|
* @returns 自动布线 JSON 文件数据
|
|
5552
5552
|
*/
|
|
@@ -8869,7 +8869,7 @@ declare global {
|
|
|
8869
8869
|
*
|
|
8870
8870
|
* @beta
|
|
8871
8871
|
* @param primitiveId - 图元 ID
|
|
8872
|
-
* @param property -
|
|
8872
|
+
* @param property - 修改参数
|
|
8873
8873
|
* @returns 折线图元对象
|
|
8874
8874
|
*/
|
|
8875
8875
|
modify(primitiveId: string | IPCB_PrimitivePolyline, property: {
|
|
@@ -11636,7 +11636,7 @@ declare global {
|
|
|
11636
11636
|
* 将图元转换为异步图元
|
|
11637
11637
|
*
|
|
11638
11638
|
* @public
|
|
11639
|
-
* @returns
|
|
11639
|
+
* @returns 二进制内嵌��象图元对象
|
|
11640
11640
|
*/
|
|
11641
11641
|
toAsync(): IPCB_PrimitiveObject;
|
|
11642
11642
|
/**
|
|
@@ -14881,7 +14881,7 @@ declare global {
|
|
|
14881
14881
|
* @param addIntoPcb - 是否转到 PCB
|
|
14882
14882
|
* @param designator - 位号
|
|
14883
14883
|
* @param name - 名称,`null` 表示留空
|
|
14884
|
-
* @param uniqueId - 唯一 ID,`null`
|
|
14884
|
+
* @param uniqueId - 唯一 ID,`null` 表示留空
|
|
14885
14885
|
* @param manufacturer - 制造商,`null` 表示留空
|
|
14886
14886
|
* @param manufacturerId - 制造商编号,`null` 表示留空
|
|
14887
14887
|
* @param supplier - 供应商,`null` 表示留空
|
|
@@ -15885,7 +15885,7 @@ declare global {
|
|
|
15885
15885
|
* 获取属性状态:图元 ID
|
|
15886
15886
|
*
|
|
15887
15887
|
* @public
|
|
15888
|
-
* @returns
|
|
15888
|
+
* @returns 图元 ID
|
|
15889
15889
|
*/
|
|
15890
15890
|
getState_PrimitiveId(): string;
|
|
15891
15891
|
/**
|
|
@@ -16307,7 +16307,7 @@ declare global {
|
|
|
16307
16307
|
/**
|
|
16308
16308
|
* 创建二进制内嵌对象
|
|
16309
16309
|
*
|
|
16310
|
-
* @
|
|
16310
|
+
* @beta
|
|
16311
16311
|
* @param startX - 起点坐标 X
|
|
16312
16312
|
* @param startY - 起点坐标 Y
|
|
16313
16313
|
* @param width - 宽
|
|
@@ -16322,7 +16322,7 @@ declare global {
|
|
|
16322
16322
|
/**
|
|
16323
16323
|
* 删除二进制内嵌对象
|
|
16324
16324
|
*
|
|
16325
|
-
* @
|
|
16325
|
+
* @beta
|
|
16326
16326
|
* @param primitiveIds - 二进制内嵌对象的图元 ID 或二进制内嵌对象图元对象
|
|
16327
16327
|
* @returns 删除操作是否成功
|
|
16328
16328
|
*/
|
|
@@ -16330,7 +16330,7 @@ declare global {
|
|
|
16330
16330
|
/**
|
|
16331
16331
|
* 修改二进制内嵌对象
|
|
16332
16332
|
*
|
|
16333
|
-
* @
|
|
16333
|
+
* @beta
|
|
16334
16334
|
* @param primitiveId - 图元 ID
|
|
16335
16335
|
* @param property - 修改参数
|
|
16336
16336
|
* @returns 二进制内嵌对象图元对象,`undefined` 表示修改失败
|
|
@@ -16348,7 +16348,7 @@ declare global {
|
|
|
16348
16348
|
/**
|
|
16349
16349
|
* 获取二进制内嵌对象
|
|
16350
16350
|
*
|
|
16351
|
-
* @
|
|
16351
|
+
* @beta
|
|
16352
16352
|
* @param primitiveIds - 二进制内嵌对象的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
16353
16353
|
* @returns 二进制内嵌对象图元对象,`undefined` 表示获取失败
|
|
16354
16354
|
*/
|
|
@@ -16356,7 +16356,7 @@ declare global {
|
|
|
16356
16356
|
/**
|
|
16357
16357
|
* 获取二进制内嵌对象
|
|
16358
16358
|
*
|
|
16359
|
-
* @
|
|
16359
|
+
* @beta
|
|
16360
16360
|
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
|
|
16361
16361
|
* @param primitiveIds - 二进制内嵌对象的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
16362
16362
|
* @returns 二进制内嵌对象图元对象,空数组表示获取失败
|
|
@@ -16365,14 +16365,14 @@ declare global {
|
|
|
16365
16365
|
/**
|
|
16366
16366
|
* 获取所有二进制内嵌对象的图元 ID
|
|
16367
16367
|
*
|
|
16368
|
-
* @
|
|
16368
|
+
* @beta
|
|
16369
16369
|
* @returns 二进制内嵌对象的图元 ID 数组
|
|
16370
16370
|
*/
|
|
16371
16371
|
getAllPrimitiveId(): Promise<Array<string>>;
|
|
16372
16372
|
/**
|
|
16373
16373
|
* 获取所有二进制内嵌对象
|
|
16374
16374
|
*
|
|
16375
|
-
* @
|
|
16375
|
+
* @beta
|
|
16376
16376
|
* @returns 二进制内嵌对象图元对象数组
|
|
16377
16377
|
*/
|
|
16378
16378
|
getAll(): Promise<Array<ISCH_PrimitiveObject>>;
|
|
@@ -16414,14 +16414,6 @@ declare global {
|
|
|
16414
16414
|
* @returns 二进制内嵌对象图元对象
|
|
16415
16415
|
*/
|
|
16416
16416
|
create(): Promise<ISCH_PrimitiveObject>;
|
|
16417
|
-
/**
|
|
16418
|
-
* 将 File 对象转换为 base64 字符串
|
|
16419
|
-
*
|
|
16420
|
-
* @internal
|
|
16421
|
-
* @param file - File 对象
|
|
16422
|
-
* @returns base64 字符串
|
|
16423
|
-
*/
|
|
16424
|
-
private fileToBase64;
|
|
16425
16417
|
/**
|
|
16426
16418
|
* 获取属性状态:图元类型
|
|
16427
16419
|
*
|
|
@@ -16497,7 +16489,7 @@ declare global {
|
|
|
16497
16489
|
*
|
|
16498
16490
|
* @beta
|
|
16499
16491
|
* @param content - 对象内容
|
|
16500
|
-
* @returns
|
|
16492
|
+
* @returns 二进制内嵌对象图元对象
|
|
16501
16493
|
*/
|
|
16502
16494
|
setState_Content(content: File | string): ISCH_PrimitiveObject;
|
|
16503
16495
|
/**
|
|
@@ -16580,14 +16572,14 @@ declare global {
|
|
|
16580
16572
|
/**
|
|
16581
16573
|
* 将异步图元重置为当前画布状态
|
|
16582
16574
|
*
|
|
16583
|
-
* @
|
|
16575
|
+
* @beta
|
|
16584
16576
|
* @returns 二进制内嵌对象图元对象
|
|
16585
16577
|
*/
|
|
16586
16578
|
reset(): Promise<ISCH_PrimitiveObject>;
|
|
16587
16579
|
/**
|
|
16588
16580
|
* 将对图元的更改应用到画布
|
|
16589
16581
|
*
|
|
16590
|
-
* @
|
|
16582
|
+
* @beta
|
|
16591
16583
|
* @returns 二进制内嵌对象图元对象
|
|
16592
16584
|
*/
|
|
16593
16585
|
done(): Promise<ISCH_PrimitiveObject>;
|
|
@@ -17078,7 +17070,7 @@ declare global {
|
|
|
17078
17070
|
* 设置属性状态:圆角半径
|
|
17079
17071
|
*
|
|
17080
17072
|
* @beta
|
|
17081
|
-
* @param cornerRadius -
|
|
17073
|
+
* @param cornerRadius - 圆角���径
|
|
17082
17074
|
* @returns 矩形图元对象
|
|
17083
17075
|
*/
|
|
17084
17076
|
setState_CornerRadius(cornerRadius: number): ISCH_PrimitiveRectangle;
|
|
@@ -18143,7 +18135,7 @@ declare global {
|
|
|
18143
18135
|
* 弹出确认窗口
|
|
18144
18136
|
*
|
|
18145
18137
|
* @public
|
|
18146
|
-
* @remarks
|
|
18138
|
+
* @remarks 显示一个拥有确认和��消按钮的窗口
|
|
18147
18139
|
* @param content - 消息文本,支持使用 `\n` 换行
|
|
18148
18140
|
* @param title - 弹出窗口标题
|
|
18149
18141
|
* @param mainButtonTitle - 主要按钮标题
|
|
@@ -18565,7 +18557,7 @@ declare global {
|
|
|
18565
18557
|
*/
|
|
18566
18558
|
convertAltiumDesignerLibrariesToEasyEDASingleFile(file: File | Array<File>): Promise<File | undefined>;
|
|
18567
18559
|
/**
|
|
18568
|
-
* 转换 Altium Designer
|
|
18560
|
+
* 转换 Altium Designer 库到多个嘉立创库文件(每个器件一个文件)
|
|
18569
18561
|
*
|
|
18570
18562
|
* @beta
|
|
18571
18563
|
* @param file - Altium Designer 库文件
|
|
@@ -19009,7 +19001,7 @@ declare global {
|
|
|
19009
19001
|
*
|
|
19010
19002
|
* @beta
|
|
19011
19003
|
* @remarks
|
|
19012
|
-
*
|
|
19004
|
+
* 关闭指��� ID 的内联框架窗口
|
|
19013
19005
|
*
|
|
19014
19006
|
* 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
19015
19007
|
* @param id - 内联框架窗口 ID,如若传入 `undefined`,将关闭由本扩展打开的所有内联框架窗口
|
|
@@ -20066,7 +20058,7 @@ declare global {
|
|
|
20066
20058
|
* 关闭 WebSocket 连接
|
|
20067
20059
|
*
|
|
20068
20060
|
* @public
|
|
20069
|
-
* @remarks
|
|
20061
|
+
* @remarks 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
|
|
20070
20062
|
* @param id - 自定义的 WebSocket ID
|
|
20071
20063
|
* @param code - 数字状态码,对应 {@link https://developer.mozilla.org/docs/Web/API/CloseEvent/code | WebSocket.CloseEvent} 内允许的状态码
|
|
20072
20064
|
* @param reason - 一个人类可读的字符串,解释连接关闭的原因
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.
|
|
1
|
+
{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.37", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
|