@jlceda/pro-api-types 0.1.93 → 0.1.95
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 +43 -33
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -416,7 +416,7 @@ declare class DMT_Project {
|
|
|
416
416
|
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
417
417
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
418
418
|
* @param description - 工程描述
|
|
419
|
-
* @param collaborationMode -
|
|
419
|
+
* @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则该���数将被忽略
|
|
420
420
|
* @returns 工程 UUID,如若为 `undefined` 则创建失败
|
|
421
421
|
*/
|
|
422
422
|
createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
|
|
@@ -595,7 +595,7 @@ declare class DMT_Schematic {
|
|
|
595
595
|
*/
|
|
596
596
|
getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
598
|
+
* 获取当前原理���图页的详细属性
|
|
599
599
|
*
|
|
600
600
|
* @beta
|
|
601
601
|
* @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
|
|
@@ -813,7 +813,7 @@ declare const eda: EDA;
|
|
|
813
813
|
* @public
|
|
814
814
|
*/
|
|
815
815
|
declare enum EDMT_EditorDocumentType {
|
|
816
|
-
/**
|
|
816
|
+
/** 开���页 */
|
|
817
817
|
HOME = -1,
|
|
818
818
|
/** 空白页 */
|
|
819
819
|
BLANK = 0,
|
|
@@ -2448,6 +2448,8 @@ declare class IPCB_Polygon {
|
|
|
2448
2448
|
* @public
|
|
2449
2449
|
*/
|
|
2450
2450
|
declare interface IPCB_Primitive {
|
|
2451
|
+
getState_PrimitiveType: () => EPCB_PrimitiveType;
|
|
2452
|
+
getState_PrimitiveId: () => string;
|
|
2451
2453
|
create: () => IPCB_Primitive | Promise<IPCB_Primitive>;
|
|
2452
2454
|
toAsync: () => IPCB_Primitive;
|
|
2453
2455
|
toSync: () => IPCB_Primitive;
|
|
@@ -2604,7 +2606,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
|
|
|
2604
2606
|
*
|
|
2605
2607
|
* @beta
|
|
2606
2608
|
* @param layer - 层
|
|
2607
|
-
* @returns
|
|
2609
|
+
* @returns 圆弧线图元对象
|
|
2608
2610
|
*/
|
|
2609
2611
|
setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveArc;
|
|
2610
2612
|
/**
|
|
@@ -2764,6 +2766,12 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
|
|
|
2764
2766
|
* @returns 器件图元对象
|
|
2765
2767
|
*/
|
|
2766
2768
|
create(): Promise<IPCB_PrimitiveComponent>;
|
|
2769
|
+
/**
|
|
2770
|
+
* 获取对象的图元 ID
|
|
2771
|
+
*
|
|
2772
|
+
* @returns
|
|
2773
|
+
*/
|
|
2774
|
+
getState_PrimitiveType(): EPCB_PrimitiveType;
|
|
2767
2775
|
/**
|
|
2768
2776
|
* 获取对象的图元 ID
|
|
2769
2777
|
*
|
|
@@ -3225,7 +3233,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
|
|
|
3225
3233
|
* 获取属性状态:BBox 左上点坐标 X
|
|
3226
3234
|
*
|
|
3227
3235
|
* @public
|
|
3228
|
-
* @returns BBox
|
|
3236
|
+
* @returns BBox ���上点坐标 X
|
|
3229
3237
|
*/
|
|
3230
3238
|
getState_X(): number;
|
|
3231
3239
|
/**
|
|
@@ -3565,7 +3573,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3565
3573
|
*/
|
|
3566
3574
|
toSync(): IPCB_PrimitiveLine;
|
|
3567
3575
|
/**
|
|
3568
|
-
*
|
|
3576
|
+
* 查询图元是否为��步图元
|
|
3569
3577
|
*
|
|
3570
3578
|
* @public
|
|
3571
3579
|
* @returns 是否为异步图元
|
|
@@ -4635,7 +4643,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
4635
4643
|
*/
|
|
4636
4644
|
getState_ViaType(): EPCB_PrimitiveViaType;
|
|
4637
4645
|
/**
|
|
4638
|
-
*
|
|
4646
|
+
* 获取属性状态:盲埋孔设计规则项名称
|
|
4639
4647
|
*
|
|
4640
4648
|
* @public
|
|
4641
4649
|
* @returns 盲埋孔设计规则项名称
|
|
@@ -4770,6 +4778,8 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
4770
4778
|
* @public
|
|
4771
4779
|
*/
|
|
4772
4780
|
declare interface ISCH_Primitive {
|
|
4781
|
+
getState_PrimitiveType: () => ESCH_PrimitiveType;
|
|
4782
|
+
getState_PrimitiveId: () => string;
|
|
4773
4783
|
create: () => ISCH_Primitive | Promise<ISCH_Primitive>;
|
|
4774
4784
|
toAsync: () => ISCH_Primitive;
|
|
4775
4785
|
toSync: () => ISCH_Primitive;
|
|
@@ -4779,7 +4789,7 @@ declare interface ISCH_Primitive {
|
|
|
4779
4789
|
}
|
|
4780
4790
|
|
|
4781
4791
|
/**
|
|
4782
|
-
*
|
|
4792
|
+
* 原理图图��接口
|
|
4783
4793
|
*
|
|
4784
4794
|
* @public
|
|
4785
4795
|
*/
|
|
@@ -4835,7 +4845,7 @@ declare class ISCH_PrimitiveArc implements ISCH_Primitive {
|
|
|
4835
4845
|
* @returns 圆弧图元对象
|
|
4836
4846
|
*/
|
|
4837
4847
|
create(): Promise<ISCH_PrimitiveArc>;
|
|
4838
|
-
getState_PrimitiveType():
|
|
4848
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
4839
4849
|
getState_PrimitiveId(): string;
|
|
4840
4850
|
getState_StartY(): number;
|
|
4841
4851
|
getState_StartX(): number;
|
|
@@ -4923,7 +4933,7 @@ declare class ISCH_PrimitiveBus implements ISCH_Primitive {
|
|
|
4923
4933
|
* @returns 总线图元对象
|
|
4924
4934
|
*/
|
|
4925
4935
|
create(): ISCH_PrimitiveBus;
|
|
4926
|
-
getState_PrimitiveType():
|
|
4936
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
4927
4937
|
getState_PrimitiveId(): string;
|
|
4928
4938
|
getState_BusName(): BusNetGroupCreateOptions['net'];
|
|
4929
4939
|
getState_Line(): BusNetGroupCreateOptions['line'];
|
|
@@ -5000,7 +5010,7 @@ declare class ISCH_PrimitiveCircle implements ISCH_Primitive {
|
|
|
5000
5010
|
* @returns 圆图元对象
|
|
5001
5011
|
*/
|
|
5002
5012
|
create(): Promise<ISCH_PrimitiveCircle>;
|
|
5003
|
-
getState_PrimitiveType():
|
|
5013
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5004
5014
|
getState_PrimitiveId(): string;
|
|
5005
5015
|
getState_CenterX(): number;
|
|
5006
5016
|
getState_CenterY(): number;
|
|
@@ -5042,7 +5052,7 @@ declare class ISCH_PrimitiveCircle implements ISCH_Primitive {
|
|
|
5042
5052
|
*/
|
|
5043
5053
|
reset(): Promise<ISCH_PrimitiveCircle>;
|
|
5044
5054
|
/**
|
|
5045
|
-
*
|
|
5055
|
+
* 将对图元的更改应用到画��
|
|
5046
5056
|
*
|
|
5047
5057
|
* @beta
|
|
5048
5058
|
*/
|
|
@@ -5061,7 +5071,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
|
|
|
5061
5071
|
private readonly primitiveType;
|
|
5062
5072
|
/** 器件类型 */
|
|
5063
5073
|
private componentType;
|
|
5064
|
-
/**
|
|
5074
|
+
/** 图元 ID */
|
|
5065
5075
|
private primitiveId?;
|
|
5066
5076
|
/** 关联库器件 */
|
|
5067
5077
|
private component;
|
|
@@ -5484,7 +5494,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
|
|
|
5484
5494
|
* @returns 引脚图元对象
|
|
5485
5495
|
*/
|
|
5486
5496
|
create(): Promise<ISCH_PrimitivePin>;
|
|
5487
|
-
getState_PrimitiveType():
|
|
5497
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5488
5498
|
getState_PrimitiveId(): string;
|
|
5489
5499
|
getState_X(): number;
|
|
5490
5500
|
getState_Y(): number;
|
|
@@ -5559,13 +5569,13 @@ declare class ISCH_PrimitivePolygon implements ISCH_Primitive {
|
|
|
5559
5569
|
* @returns 多边形图元对象
|
|
5560
5570
|
*/
|
|
5561
5571
|
create(): Promise<ISCH_PrimitivePolygon>;
|
|
5562
|
-
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5568
|
-
|
|
5572
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5573
|
+
getState_PrimitiveId(): string;
|
|
5574
|
+
getState_Line(): Number[];
|
|
5575
|
+
getState_Color(): string | null;
|
|
5576
|
+
getState_FillColor(): string | null;
|
|
5577
|
+
getState_LineWidth(): number | null;
|
|
5578
|
+
getState_LineType(): number | null;
|
|
5569
5579
|
/** 数据校验 */
|
|
5570
5580
|
setState_Line(line: Array<number>): ISCH_PrimitivePolygon;
|
|
5571
5581
|
/** 数据校验 */
|
|
@@ -5637,7 +5647,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
|
|
|
5637
5647
|
* @returns 矩形图元对象
|
|
5638
5648
|
*/
|
|
5639
5649
|
create(): Promise<ISCH_PrimitiveRectangle>;
|
|
5640
|
-
getState_PrimitiveType():
|
|
5650
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5641
5651
|
getState_PrimitiveId(): string;
|
|
5642
5652
|
getState_TopLeftX(): number;
|
|
5643
5653
|
getState_TopLeftY(): number;
|
|
@@ -5723,7 +5733,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
|
|
|
5723
5733
|
* @returns 文本图元对象
|
|
5724
5734
|
*/
|
|
5725
5735
|
create(): Promise<ISCH_PrimitiveText>;
|
|
5726
|
-
getState_PrimitiveType():
|
|
5736
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5727
5737
|
getState_PrimitiveId(): string;
|
|
5728
5738
|
getState_X(): number;
|
|
5729
5739
|
getState_Y(): number;
|
|
@@ -5814,7 +5824,7 @@ declare class ISCH_PrimitiveWire implements ISCH_Primitive {
|
|
|
5814
5824
|
* @returns 导线图元对象
|
|
5815
5825
|
*/
|
|
5816
5826
|
create(): ISCH_PrimitiveWire;
|
|
5817
|
-
getState_PrimitiveType():
|
|
5827
|
+
getState_PrimitiveType(): ESCH_PrimitiveType;
|
|
5818
5828
|
getState_PrimitiveId(): string;
|
|
5819
5829
|
getState_Line(): WireNetGroupCreateOptions['line'];
|
|
5820
5830
|
getState_Net(): WireNetGroupCreateOptions['net'];
|
|
@@ -6704,14 +6714,14 @@ declare class PCB_Document {
|
|
|
6704
6714
|
*
|
|
6705
6715
|
* @public
|
|
6706
6716
|
* @remarks
|
|
6707
|
-
*
|
|
6717
|
+
* 嘉立�� EDA 专业版前端显示的坐标均为画布原点;
|
|
6708
6718
|
*
|
|
6709
6719
|
* 嘉立创 EDA 专业版 API 使用的均为数据原点;
|
|
6710
6720
|
*
|
|
6711
6721
|
* 如果返回的数据为 `{ canvasOriginOffsetX: 100, canvasOriginOffsetY: 200 }`,
|
|
6712
6722
|
* 则代表画布原点在数据原点的向右 100 单位且向上 200 单位的位置;
|
|
6713
6723
|
*
|
|
6714
|
-
*
|
|
6724
|
+
* 此处的单位为数据层面单位,在跨度上等同于画布层面的 mil
|
|
6715
6725
|
* @returns 画布原点相对于数据原点的偏移坐标
|
|
6716
6726
|
*/
|
|
6717
6727
|
getCanvasOrigin(): Promise<{
|
|
@@ -7055,7 +7065,7 @@ declare class PCB_Drc {
|
|
|
7055
7065
|
* 从等长网络组中移除网络
|
|
7056
7066
|
*
|
|
7057
7067
|
* @beta
|
|
7058
|
-
* @param equalLengthNetGroupName -
|
|
7068
|
+
* @param equalLengthNetGroupName - 等��网络组名称
|
|
7059
7069
|
* @param net - 网络名称
|
|
7060
7070
|
* @returns 操作是否成功
|
|
7061
7071
|
*/
|
|
@@ -7296,7 +7306,7 @@ declare class PCB_ManufactureData {
|
|
|
7296
7306
|
* 获取 PCB 制版文件(Gerber)
|
|
7297
7307
|
*
|
|
7298
7308
|
* @beta
|
|
7299
|
-
* @remarks 可以使用 {@link SYS_FileSystem.saveFile}
|
|
7309
|
+
* @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本��文件系统
|
|
7300
7310
|
* @param fileName - 文件名
|
|
7301
7311
|
* @param colorSilkscreen - 是否生成彩色丝印制造文件(嘉立创专用文件)
|
|
7302
7312
|
* @param unit - 单位
|
|
@@ -8207,7 +8217,7 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
|
|
|
8207
8217
|
* @beta
|
|
8208
8218
|
* @param primitiveId - 图元 ID
|
|
8209
8219
|
* @param property - 修改参数
|
|
8210
|
-
* @returns
|
|
8220
|
+
* @returns 折线图元对象
|
|
8211
8221
|
*/
|
|
8212
8222
|
modify(primitiveId: string | IPCB_PrimitivePolyline, property: {
|
|
8213
8223
|
net?: string;
|
|
@@ -8644,7 +8654,7 @@ declare class SCH_PrimitiveArc implements ISCH_PrimitiveAPI {
|
|
|
8644
8654
|
* 创建圆弧
|
|
8645
8655
|
*
|
|
8646
8656
|
* @beta
|
|
8647
|
-
* @param startX -
|
|
8657
|
+
* @param startX - 起始��� X
|
|
8648
8658
|
* @param startY - 起始点 Y
|
|
8649
8659
|
* @param referenceX - 参考点 X
|
|
8650
8660
|
* @param referenceY - 参考点 Y
|
|
@@ -9591,7 +9601,7 @@ declare class SYS_Environment {
|
|
|
9591
9601
|
*/
|
|
9592
9602
|
isClient(): boolean;
|
|
9593
9603
|
/**
|
|
9594
|
-
* 是否为 EasyEDA Pro
|
|
9604
|
+
* 是否为 EasyEDA Pro 版本
|
|
9595
9605
|
*
|
|
9596
9606
|
* @public
|
|
9597
9607
|
* @returns 是否为 EasyEDA Pro 版本
|
|
@@ -10163,7 +10173,7 @@ declare class SYS_Storage {
|
|
|
10163
10173
|
private extensionUuid?;
|
|
10164
10174
|
/* Excluded from this release type: __constructor */
|
|
10165
10175
|
/**
|
|
10166
|
-
*
|
|
10176
|
+
* 获取扩展所有用户配置
|
|
10167
10177
|
*
|
|
10168
10178
|
* @public
|
|
10169
10179
|
* @remarks 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
|
|
@@ -10566,7 +10576,7 @@ declare type TPCB_LayerTypesOfInnerLayer = EPCB_LayerType.SIGNAL | EPCB_LayerTyp
|
|
|
10566
10576
|
*
|
|
10567
10577
|
* `['CIRCLE', 100, 200, 5]`
|
|
10568
10578
|
*
|
|
10569
|
-
*
|
|
10579
|
+
* 单多边形的数据由以下几种模式组合而成:
|
|
10570
10580
|
*
|
|
10571
10581
|
* ① L 直线模式
|
|
10572
10582
|
*
|