@jlceda/pro-api-types 0.2.40 → 0.2.41
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 +20 -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 - 符号类型,默认为全部
|
|
@@ -1181,18 +1181,6 @@ declare global {
|
|
|
1181
1181
|
*
|
|
1182
1182
|
* @public
|
|
1183
1183
|
*/
|
|
1184
|
-
enum EDMT_EditorTabEventTriggerCause {
|
|
1185
|
-
/** 切换标签页 */
|
|
1186
|
-
TOGGLE_TAB = "Toggle Tab",
|
|
1187
|
-
/** 关闭标签页 */
|
|
1188
|
-
CLOSE_TAB = "Close Tab",
|
|
1189
|
-
/** 打开文档 */
|
|
1190
|
-
OPEN_DOCUMENT = "Open Document",
|
|
1191
|
-
/** 打开工程 */
|
|
1192
|
-
OPEN_PROJECT = "Open Project",
|
|
1193
|
-
/** 关闭工程 */
|
|
1194
|
-
CLOSE_PROJECT = "Close Project"
|
|
1195
|
-
}
|
|
1196
1184
|
/**
|
|
1197
1185
|
* 文档树 / 事件类
|
|
1198
1186
|
*
|
|
@@ -1221,7 +1209,6 @@ declare global {
|
|
|
1221
1209
|
* @param onlyOnce - 是否仅监听一次
|
|
1222
1210
|
*/
|
|
1223
1211
|
addEditorTabEventListener(id: string, eventType: 'all' | EDMT_EditorTabEventType, callFn: (eventType: EDMT_EditorTabEventType, props: {
|
|
1224
|
-
triggerCause: EDMT_EditorTabEventTriggerCause;
|
|
1225
1212
|
documentType: EDMT_EditorDocumentType;
|
|
1226
1213
|
title: string;
|
|
1227
1214
|
tabId: string;
|
|
@@ -5265,7 +5252,7 @@ declare global {
|
|
|
5265
5252
|
* @remarks
|
|
5266
5253
|
* 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
|
|
5267
5254
|
*
|
|
5268
|
-
* 注意:本接口需要启用 **团队库 \>
|
|
5255
|
+
* 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
|
|
5269
5256
|
*
|
|
5270
5257
|
* @param deviceUuid - 器件 UUID 或器件 UUID 列表
|
|
5271
5258
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取,如若不传入,则为系统库
|
|
@@ -5281,7 +5268,7 @@ declare global {
|
|
|
5281
5268
|
*
|
|
5282
5269
|
* 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
|
|
5283
5270
|
* @param symbolUuid - 符号 UUID 或符号 UUID 列表
|
|
5284
|
-
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList}
|
|
5271
|
+
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取,如若不传入,则为系统库
|
|
5285
5272
|
* @returns 符号文件数据,`undefined` 表示数据获取失败
|
|
5286
5273
|
*/
|
|
5287
5274
|
getSymbolFileBySymbolUuid(symbolUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
|
|
@@ -5294,7 +5281,7 @@ declare global {
|
|
|
5294
5281
|
*
|
|
5295
5282
|
* 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
|
|
5296
5283
|
* @param footprintUuid - 封装 UUID 或封装 UUID 列表
|
|
5297
|
-
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList}
|
|
5284
|
+
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取,如若不传入,则为系统库
|
|
5298
5285
|
* @returns 封装文件数据,`undefined` 表示数据获取失败
|
|
5299
5286
|
*/
|
|
5300
5287
|
getFootprintFileByFootprintUuid(footprintUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
|
|
@@ -5307,7 +5294,7 @@ declare global {
|
|
|
5307
5294
|
*
|
|
5308
5295
|
* 注意:本接口需要启用 **团队模块 \> 下载模块** 权限,没有权限调用将始终 `throw Error`
|
|
5309
5296
|
* @param cbbUuid - 复用模块 UUID
|
|
5310
|
-
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList}
|
|
5297
|
+
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取,如若不传入,则为系统库
|
|
5311
5298
|
* @param fileName - 复用模块名
|
|
5312
5299
|
* @param password - 加密密码
|
|
5313
5300
|
* @returns 复用模块文件数据,`undefined` 表示数据获取失败
|
|
@@ -5328,7 +5315,7 @@ declare global {
|
|
|
5328
5315
|
*
|
|
5329
5316
|
* 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
|
|
5330
5317
|
* @param panelLibraryUuid - 面板库 UUID 或面板库 UUID 列表
|
|
5331
|
-
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList}
|
|
5318
|
+
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取,如若不传入,则为系统库
|
|
5332
5319
|
* @returns 面板库文件数据,`undefined` 表示数据获取失败
|
|
5333
5320
|
*/
|
|
5334
5321
|
getPanelLibraryFileByPanelLibraryUuid(panelLibraryUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
|
|
@@ -7682,7 +7669,7 @@ declare global {
|
|
|
7682
7669
|
*/
|
|
7683
7670
|
setState_Reverse(reverse: boolean): IPCB_PrimitiveString;
|
|
7684
7671
|
/**
|
|
7685
|
-
*
|
|
7672
|
+
* ��置属性状态:反相扩展
|
|
7686
7673
|
*
|
|
7687
7674
|
* @beta
|
|
7688
7675
|
* @param expansion - 反相扩展
|
|
@@ -8280,7 +8267,7 @@ declare global {
|
|
|
8280
8267
|
* 在 PCB 画布中创建图元
|
|
8281
8268
|
*
|
|
8282
8269
|
* @internal
|
|
8283
|
-
* @remarks
|
|
8270
|
+
* @remarks 覆铜填充图元不支持新建,本接口调用将不会有任何效果
|
|
8284
8271
|
* @returns 覆铜填充图元对象
|
|
8285
8272
|
*/
|
|
8286
8273
|
create(): IPCB_PrimitivePoured;
|
|
@@ -9399,7 +9386,7 @@ declare global {
|
|
|
9399
9386
|
private async;
|
|
9400
9387
|
/** 图元类型 */
|
|
9401
9388
|
private readonly primitiveType;
|
|
9402
|
-
/**
|
|
9389
|
+
/** 图元 ID */
|
|
9403
9390
|
private primitiveId?;
|
|
9404
9391
|
/** 层 */
|
|
9405
9392
|
private layer;
|
|
@@ -11014,7 +11001,7 @@ declare global {
|
|
|
11014
11001
|
* 获取所有尺寸标注的图元 ID
|
|
11015
11002
|
*
|
|
11016
11003
|
* @beta
|
|
11017
|
-
* @param layer -
|
|
11004
|
+
* @param layer - ���
|
|
11018
11005
|
* @param primitiveLock - 是否锁定
|
|
11019
11006
|
* @returns 尺寸标注的图元 ID 数组
|
|
11020
11007
|
*/
|
|
@@ -13097,7 +13084,7 @@ declare global {
|
|
|
13097
13084
|
* @param bold - 是否加粗
|
|
13098
13085
|
* @param italic - 是否斜体
|
|
13099
13086
|
* @param underLine - 是否加下划线
|
|
13100
|
-
* @param alignMode -
|
|
13087
|
+
* @param alignMode - 对齐模式
|
|
13101
13088
|
* @returns 文本图元对象
|
|
13102
13089
|
*/
|
|
13103
13090
|
create(x: number, y: number, content: string, rotation?: number, textColor?: string | null, fontName?: string | null, fontSize?: number | null, bold?: boolean, italic?: boolean, underLine?: boolean, alignMode?: ESCH_PrimitiveTextAlignMode): Promise<ISCH_PrimitiveText | undefined>;
|
|
@@ -14346,7 +14333,7 @@ declare global {
|
|
|
14346
14333
|
*/
|
|
14347
14334
|
toSync(): ISCH_PrimitiveCircle;
|
|
14348
14335
|
/**
|
|
14349
|
-
*
|
|
14336
|
+
* 查询图元是否为异步图元
|
|
14350
14337
|
*
|
|
14351
14338
|
* @public
|
|
14352
14339
|
* @returns 是否为异步图元
|
|
@@ -15884,9 +15871,9 @@ declare global {
|
|
|
15884
15871
|
* 获取器件
|
|
15885
15872
|
*
|
|
15886
15873
|
* @beta
|
|
15887
|
-
* @remarks 如若传入多个图元 ID,任意图元 ID
|
|
15874
|
+
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
|
|
15888
15875
|
* @param primitiveIds - 器件的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
15889
|
-
* @returns
|
|
15876
|
+
* @returns 器件图元对象���空数组表示获取失败
|
|
15890
15877
|
*/
|
|
15891
15878
|
get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveComponent>>;
|
|
15892
15879
|
/**
|
|
@@ -17031,7 +17018,7 @@ declare global {
|
|
|
17031
17018
|
* @param cornerRadius - 圆角半径
|
|
17032
17019
|
* @param rotation - 旋转角度,绕左上点旋转,可选 `0` `90` `180` `270`
|
|
17033
17020
|
* @param color - 颜色,`null` 表示默认
|
|
17034
|
-
* @param fillColor - 填充颜色,`none`
|
|
17021
|
+
* @param fillColor - 填充颜色,`none` 表示无��充,`null` 表示默认
|
|
17035
17022
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
17036
17023
|
* @param lineType - 线型,`null` 表示默认
|
|
17037
17024
|
* @param fillStyle - 填充样式,`null` 表示默认
|
|
@@ -17575,7 +17562,7 @@ declare global {
|
|
|
17575
17562
|
*/
|
|
17576
17563
|
toSync(): ISCH_PrimitiveWire;
|
|
17577
17564
|
/**
|
|
17578
|
-
*
|
|
17565
|
+
* 查询图元是否为异步图元
|
|
17579
17566
|
*
|
|
17580
17567
|
* @public
|
|
17581
17568
|
* @returns 是否为异步图元
|
|
@@ -18104,7 +18091,7 @@ declare global {
|
|
|
18104
18091
|
*/
|
|
18105
18092
|
useEffect: (effect: () => undefined | (() => undefined), deps?: React.DependencyList) => void;
|
|
18106
18093
|
/**
|
|
18107
|
-
*
|
|
18094
|
+
* ��建并返回指定类型的新 React 元素
|
|
18108
18095
|
* @param type - 元素类型
|
|
18109
18096
|
* @param props - 元素属性
|
|
18110
18097
|
* @param children - 子元素
|
|
@@ -18584,7 +18571,7 @@ declare global {
|
|
|
18584
18571
|
*/
|
|
18585
18572
|
openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: false): Promise<File | undefined>;
|
|
18586
18573
|
/**
|
|
18587
|
-
*
|
|
18574
|
+
* 打��读入文件夹窗口
|
|
18588
18575
|
*
|
|
18589
18576
|
* @alpha
|
|
18590
18577
|
* @remarks 本接口的浏览器支持有限,具体请参考 {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory | MDN}
|
|
@@ -20087,7 +20074,7 @@ declare global {
|
|
|
20087
20074
|
* @remarks 设置定时器
|
|
20088
20075
|
*/
|
|
20089
20076
|
class SYS_Timer {
|
|
20090
|
-
/**
|
|
20077
|
+
/** 扩展 UUID */
|
|
20091
20078
|
private extensionUuid?;
|
|
20092
20079
|
/**
|
|
20093
20080
|
* @internal
|
|
@@ -20098,7 +20085,7 @@ declare global {
|
|
|
20098
20085
|
* 设置循环定时器
|
|
20099
20086
|
*
|
|
20100
20087
|
* @public
|
|
20101
|
-
* @remarks 如果遇到 ID
|
|
20088
|
+
* @remarks 如果遇到 ID 重复的定时器,��之前设置的定时器将被清除
|
|
20102
20089
|
* @param id - 定时器 ID,用于定位&删除定时器
|
|
20103
20090
|
* @param timeout - 定时时间,单位 ms
|
|
20104
20091
|
* @param callFn - 定时调用函数
|
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.41", "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" } }
|