@jlceda/pro-api-types 0.1.105 → 0.1.107

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.
Files changed (2) hide show
  1. package/index.d.ts +167 -83
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -89,6 +89,7 @@ declare class DMT_EditorControl {
89
89
  * @returns 标签页 ID,如若为 `undefined`,则打开文档失败
90
90
  */
91
91
  openDocument(documentUuid: string, splitScreenId?: string): Promise<string | undefined>;
92
+ /* Excluded from this release type: openLibraryDocument */
92
93
  /**
93
94
  * 关闭文档
94
95
  *
@@ -195,7 +196,7 @@ declare class DMT_Folder {
195
196
  * @param teamUuid - 团队 UUID
196
197
  * @param parentFolderUuid - 父文件夹 UUID,如若不指定,则为根文件夹
197
198
  * @param description - 文件夹描述
198
- * @returns 文件夹 UUID,如若为 `undefined` 则创建失败
199
+ * @returns 文��夹 UUID,如若为 `undefined` 则创建失败
199
200
  */
200
201
  createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
201
202
  /**
@@ -310,7 +311,7 @@ declare class DMT_Panel {
310
311
  *
311
312
  * @public
312
313
  * @remarks 将会获取当前打开且拥有最后输入焦点的面板的详细属性
313
- * @returns 面板的详细属性,如若为 `undefined` 则获取失败
314
+ * @returns 面板��详细属性,如若为 `undefined` 则获取失败
314
315
  */
315
316
  getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;
316
317
  /**
@@ -416,7 +417,7 @@ declare class DMT_Project {
416
417
  * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
417
418
  * @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
418
419
  * @param description - 工程描述
419
- * @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则��参数将被忽略
420
+ * @param collaborationMode - 工程协作��式,如若团队权限无需工程设置协作模式,则该参数将被忽略
420
421
  * @returns 工程 UUID,如若为 `undefined` 则创建失败
421
422
  */
422
423
  createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -595,7 +596,7 @@ declare class DMT_Schematic {
595
596
  */
596
597
  getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
597
598
  /**
598
- * 获取当前原��图图页的详细属性
599
+ * 获取当前原理图图页的详细属性
599
600
  *
600
601
  * @beta
601
602
  * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -783,6 +784,7 @@ declare class EDA {
783
784
  sys_IFrame: SYS_IFrame;
784
785
  sys_LoadingAndProgressBar: SYS_LoadingAndProgressBar;
785
786
  sys_Log: SYS_Log;
787
+ sys_Message: SYS_Message;
786
788
  sys_MessageBox: SYS_MessageBox;
787
789
  sys_PanelControl: SYS_PanelControl;
788
790
  sys_ShortcutKey: SYS_ShortcutKey;
@@ -1017,7 +1019,7 @@ declare enum EPCB_LayerId {
1017
1019
  TOP_SOLDER_MASK = 5,
1018
1020
  /** 顶层锡膏(助焊)层 */
1019
1021
  TOP_PASTE_MASK = 7,
1020
- /** 顶层���配层 */
1022
+ /** 顶层装配层 */
1021
1023
  TOP_ASSEMBLY = 9,
1022
1024
  /** 顶层 FPC 补强层 */
1023
1025
  TOP_STIFFENER = 58,
@@ -1340,6 +1342,15 @@ declare enum EPCB_PrimitivePadShapeType {
1340
1342
  POLYLINE_COMPLEX_POLYGON = "POLYGON"
1341
1343
  }
1342
1344
 
1345
+ declare enum EPCB_PrimitivePourFillMethod {
1346
+ /** 填充样式 - 45度网格 */
1347
+ GRID45 = "45grid",
1348
+ /** 填充样式 - 90度网格 */
1349
+ GRID = "90grid",
1350
+ /** 填充样式 - 实心填充 */
1351
+ SOLID = "solid"
1352
+ }
1353
+
1343
1354
  /**
1344
1355
  * 区域图元区域规则类型
1345
1356
  *
@@ -1659,15 +1670,15 @@ declare enum ESYS_ShortcutKeyEffectiveEditorScene {
1659
1670
  */
1660
1671
  declare enum ESYS_ToastMessageType {
1661
1672
  /** 错误 */
1662
- ERROR = 0,
1673
+ ERROR = "error",
1663
1674
  /** 警告 */
1664
- WARNING = 1,
1675
+ WARNING = "warn",
1665
1676
  /** 信息 */
1666
- INFO = 2,
1677
+ INFO = "info",
1667
1678
  /** 成功 */
1668
- SUCCESS = 3,
1679
+ SUCCESS = "success",
1669
1680
  /** 问询 */
1670
- ASK = 4
1681
+ ASK = "question"
1671
1682
  }
1672
1683
 
1673
1684
  /**
@@ -1762,7 +1773,7 @@ declare interface IDMT_EditorDocumentItem {
1762
1773
  documentType: EDMT_EditorDocumentType;
1763
1774
  /** 文档 UUID */
1764
1775
  uuid: string;
1765
- /** 文档所属工程 UUID */
1776
+ /** 文档所属工��� UUID */
1766
1777
  parentProjectUuid: string;
1767
1778
  }
1768
1779
 
@@ -1799,8 +1810,7 @@ declare interface IDMT_EditorTabItem {
1799
1810
  draggable: boolean;
1800
1811
  /** 标签页是否可关闭 */
1801
1812
  isAbleDelete: boolean;
1802
- /** 标签页是否不使用 I18n 功能(内部功能) */
1803
- notUseI18n?: boolean;
1813
+ /* Excluded from this release type: notUseI18n */
1804
1814
  }
1805
1815
 
1806
1816
  /**
@@ -2126,6 +2136,32 @@ declare interface ILIB_DeviceItem {
2126
2136
  property: ILIB_DeviceExtendPropertyItem;
2127
2137
  }
2128
2138
 
2139
+ /**
2140
+ * 可用于精确搜索的器件参数
2141
+ *
2142
+ * @public
2143
+ */
2144
+ declare interface ILIB_DevicePropertiesForSearch {
2145
+ /** 器件名称 */
2146
+ name?: string;
2147
+ /** 值 */
2148
+ value?: string;
2149
+ /** 描述 */
2150
+ description?: string;
2151
+ /** 关联符号名称 */
2152
+ symbolName?: string;
2153
+ /** 关联封装名称 */
2154
+ footprintName?: string;
2155
+ /** 供应商封装名称 */
2156
+ supplierFootprint?: string;
2157
+ /** 供应商编号 */
2158
+ supplierId?: string;
2159
+ /** 料号 */
2160
+ partNumber?: string;
2161
+ /** 元件编码 */
2162
+ partCode?: string;
2163
+ }
2164
+
2129
2165
  /**
2130
2166
  * 搜索到的器件属性
2131
2167
  *
@@ -2160,11 +2196,11 @@ declare interface ILIB_DeviceSearchItem {
2160
2196
  description?: string;
2161
2197
  /** 制造商 */
2162
2198
  manufacturer?: string;
2163
- /** 制造商料号 */
2199
+ /** 制造商编号 */
2164
2200
  manufacturerId?: string;
2165
2201
  /** 供应商 */
2166
2202
  supplier?: string;
2167
- /** 供应商料号 */
2203
+ /** 供应商编号 */
2168
2204
  supplierId?: string;
2169
2205
  /** 立创商城库存 */
2170
2206
  lcscInventory?: number;
@@ -3102,7 +3138,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
3102
3138
  *
3103
3139
  * @public
3104
3140
  * @remarks
3105
- * 器件��盘图元是一个特殊的图元,它指的是在 PCB 画布上关联到封装的焊盘
3141
+ * 器件焊盘图元是一个特殊的图元,它指的是在 PCB 画布上关联到封装的焊盘
3106
3142
  *
3107
3143
  * 你只能通过 {@link PCB_PrimitiveComponent.getAllPadsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link IPCB_PrimitiveComponent.getAllPins | 器件图元的 getAllPads 方法} 获取到器件焊盘图元
3108
3144
  */
@@ -3322,14 +3358,14 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3322
3358
  private readonly primitiveType;
3323
3359
  /** 图元 ID */
3324
3360
  private primitiveId?;
3325
- /** 网络名称 */
3326
- private net;
3327
3361
  /** 层 */
3328
3362
  private layer;
3329
3363
  /** 复杂多边形 */
3330
3364
  private complexPolygon;
3365
+ /** 网络名称 */
3366
+ private net?;
3331
3367
  /** 填充模式 */
3332
- private fillMode;
3368
+ private fillMode?;
3333
3369
  /** 线宽 */
3334
3370
  private lineWidth?;
3335
3371
  /** 是否锁定 */
@@ -3356,7 +3392,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3356
3392
  * @public
3357
3393
  * @returns 网络名称
3358
3394
  */
3359
- getState_Net(): string;
3395
+ getState_Net(): string | undefined;
3360
3396
  /**
3361
3397
  * 获取属性状态:层
3362
3398
  *
@@ -3370,14 +3406,14 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3370
3406
  * @public
3371
3407
  * @returns 复杂多边形
3372
3408
  */
3373
- getState_ComplexPolygon(): IPCB_ComplexPolygon;
3409
+ getState_ComplexPolygon(): IPCB_Polygon;
3374
3410
  /**
3375
3411
  * 获取属性状态:填充模式
3376
3412
  *
3377
3413
  * @public
3378
3414
  * @returns 填充模式
3379
3415
  */
3380
- getState_FillMode(): EPCB_PrimitiveFillMode;
3416
+ getState_FillMode(): EPCB_PrimitiveFillMode | undefined;
3381
3417
  /**
3382
3418
  * 获取属性状态:线宽
3383
3419
  *
@@ -3392,14 +3428,6 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3392
3428
  * @returns 是否锁定
3393
3429
  */
3394
3430
  getState_PrimitiveLock(): boolean;
3395
- /**
3396
- * 设置属性状态:网络名称
3397
- *
3398
- * @beta
3399
- * @param net - 网络名称
3400
- * @returns 填充图元对象
3401
- */
3402
- setState_Net(net: string): IPCB_PrimitiveFill;
3403
3431
  /**
3404
3432
  * 设置属性状态:层
3405
3433
  *
@@ -3415,7 +3443,15 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
3415
3443
  * @param complexPolygon - 复杂多边形
3416
3444
  * @returns 填充图元对象
3417
3445
  */
3418
- setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitiveFill;
3446
+ setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveFill;
3447
+ /**
3448
+ * 设置属性状态:网络名称
3449
+ *
3450
+ * @beta
3451
+ * @param net - 网络名称
3452
+ * @returns 填充图元对象
3453
+ */
3454
+ setState_Net(net: string): IPCB_PrimitiveFill;
3419
3455
  /**
3420
3456
  * 设置属性状态:填充模式
3421
3457
  *
@@ -3578,7 +3614,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3578
3614
  */
3579
3615
  getState_PrimitiveLock(): boolean;
3580
3616
  /**
3581
- * 设���属性状态:BBox 左上点坐标 X
3617
+ * 设置属性状态:BBox 左上点坐标 X
3582
3618
  *
3583
3619
  * @beta
3584
3620
  * @param x - BBox 左上点坐标 X
@@ -3745,7 +3781,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
3745
3781
  */
3746
3782
  getState_StartX(): number;
3747
3783
  /**
3748
- * 获取属性状态:起��位置 Y
3784
+ * 获取属性状态:起始位置 Y
3749
3785
  *
3750
3786
  * @public
3751
3787
  * @returns 起始位置 Y
@@ -4230,7 +4266,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4230
4266
  */
4231
4267
  getState_Hole(): TPCB_PrimitivePadHole | null;
4232
4268
  /**
4233
- * 获取属��状态:孔偏移 X
4269
+ * 获取属性状态:孔偏移 X
4234
4270
  *
4235
4271
  * @public
4236
4272
  * @returns 孔偏移 X
@@ -4358,7 +4394,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4358
4394
  * 设置属性状态:网络
4359
4395
  *
4360
4396
  * @beta
4361
- * @remarks 本接口仅在 PCB 编辑器可用,空字符串与 `undefined` 均被���为空网络
4397
+ * @remarks 本接口仅在 PCB 编辑器可用,空字符串与 `undefined` 均被视为空网络
4362
4398
  * @param net - 网络名称
4363
4399
  * @returns 焊盘图元对象
4364
4400
  */
@@ -4488,7 +4524,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4488
4524
  */
4489
4525
  reset(): Promise<IPCB_PrimitivePad>;
4490
4526
  /**
4491
- * 将对图元的更改应用到���布
4527
+ * 将对图元的更改应用到画布
4492
4528
  *
4493
4529
  * @beta
4494
4530
  * @returns 尺寸标注图元对象
@@ -4612,7 +4648,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
4612
4648
  */
4613
4649
  setState_Polygon(polygon: IPCB_Polygon): IPCB_PrimitivePolyline;
4614
4650
  /**
4615
- * 设置属性状态:线宽
4651
+ * ���置属性状态:线宽
4616
4652
  *
4617
4653
  * @beta
4618
4654
  * @param lineWidth - 线宽
@@ -4733,7 +4769,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4733
4769
  * @public
4734
4770
  * @returns 复杂多边形
4735
4771
  */
4736
- getState_ComplexPolygon(): IPCB_ComplexPolygon;
4772
+ getState_ComplexPolygon(): IPCB_Polygon;
4737
4773
  /**
4738
4774
  * 获取属性状态:覆铜填充方法
4739
4775
  *
@@ -4781,7 +4817,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4781
4817
  *
4782
4818
  * @beta
4783
4819
  * @param net - 网络名称
4784
- * @returns 覆铜边框图元对象
4820
+ * @returns 覆铜边框图��对象
4785
4821
  */
4786
4822
  setState_Net(net: string): IPCB_PrimitivePour;
4787
4823
  /**
@@ -4799,7 +4835,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4799
4835
  * @param complexPolygon - 复杂多边形
4800
4836
  * @returns 覆铜边框图元对象
4801
4837
  */
4802
- setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitivePour;
4838
+ setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitivePour;
4803
4839
  /**
4804
4840
  * 设置属性状态:覆铜填充方法
4805
4841
  *
@@ -4807,12 +4843,12 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
4807
4843
  * @param pourFillMethod - 覆铜填充方法
4808
4844
  * @returns 覆铜边框图元对象
4809
4845
  */
4810
- setState_PourFillMethod(pourFillMethod: any): IPCB_PrimitivePour;
4846
+ setState_PourFillMethod(pourFillMethod: EPCB_PrimitivePourFillMethod): IPCB_PrimitivePour;
4811
4847
  /**
4812
4848
  * 设置属性状态:是否保留孤岛
4813
4849
  *
4814
4850
  * @beta
4815
- * @param preserveSilos - 是否��留孤岛
4851
+ * @param preserveSilos - 是否保留孤岛
4816
4852
  * @returns 覆铜边框图元对象
4817
4853
  */
4818
4854
  setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;
@@ -4929,7 +4965,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
4929
4965
  * @public
4930
4966
  * @returns 复杂多边形
4931
4967
  */
4932
- getState_ComplexPolygon(): IPCB_ComplexPolygon;
4968
+ getState_ComplexPolygon(): IPCB_Polygon;
4933
4969
  /**
4934
4970
  * 获取属性状态:区域规则类型
4935
4971
  *
@@ -4973,7 +5009,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
4973
5009
  * @param complexPolygon - 复杂多边形
4974
5010
  * @returns 区域图元对象
4975
5011
  */
4976
- setState_ComplexPolygon(complexPolygon: IPCB_ComplexPolygon): IPCB_PrimitiveRegion;
5012
+ setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveRegion;
4977
5013
  /**
4978
5014
  * 设置属性状态:区域规则类型
4979
5015
  *
@@ -5104,7 +5140,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
5104
5140
  */
5105
5141
  getState_PrimitiveType(): EPCB_PrimitiveType;
5106
5142
  /**
5107
- * 获取属性状态���图元 ID
5143
+ * 获取属性状态:图元 ID
5108
5144
  *
5109
5145
  * @public
5110
5146
  * @returns 图元 ID
@@ -5267,7 +5303,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
5267
5303
  */
5268
5304
  isAsync(): boolean;
5269
5305
  /**
5270
- * 将异步��元重置为当前画布状态
5306
+ * 将异步图元重置为当前画布状态
5271
5307
  *
5272
5308
  * @beta
5273
5309
  * @returns 过孔图元对象
@@ -6500,7 +6536,7 @@ declare class LIB_3DModel {
6500
6536
  * @remarks 如希望清除某些属性,则将其的值设置为 `null`
6501
6537
  * @param modelUuid - 3D 模型 UUID
6502
6538
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
6503
- * @param modelName - 3D 模型名称
6539
+ * @param modelName - 3D 模���名称
6504
6540
  * @param classification - 分类
6505
6541
  * @param description - 描述
6506
6542
  * @returns 操作是否成功
@@ -6831,6 +6867,7 @@ declare class LIB_Device {
6831
6867
  * @returns 搜索到的器件属性的列表
6832
6868
  */
6833
6869
  search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_DeviceSearchItem>>;
6870
+ /* Excluded from this release type: searchByProperties */
6834
6871
  /**
6835
6872
  * 使用立创 C 编号获取器件
6836
6873
  *
@@ -7062,7 +7099,7 @@ declare class LIB_PanelLibrary {
7062
7099
  *
7063
7100
  * @beta
7064
7101
  * @param key - 搜索关键字
7065
- * @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
7102
+ * @param libraryUuid - 库 UUID,默认为系统库,可���使用 {@link LIB_LibrariesList} 内的接口获取
7066
7103
  * @param classification - 分类,默认为全部
7067
7104
  * @param itemsOfPage - 一页搜索结果的数量
7068
7105
  * @param page - 页数
@@ -7285,7 +7322,7 @@ declare class PCB_Document {
7285
7322
  offsetY: number;
7286
7323
  }>;
7287
7324
  /**
7288
- * 设置画��原点相对于数据原点的偏移坐标
7325
+ * 设置画布原点相对于数据原点的偏移坐标
7289
7326
  *
7290
7327
  * @public
7291
7328
  * @remarks
@@ -7827,7 +7864,7 @@ declare class PCB_Layer {
7827
7864
  * 新增自定义层
7828
7865
  *
7829
7866
  * @beta
7830
- * @returns 新增的自定义层的图层 ID,如若为 `undefined` 则为新增失败,可能是自定义层数量已达到上限
7867
+ * @returns 新增的自定义层的图层 ID,如若为 `undefined` 则为新增失败,可能��自定义层数量已达到上限
7831
7868
  */
7832
7869
  addCustomLayer(): Promise<TPCB_LayersOfCustom | undefined>;
7833
7870
  /**
@@ -8123,7 +8160,7 @@ declare class PCB_MathPolygon {
8123
8160
  */
8124
8161
  declare class PCB_Net {
8125
8162
  /**
8126
- * 获取所��网络的网络名称
8163
+ * 获取所有网络的网络名称
8127
8164
  *
8128
8165
  * @beta
8129
8166
  * @returns 网络名称数组
@@ -8154,22 +8191,8 @@ declare class PCB_Net {
8154
8191
  * @returns 操作是否成功
8155
8192
  */
8156
8193
  selectNet(net: string): Promise<boolean>;
8157
- /**
8158
- * 取消选中网络
8159
- *
8160
- * @beta
8161
- * @param net - 网络名称
8162
- * @returns 操作是否成功
8163
- */
8164
- unselectNet(net: string): Promise<boolean>;
8165
- /**
8166
- * 取消选中所有网络
8167
- *
8168
- * @beta
8169
- * @remarks 如果希望取消选中所有图元,请使用 {@link PCB_SelectControl.clearSelected} 接口
8170
- * @returns 操作是否成功
8171
- */
8172
- unselectAllNets(): Promise<boolean>;
8194
+ /* Excluded from this release type: unselectNet */
8195
+ /* Excluded from this release type: unselectAllNets */
8173
8196
  /**
8174
8197
  * 高亮网络
8175
8198
  *
@@ -8345,7 +8368,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
8345
8368
  * @param primitiveLock - 是否锁定
8346
8369
  * @param addIntoBom - 是否加入 BOM
8347
8370
  * @param designator - 位号
8348
- * @param name - 名称,`null` 表示留���
8371
+ * @param name - 名称,`null` 表示留空
8349
8372
  * @param uniqueId - 唯一 ID,`null` 表示留空
8350
8373
  * @param manufacturer - 制造商,`null` 表示留空
8351
8374
  * @param manufacturerId - 制造商编号,`null` 表示留空
@@ -8653,7 +8676,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
8653
8676
  * 获取直线
8654
8677
  *
8655
8678
  * @beta
8656
- * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传���的图元 ID 数量的图元对象
8679
+ * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
8657
8680
  * @param primitiveIds - 直线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
8658
8681
  * @returns 直线图元对象,空数组表示获取失败
8659
8682
  */
@@ -8896,7 +8919,7 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
8896
8919
  }
8897
8920
 
8898
8921
  /**
8899
- * PCB & 封装 / 区域图元类
8922
+ * PCB & 封装 / 禁止区域和约束区域图元类
8900
8923
  *
8901
8924
  * @public
8902
8925
  */
@@ -9010,7 +9033,13 @@ declare class PCB_SelectControl {
9010
9033
  * @returns 所有已选中图元的图元 ID
9011
9034
  */
9012
9035
  getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
9013
- /* Excluded from this release type: getAllSelectedPrimitives */
9036
+ /**
9037
+ * 查询所有已选中图元的图元对象
9038
+ *
9039
+ * @beta
9040
+ * @returns 所有已选中图元的图元对象
9041
+ */
9042
+ getAllSelectedPrimitives(): Promise<Array<IPCB_Primitive>>;
9014
9043
  /**
9015
9044
  * 查询选中图元的所有参数
9016
9045
  *
@@ -9045,7 +9074,16 @@ declare class PCB_SelectControl {
9045
9074
  * @returns 操作是否成功
9046
9075
  */
9047
9076
  clearSelected(): Promise<boolean>;
9048
- /* Excluded from this release type: getCurrentMousePosition */
9077
+ /**
9078
+ * 获取当前鼠标在画布上的位置
9079
+ *
9080
+ * @beta
9081
+ * @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
9082
+ */
9083
+ getCurrentMousePosition(): Promise<{
9084
+ x: number;
9085
+ y: number;
9086
+ } | undefined>;
9049
9087
  }
9050
9088
 
9051
9089
  /**
@@ -9439,7 +9477,7 @@ declare class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI {
9439
9477
  * @param centerY - 圆心 Y
9440
9478
  * @param radius - 半径
9441
9479
  * @param color - 颜色,`null` 表示默认
9442
- * @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
9480
+ * @param fillColor - 填充���色,`none` 表示无填充,`null` 表示默认
9443
9481
  * @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
9444
9482
  * @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
9445
9483
  * @returns 圆图元对象
@@ -10074,8 +10112,20 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
10074
10112
  * @remarks 获取或操作选择的元素
10075
10113
  */
10076
10114
  declare class SCH_SelectControl {
10077
- /* Excluded from this release type: getAllSelectedPrimitives_PrimitiveId */
10078
- /* Excluded from this release type: getAllSelectedPrimitives */
10115
+ /**
10116
+ * 查询所有已选中图元的图元 ID
10117
+ *
10118
+ * @beta
10119
+ * @returns 所有已选中图元的图元 ID
10120
+ */
10121
+ getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;
10122
+ /**
10123
+ * 查询所有已选中图元的图元对象
10124
+ *
10125
+ * @beta
10126
+ * @returns 所有已选中图元的图元对象
10127
+ */
10128
+ getAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;
10079
10129
  /**
10080
10130
  * 查询选中图元的图元 ID
10081
10131
  *
@@ -10119,7 +10169,16 @@ declare class SCH_SelectControl {
10119
10169
  * @returns 操作是否成功
10120
10170
  */
10121
10171
  clearSelected(): boolean;
10122
- /* Excluded from this release type: getCurrentMousePosition */
10172
+ /**
10173
+ * 获取当前鼠标在画布上的位置
10174
+ *
10175
+ * @beta
10176
+ * @returns 鼠标在画布上的位置,`undefined` 代表当前鼠标不在画布上
10177
+ */
10178
+ getCurrentMousePosition(): Promise<{
10179
+ x: number;
10180
+ y: number;
10181
+ } | undefined>;
10123
10182
  }
10124
10183
 
10125
10184
  /**
@@ -10243,7 +10302,7 @@ declare class SYS_Environment {
10243
10302
  */
10244
10303
  isProPrivateEdition(): boolean;
10245
10304
  /**
10246
- * 是��为在线模式
10305
+ * 是否为在线模式
10247
10306
  *
10248
10307
  * @public
10249
10308
  * @returns 是否为在线模式
@@ -10446,7 +10505,7 @@ declare class SYS_I18n {
10446
10505
  *
10447
10506
  * @public
10448
10507
  * @remarks
10449
- * 可以使用 `${1}` 格式的占位符��示参数;
10508
+ * 可以使用 `${1}` 格式的占位符表示参数;
10450
10509
  *
10451
10510
  * 语言优先级:当前显示语言 \> 系统默认语言 \> 数据集中第一个搜索到的包含该文本标签的语言 \> 文本标签(tag)
10452
10511
  * @param tag - 文本标签,对应多语言文件键值对中的键
@@ -10548,7 +10607,7 @@ declare class SYS_IFrame {
10548
10607
  * 关闭当前扩展打开的所有内联框架窗口;
10549
10608
  *
10550
10609
  * 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
10551
- * @param id - 内联框架窗口 ID,如若传入 `undefined`,将关闭由本扩展打��的所有内联框架窗口
10610
+ * @param id - 内联框架窗口 ID,如若传入 `undefined`,将关闭由本扩展打开的所有内联框架窗口
10552
10611
  * @returns 操作是否成功
10553
10612
  */
10554
10613
  closeIFrame(id?: string): Promise<boolean>;
@@ -10632,7 +10691,7 @@ declare class SYS_Log {
10632
10691
  * 查找条目
10633
10692
  *
10634
10693
  * @public
10635
- * @remarks 如果日志面板处于打开状态,查找操作会同时在前端展现
10694
+ * @remarks 如果日志面板处于打开状态,查找操���会同时在前端展现
10636
10695
  * @param message - 查找内容
10637
10696
  * @param types - 日志类型数组,可以在指定的日志类型内查找
10638
10697
  * @returns 符合查找条件的日志条目数组
@@ -10649,6 +10708,29 @@ declare class SYS_Log {
10649
10708
  }>, types?: ESYS_LogType | Array<ESYS_LogType>): Promise<Array<ISYS_LogLine>>;
10650
10709
  }
10651
10710
 
10711
+ /**
10712
+ * 系统 / 消息通知类
10713
+ *
10714
+ * @public
10715
+ * @remarks 生成各种对用户的非侵入式提醒
10716
+ */
10717
+ declare class SYS_Message {
10718
+ /**
10719
+ * 显示吐司消息
10720
+ *
10721
+ * @public
10722
+ * @param message - 消息内容
10723
+ * @param messageType - 消息类型
10724
+ * @param timer - 自动关闭倒计时秒数,`0` 为不自动关闭
10725
+ * @param bottomPanel - 展开底部信息面板
10726
+ * @param buttonTitle - 回调按钮标题
10727
+ * @param buttonCallbackFn - 回调函数内容,字符串形式,会被自动解析并执行
10728
+ */
10729
+ showToastMessage(message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string): void;
10730
+ /* Excluded from this release type: showFollowMouseTip */
10731
+ /* Excluded from this release type: removeFollowMouseTip */
10732
+ }
10733
+
10652
10734
  /**
10653
10735
  * 系统 / 消息框类
10654
10736
  *
@@ -10684,7 +10766,7 @@ declare class SYS_MessageBox {
10684
10766
  }
10685
10767
 
10686
10768
  /**
10687
- * ���统 / 面板控制类
10769
+ * 系统 / 面板控制类
10688
10770
  *
10689
10771
  * @public
10690
10772
  */
@@ -10826,7 +10908,7 @@ declare class SYS_Storage {
10826
10908
  * 获取扩展所有用户配置
10827
10909
  *
10828
10910
  * @public
10829
- * @remarks 注意:本接��仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
10911
+ * @remarks 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
10830
10912
  * @returns 扩展所有用户配置信息
10831
10913
  */
10832
10914
  getExtensionAllUserConfigs(): {
@@ -10861,7 +10943,7 @@ declare class SYS_Storage {
10861
10943
  * 获取扩展用户配置
10862
10944
  *
10863
10945
  * @public
10864
- * @remarks 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
10946
+ * @remarks 注意:本接口仅扩���有效,在独立脚本环境内调用将始终 `throw Error`
10865
10947
  * @param key - 配置项
10866
10948
  * @returns 配置项对应的值,不存在将返回 `undefined`
10867
10949
  */
@@ -10946,6 +11028,7 @@ declare class SYS_Timer {
10946
11028
  * 系统 / 吐司消息类
10947
11029
  *
10948
11030
  * @public
11031
+ * @deprecated 即将移除吐司消息类,合并入 {@link SYS_Message | 消息通知类}
10949
11032
  * @remarks 在屏幕的边缘弹出简短的消息提醒,会在一定时间后自动消除
10950
11033
  */
10951
11034
  declare class SYS_ToastMessage {
@@ -10953,6 +11036,7 @@ declare class SYS_ToastMessage {
10953
11036
  * 显示吐司消息
10954
11037
  *
10955
11038
  * @public
11039
+ * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代
10956
11040
  * @param message - 消息内容
10957
11041
  * @param messageType - 消息类型
10958
11042
  * @param timer - 自动关闭倒计时秒数,`0` 为不自动关闭
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.105",
3
+ "version": "0.1.107",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [