@jlceda/pro-api-types 0.1.58 → 0.1.60
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/README.md +7 -1
- package/index.d.ts +8 -8
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义
|
|
4
4
|
|
|
5
|
+
[](https://easyeda-docs.coding.net/p/eda-sdk/ci/job)
|
|
6
|
+

|
|
7
|
+

|
|
8
|
+

|
|
9
|
+

|
|
10
|
+
|
|
5
11
|
## 使用
|
|
6
12
|
|
|
7
13
|
建议使用 [pro-api-sdk](https://github.com/jlceda/pro-api-sdk) 进行扩展开发,本定义文件已在 SDK 内预配。
|
|
@@ -9,7 +15,7 @@
|
|
|
9
15
|
1. 安装类型定义
|
|
10
16
|
|
|
11
17
|
```shell
|
|
12
|
-
npm
|
|
18
|
+
npm install --save-dev @jlceda/pro-api-types
|
|
13
19
|
```
|
|
14
20
|
|
|
15
21
|
2. 将 `./node_modules/@jlceda/pro-api-types/` 添加到 `tsconfig.include` 内
|
package/index.d.ts
CHANGED
|
@@ -412,7 +412,7 @@ declare class DMT_Project {
|
|
|
412
412
|
*
|
|
413
413
|
* @beta
|
|
414
414
|
* @param projectFriendlyName - 工程友好名称
|
|
415
|
-
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线
|
|
415
|
+
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称���动生成
|
|
416
416
|
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
417
417
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
418
418
|
* @param description - 工程描述
|
|
@@ -686,7 +686,7 @@ declare class DMT_Team {
|
|
|
686
686
|
*/
|
|
687
687
|
declare class DMT_Workspace {
|
|
688
688
|
/**
|
|
689
|
-
*
|
|
689
|
+
* 获取所有工作区的详细属性
|
|
690
690
|
*
|
|
691
691
|
* @public
|
|
692
692
|
* @returns 所有工作区的详细属性
|
|
@@ -4223,7 +4223,7 @@ declare class LIB_3DModel {
|
|
|
4223
4223
|
* @beta
|
|
4224
4224
|
* @param modelUuid - 3D 模型 UUID
|
|
4225
4225
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
4226
|
-
* @returns
|
|
4226
|
+
* @returns 操作是否成功
|
|
4227
4227
|
*/
|
|
4228
4228
|
delete(modelUuid: string, libraryUuid: string): Promise<boolean>;
|
|
4229
4229
|
/**
|
|
@@ -4784,7 +4784,7 @@ declare class LIB_PanelLibrary {
|
|
|
4784
4784
|
*
|
|
4785
4785
|
* @beta
|
|
4786
4786
|
* @param key - 搜索关键字
|
|
4787
|
-
* @param libraryUuid - 库 UUID
|
|
4787
|
+
* @param libraryUuid - 库 UUID,默认为系统库��可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
4788
4788
|
* @param classification - 分类,默认为全部
|
|
4789
4789
|
* @param itemsOfPage - 一页搜索结果的数量
|
|
4790
4790
|
* @param page - 页数
|
|
@@ -4986,7 +4986,7 @@ declare class PCB_Document {
|
|
|
4986
4986
|
*
|
|
4987
4987
|
* 嘉立创 EDA 专业版 API 使用的均为数据原点;
|
|
4988
4988
|
*
|
|
4989
|
-
* 如果希望在 API
|
|
4989
|
+
* 如果希望在 API 操作时前端画布坐标能与数据一致,
|
|
4990
4990
|
* 建议调用本方法并设置偏移量为零,
|
|
4991
4991
|
* 即 `setCanvasOrigin(0, 0)`;
|
|
4992
4992
|
*
|
|
@@ -6190,7 +6190,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
|
|
|
6190
6190
|
*/
|
|
6191
6191
|
create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveLine | undefined>;
|
|
6192
6192
|
/**
|
|
6193
|
-
*
|
|
6193
|
+
* 删除导线
|
|
6194
6194
|
*
|
|
6195
6195
|
* @beta
|
|
6196
6196
|
* @param primitiveIds - 导线的图元 ID 或导线图元对象
|
|
@@ -6640,7 +6640,7 @@ declare class SCH_Drc {
|
|
|
6640
6640
|
* 检查 DRC
|
|
6641
6641
|
*
|
|
6642
6642
|
* @public
|
|
6643
|
-
* @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false
|
|
6643
|
+
* @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false`,否则返回 `true`
|
|
6644
6644
|
* @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
|
|
6645
6645
|
* @returns DRC 检查是否无错误
|
|
6646
6646
|
*/
|
|
@@ -7307,7 +7307,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
|
|
|
7307
7307
|
* 获取多边形
|
|
7308
7308
|
*
|
|
7309
7309
|
* @beta
|
|
7310
|
-
* @param primitiveIds -
|
|
7310
|
+
* @param primitiveIds - 多边形的图��� ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
7311
7311
|
* @returns 多边形图元对象
|
|
7312
7312
|
*/
|
|
7313
7313
|
get(primitiveIds: string): Promise<ISCH_PrimitivePolygon | undefined>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jlceda/pro-api-types",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.60",
|
|
4
4
|
"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
|
|
5
5
|
"typings": "index.d.ts",
|
|
6
6
|
"keywords": [
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
],
|
|
10
10
|
"author": "JLCEDA <support@lceda.cn>",
|
|
11
11
|
"license": "Apache-2.0",
|
|
12
|
-
"homepage": "https://lceda.cn/",
|
|
12
|
+
"homepage": "https://pro.lceda.cn/",
|
|
13
13
|
"scripts": {
|
|
14
14
|
"prepare": "husky",
|
|
15
15
|
"prettier:all": "prettier --write .",
|
|
@@ -33,7 +33,6 @@
|
|
|
33
33
|
"husky": "^9.1.1",
|
|
34
34
|
"lint-staged": "^15.2.7",
|
|
35
35
|
"prettier": "^3.3.3",
|
|
36
|
-
"rimraf": "^6.0.1",
|
|
37
36
|
"ts-node": "^10.9.2",
|
|
38
37
|
"typescript": "^5.5.4"
|
|
39
38
|
},
|