@jlceda/pro-api-types 0.2.46 → 0.2.47
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 -22
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -228,7 +228,7 @@ declare global {
|
|
|
228
228
|
* 分类索引
|
|
229
229
|
*
|
|
230
230
|
* @public
|
|
231
|
-
* @deprecated
|
|
231
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
232
232
|
* @remarks 本分类索引用于索引指定库内的分类,其中库 UUID 和库类型仅作针对于本索引的识别用途,防止将不同库内的索引互相引用从而引发错误
|
|
233
233
|
*/
|
|
234
234
|
interface ILIB_ClassificationIndex {
|
|
@@ -251,7 +251,7 @@ declare global {
|
|
|
251
251
|
* 创建一级分类
|
|
252
252
|
*
|
|
253
253
|
* @beta
|
|
254
|
-
* @deprecated
|
|
254
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
255
255
|
* @param libraryUuid - 库 UUID
|
|
256
256
|
* @param libraryType - 库类型
|
|
257
257
|
* @param primaryClassificationName - 一级分类名称
|
|
@@ -262,7 +262,7 @@ declare global {
|
|
|
262
262
|
* 创建二级分类
|
|
263
263
|
*
|
|
264
264
|
* @beta
|
|
265
|
-
* @deprecated
|
|
265
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
266
266
|
* @param libraryUuid - 库 UUID
|
|
267
267
|
* @param libraryType - 库类型
|
|
268
268
|
* @param primaryClassificationUuid - 一级分类 UUID
|
|
@@ -274,7 +274,7 @@ declare global {
|
|
|
274
274
|
* 获取指定名称的分类的分类索引
|
|
275
275
|
*
|
|
276
276
|
* @beta
|
|
277
|
-
* @deprecated
|
|
277
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
278
278
|
* @remarks 分类索引内包含分类的 UUID,具体可查阅 {@link ILIB_ClassificationIndex}
|
|
279
279
|
* @param libraryUuid - 库 UUID
|
|
280
280
|
* @param libraryType - 库类型
|
|
@@ -301,7 +301,7 @@ declare global {
|
|
|
301
301
|
* 获取指定索引的分类的名称
|
|
302
302
|
*
|
|
303
303
|
* @beta
|
|
304
|
-
* @deprecated
|
|
304
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
305
305
|
* @param classificationIndex - 分类索引
|
|
306
306
|
* @returns 两级分类的名称
|
|
307
307
|
*/
|
|
@@ -340,7 +340,7 @@ declare global {
|
|
|
340
340
|
* 删除指定索引的分类
|
|
341
341
|
*
|
|
342
342
|
* @beta
|
|
343
|
-
* @deprecated
|
|
343
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
344
344
|
* @param classificationIndex - 分类索引
|
|
345
345
|
* @returns 操作是否成功
|
|
346
346
|
*/
|
|
@@ -1382,7 +1382,7 @@ declare global {
|
|
|
1382
1382
|
*
|
|
1383
1383
|
* @public
|
|
1384
1384
|
* @param panelUuid - 面板 UUID
|
|
1385
|
-
* @returns 面板的详细属性,如若为 `undefined`
|
|
1385
|
+
* @returns 面板的详细属性,如若为 `undefined` 则获取��败
|
|
1386
1386
|
*/
|
|
1387
1387
|
getPanelInfo(panelUuid: string): Promise<IDMT_PanelItem | undefined>;
|
|
1388
1388
|
/**
|
|
@@ -2270,8 +2270,6 @@ declare global {
|
|
|
2270
2270
|
name?: string;
|
|
2271
2271
|
/** 值 */
|
|
2272
2272
|
value?: string;
|
|
2273
|
-
/** 描述 */
|
|
2274
|
-
description?: string;
|
|
2275
2273
|
/** 关联符号名称 */
|
|
2276
2274
|
symbolName?: string;
|
|
2277
2275
|
/** 关联封装名称 */
|
|
@@ -2412,11 +2410,11 @@ declare global {
|
|
|
2412
2410
|
* 使用属性精确搜索器件
|
|
2413
2411
|
*
|
|
2414
2412
|
* @alpha
|
|
2415
|
-
* @remarks
|
|
2416
|
-
* 注意:本接口仅全离线客户端有效,在浏览器环境内调用将始终 `throw Error`
|
|
2417
2413
|
* @param properties - 属性
|
|
2418
2414
|
* @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
2419
2415
|
* @param classification - 分类,默认为全部
|
|
2416
|
+
*
|
|
2417
|
+
* ADD since EDA v4
|
|
2420
2418
|
* @param symbolType - 符号类型,默认为全部
|
|
2421
2419
|
* @param itemsOfPage - 一页搜索结果的数量
|
|
2422
2420
|
* @param page - 页数
|
|
@@ -2739,7 +2737,7 @@ declare global {
|
|
|
2739
2737
|
* 外部库分类索引
|
|
2740
2738
|
*
|
|
2741
2739
|
* @public
|
|
2742
|
-
* @deprecated
|
|
2740
|
+
* @deprecated since EDA v3.2; dropped EDA v3.3
|
|
2743
2741
|
* @remarks
|
|
2744
2742
|
* 支持外部库使用名称或 UUID 作为分类的唯一 ID 索引
|
|
2745
2743
|
*/
|
|
@@ -4375,7 +4373,7 @@ declare global {
|
|
|
4375
4373
|
* 本接口在前端画布上定位到指定的区域,区域数据为相对于数据原点的偏移;
|
|
4376
4374
|
*
|
|
4377
4375
|
* 例如:传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`,
|
|
4378
|
-
* 则画布将会定位到以 `[30, 40]` 为中心的,`x` 轴方向长度为 `60`,`y`
|
|
4376
|
+
* 则画布将会定位到以 `[30, 40]` 为中心的,`x` 轴方向长度为 `60`,`y` 轴��向长度为 `120` 的矩形范围;
|
|
4379
4377
|
*
|
|
4380
4378
|
* 本接口不进行缩放操作,但会生成指示定位中心及表示区域范围的矩形框;
|
|
4381
4379
|
*
|
|
@@ -4853,7 +4851,7 @@ declare global {
|
|
|
4853
4851
|
* @beta
|
|
4854
4852
|
* @param equalLengthNetGroupName - 等长网络组名称
|
|
4855
4853
|
* @param net - 网络名称
|
|
4856
|
-
* @returns
|
|
4854
|
+
* @returns 操作是否成功
|
|
4857
4855
|
*/
|
|
4858
4856
|
addNetToEqualLengthNetGroup(equalLengthNetGroupName: string, net: string | Array<string>): Promise<boolean>;
|
|
4859
4857
|
/**
|
|
@@ -7666,7 +7664,7 @@ declare global {
|
|
|
7666
7664
|
*
|
|
7667
7665
|
* @beta
|
|
7668
7666
|
* @param reverse - 是否反相
|
|
7669
|
-
* @returns
|
|
7667
|
+
* @returns 文本图元对象
|
|
7670
7668
|
*/
|
|
7671
7669
|
setState_Reverse(reverse: boolean): IPCB_PrimitiveString;
|
|
7672
7670
|
/**
|
|
@@ -8268,7 +8266,7 @@ declare global {
|
|
|
8268
8266
|
* 在 PCB 画布中创建图元
|
|
8269
8267
|
*
|
|
8270
8268
|
* @internal
|
|
8271
|
-
* @remarks
|
|
8269
|
+
* @remarks 覆铜填充图元不支持新建,本接口调用将不会有任何效果
|
|
8272
8270
|
* @returns 覆铜填充图元对象
|
|
8273
8271
|
*/
|
|
8274
8272
|
create(): IPCB_PrimitivePoured;
|
|
@@ -10428,7 +10426,7 @@ declare global {
|
|
|
10428
10426
|
*
|
|
10429
10427
|
* @alpha
|
|
10430
10428
|
* @remarks
|
|
10431
|
-
*
|
|
10429
|
+
* ADD since API v0.2.26
|
|
10432
10430
|
*
|
|
10433
10431
|
* 本接口模拟前端点击放置按钮,指定的封装将绑定到当前鼠标,并在用户后续点击时放置于画布
|
|
10434
10432
|
*
|
|
@@ -13791,7 +13789,7 @@ declare global {
|
|
|
13791
13789
|
*
|
|
13792
13790
|
* @beta
|
|
13793
13791
|
* @param keyVisible - 键是否显示
|
|
13794
|
-
* @returns
|
|
13792
|
+
* @returns 属性图元对���
|
|
13795
13793
|
*/
|
|
13796
13794
|
setState_KeyVisible(keyVisible: boolean | null): ISCH_PrimitiveAttribute;
|
|
13797
13795
|
/**
|
|
@@ -15930,7 +15928,7 @@ declare global {
|
|
|
15930
15928
|
*
|
|
15931
15929
|
* @alpha
|
|
15932
15930
|
* @remarks
|
|
15933
|
-
*
|
|
15931
|
+
* ADD since API v0.2.26
|
|
15934
15932
|
*
|
|
15935
15933
|
* 本接口模拟前端点击放置按钮,指定的符号将绑定到当前鼠标,并在用户后续点击时放置于画布
|
|
15936
15934
|
*
|
|
@@ -18094,7 +18092,7 @@ declare global {
|
|
|
18094
18092
|
interface SortInfo {
|
|
18095
18093
|
/** 列key */
|
|
18096
18094
|
colKey: string;
|
|
18097
|
-
/**
|
|
18095
|
+
/** 排序字段 */
|
|
18098
18096
|
key: string | string[];
|
|
18099
18097
|
/** 排序状态 */
|
|
18100
18098
|
status: SortStatus;
|
|
@@ -19531,7 +19529,7 @@ declare global {
|
|
|
19531
19529
|
*
|
|
19532
19530
|
* 注意:本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 `throw Error`
|
|
19533
19531
|
*
|
|
19534
|
-
*
|
|
19532
|
+
* 非公开接口使用提醒:本接口按原样提供,不提供参数的额外文档,参数可能在任何版本出现破坏性更改并不另行通知
|
|
19535
19533
|
* @param headerMenus - 顶部菜单数据
|
|
19536
19534
|
* @example
|
|
19537
19535
|
* headerMenus:
|
|
@@ -20589,7 +20587,7 @@ declare global {
|
|
|
20589
20587
|
*
|
|
20590
20588
|
* @public
|
|
20591
20589
|
* @remarks
|
|
20592
|
-
*
|
|
20590
|
+
* 新建扩展用户配置也使用本接口,在设置时如果不存在将会自动新建
|
|
20593
20591
|
*
|
|
20594
20592
|
* 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
20595
20593
|
* @param key - 配置项
|
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.47", "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" } }
|