@jlceda/pro-api-types 0.2.38 → 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 +32 -46
- 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;
|
|
@@ -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>;
|
|
@@ -7048,7 +7035,7 @@ declare global {
|
|
|
7048
7035
|
* 获取所有圆弧线的图元 ID
|
|
7049
7036
|
*
|
|
7050
7037
|
* @beta
|
|
7051
|
-
* @param net -
|
|
7038
|
+
* @param net - 网络名称
|
|
7052
7039
|
* @param layer - 层
|
|
7053
7040
|
* @param primitiveLock - 是否锁定
|
|
7054
7041
|
* @returns 圆弧线的图元 ID 数组
|
|
@@ -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;
|
|
@@ -10425,7 +10412,7 @@ declare global {
|
|
|
10425
10412
|
*
|
|
10426
10413
|
* @beta
|
|
10427
10414
|
* @remarks
|
|
10428
|
-
*
|
|
10415
|
+
* 本接口模拟前端点击放置按钮,指定的器件将绑定到当前鼠标,并在用户后续点击时放置于画布
|
|
10429
10416
|
*
|
|
10430
10417
|
* 本接口的返回时机并不会等待用户的放置操作,一旦器件被绑定到鼠标,本接口将立即返回 `true` 的结果
|
|
10431
10418
|
* @param component - 关联库器件
|
|
@@ -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
|
*/
|
|
@@ -12594,7 +12581,7 @@ declare global {
|
|
|
12594
12581
|
* 如若达成下单条件,将返回 `true` 并在新标签页打开下单页面
|
|
12595
12582
|
* @param ignoreWarning - 在非交互式检查时忽略警告
|
|
12596
12583
|
*
|
|
12597
|
-
* 如果设置为 `true
|
|
12584
|
+
* 如果设置为 `true`,将会忽略所有检查警告项并尽可能生成下单资料;
|
|
12598
12585
|
*
|
|
12599
12586
|
* 如果设置为 `false`,存在任意警告将中断执行并返回 `false` 的结果
|
|
12600
12587
|
* @returns 是否通过下单检查
|
|
@@ -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 是否为异步图元
|
|
@@ -15400,7 +15387,7 @@ declare global {
|
|
|
15400
15387
|
*/
|
|
15401
15388
|
getState_Manufacturer(): string | undefined;
|
|
15402
15389
|
/**
|
|
15403
|
-
*
|
|
15390
|
+
* 获取属性状态:制造商编号
|
|
15404
15391
|
*
|
|
15405
15392
|
* @public
|
|
15406
15393
|
* @returns 制造商编号
|
|
@@ -15886,7 +15873,7 @@ declare global {
|
|
|
15886
15873
|
* @beta
|
|
15887
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
|
/**
|
|
@@ -16449,7 +16436,7 @@ declare global {
|
|
|
16449
16436
|
* 在原理图画布中创建图元
|
|
16450
16437
|
*
|
|
16451
16438
|
* @internal
|
|
16452
|
-
* @returns
|
|
16439
|
+
* @returns 器件图元对象
|
|
16453
16440
|
*/
|
|
16454
16441
|
create(): Promise<ISCH_PrimitiveCbbSymbolComponent>;
|
|
16455
16442
|
/**
|
|
@@ -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 是否为异步图元
|
|
@@ -17833,8 +17820,9 @@ declare global {
|
|
|
17833
17820
|
onFilterClick?: (data: string) => void;
|
|
17834
17821
|
onChange?: (data: string) => void;
|
|
17835
17822
|
onAddClick?: (data: string) => void;
|
|
17823
|
+
onBlur?: (data: string) => void;
|
|
17836
17824
|
}
|
|
17837
|
-
function Input({ width, disabled, readonly, clearBtn, clickBtn, dropDownList, searchBtn, value: propValue, placeholder, preText, type, otherAttr, testVal, onClick, onSearchClick, onFilterClick, onChange, onAddClick, }: InputProps): react_jsx_runtime.JSX.Element;
|
|
17825
|
+
function Input({ width, disabled, readonly, clearBtn, clickBtn, dropDownList, searchBtn, value: propValue, placeholder, preText, type, otherAttr, testVal, onClick, onSearchClick, onFilterClick, onChange, onAddClick, onBlur, }: InputProps): react_jsx_runtime.JSX.Element;
|
|
17838
17826
|
|
|
17839
17827
|
interface TextProps {
|
|
17840
17828
|
value: string;
|
|
@@ -17967,12 +17955,12 @@ declare global {
|
|
|
17967
17955
|
maxDragX?: number;
|
|
17968
17956
|
maxDragY?: number;
|
|
17969
17957
|
hide?: boolean;
|
|
17970
|
-
|
|
17971
|
-
|
|
17958
|
+
resizeX?: boolean;
|
|
17959
|
+
resizeY?: boolean;
|
|
17972
17960
|
children?: React$1.ReactNode;
|
|
17973
17961
|
onMoved?: (top: number, left: number) => void;
|
|
17974
17962
|
}
|
|
17975
|
-
function Modal({ top, left, width, height, maxDragX, maxDragY, hide, overlay,
|
|
17963
|
+
function Modal({ top, left, width, height, maxDragX, maxDragY, hide, overlay, resizeX, resizeY, children, onMoved, }: ModalProps): react_jsx_runtime.JSX.Element;
|
|
17976
17964
|
|
|
17977
17965
|
interface DialogProps {
|
|
17978
17966
|
title: string;
|
|
@@ -17984,8 +17972,8 @@ declare global {
|
|
|
17984
17972
|
overlay?: boolean;
|
|
17985
17973
|
maxDragY?: number;
|
|
17986
17974
|
modal?: boolean;
|
|
17987
|
-
|
|
17988
|
-
|
|
17975
|
+
resizeX?: boolean;
|
|
17976
|
+
resizeY?: boolean;
|
|
17989
17977
|
buttons?: ButtonProps[];
|
|
17990
17978
|
onClose?: () => void;
|
|
17991
17979
|
children?: React$1.ReactNode;
|
|
@@ -18103,7 +18091,7 @@ declare global {
|
|
|
18103
18091
|
*/
|
|
18104
18092
|
useEffect: (effect: () => undefined | (() => undefined), deps?: React.DependencyList) => void;
|
|
18105
18093
|
/**
|
|
18106
|
-
*
|
|
18094
|
+
* ��建并返回指定类型的新 React 元素
|
|
18107
18095
|
* @param type - 元素类型
|
|
18108
18096
|
* @param props - 元素属性
|
|
18109
18097
|
* @param children - 子元素
|
|
@@ -18577,13 +18565,13 @@ declare global {
|
|
|
18577
18565
|
* 打开读入文件窗口
|
|
18578
18566
|
*
|
|
18579
18567
|
* @beta
|
|
18580
|
-
* @param filenameExtensions -
|
|
18568
|
+
* @param filenameExtensions - 文件扩展名
|
|
18581
18569
|
* @param multiFiles - 是否允许读取多文件
|
|
18582
18570
|
* @returns File 格式文件
|
|
18583
18571
|
*/
|
|
18584
18572
|
openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: false): Promise<File | undefined>;
|
|
18585
18573
|
/**
|
|
18586
|
-
*
|
|
18574
|
+
* 打��读入文件夹窗口
|
|
18587
18575
|
*
|
|
18588
18576
|
* @alpha
|
|
18589
18577
|
* @remarks 本接口的浏览器支持有限,具体请参考 {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory | MDN}
|
|
@@ -18955,8 +18943,6 @@ declare global {
|
|
|
18955
18943
|
*
|
|
18956
18944
|
* @beta
|
|
18957
18945
|
* @remarks
|
|
18958
|
-
* 系统顶部菜单一旦新增无法有效删除,需要重启嘉立创 EDA 软件才可以恢复
|
|
18959
|
-
*
|
|
18960
18946
|
* 本接口需要在系统已有的系统一级菜单下新增子菜单,无法新增和修改一级菜单,`id` 数组请至少传递 `2` 个值
|
|
18961
18947
|
*
|
|
18962
18948
|
* 本接口将会强制新建的系统顶部菜单的 ID 包含扩展 UUID,例如输入的 `id = 'example'`,将会被自动重写为 `e143d88179874e7f851cc890cd22fc71|example`,后续如需移除该菜单,请输入重写后的名称
|
|
@@ -18971,7 +18957,7 @@ declare global {
|
|
|
18971
18957
|
* @param env - 环境
|
|
18972
18958
|
* @param id - 菜单项 ID 树,将会按照数组顺序按层级匹配菜单项,并将数组最后一位作为插入的菜单项的 ID
|
|
18973
18959
|
* @param props - 其它参数
|
|
18974
|
-
* @returns 顶部菜单项的 ID
|
|
18960
|
+
* @returns 顶部菜单项的 ID,分隔线是否插入并不会影响操作结果的返回值,不包含 menuItems 中的子项的 ID
|
|
18975
18961
|
*/
|
|
18976
18962
|
insertSystemHeaderMenuItem(env: ESYS_HeaderMenuEnvironment, id: Array<string>, props: {
|
|
18977
18963
|
/** 菜单项的标题 */
|
|
@@ -19580,7 +19566,7 @@ declare global {
|
|
|
19580
19566
|
* @public
|
|
19581
19567
|
* @param message - 消息内容
|
|
19582
19568
|
* @param messageType - 消息类型
|
|
19583
|
-
* @param timer -
|
|
19569
|
+
* @param timer - 自动关闭倒计时秒数,`0` 为不自动关闭
|
|
19584
19570
|
* @param bottomPanel - 展开底部信息面板
|
|
19585
19571
|
* @param buttonTitle - 回调按钮标题
|
|
19586
19572
|
* @param buttonCallbackFn - 回调函数内容,字符串形式,会被自动解析并执行
|
|
@@ -20085,7 +20071,7 @@ declare global {
|
|
|
20085
20071
|
* 系统 / 定时器类
|
|
20086
20072
|
*
|
|
20087
20073
|
* @public
|
|
20088
|
-
* @remarks
|
|
20074
|
+
* @remarks 设置定时器
|
|
20089
20075
|
*/
|
|
20090
20076
|
class SYS_Timer {
|
|
20091
20077
|
/** 扩展 UUID */
|
|
@@ -20099,7 +20085,7 @@ declare global {
|
|
|
20099
20085
|
* 设置循环定时器
|
|
20100
20086
|
*
|
|
20101
20087
|
* @public
|
|
20102
|
-
* @remarks 如果遇到 ID
|
|
20088
|
+
* @remarks 如果遇到 ID 重复的定时器,��之前设置的定时器将被清除
|
|
20103
20089
|
* @param id - 定时器 ID,用于定位&删除定时器
|
|
20104
20090
|
* @param timeout - 定时时间,单位 ms
|
|
20105
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" } }
|