@jlceda/pro-api-types 0.1.108 → 0.1.109

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 +52 -32
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -3629,14 +3629,14 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3629
3629
  * @public
3630
3630
  * @returns BBox 左上点坐标 X
3631
3631
  */
3632
- getState_X(): number;
3632
+ getState_X(): number | undefined;
3633
3633
  /**
3634
3634
  * 获取属性状态:BBox 左上点坐标 Y
3635
3635
  *
3636
3636
  * @public
3637
3637
  * @returns BBox 左上点坐标 Y
3638
3638
  */
3639
- getState_Y(): number;
3639
+ getState_Y(): number | undefined;
3640
3640
  /**
3641
3641
  * 获取属性状态:图像源数据(复杂多边形)
3642
3642
  *
@@ -3650,42 +3650,42 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3650
3650
  * @public
3651
3651
  * @returns 层
3652
3652
  */
3653
- getState_Layer(): TPCB_LayersOfImage;
3653
+ getState_Layer(): TPCB_LayersOfImage | undefined;
3654
3654
  /**
3655
3655
  * 获取属性状态:宽
3656
3656
  *
3657
3657
  * @public
3658
3658
  * @returns 宽
3659
3659
  */
3660
- getState_Width(): number;
3660
+ getState_Width(): number | undefined;
3661
3661
  /**
3662
3662
  * 获取属性状态:高
3663
3663
  *
3664
3664
  * @public
3665
3665
  * @returns 高
3666
3666
  */
3667
- getState_Height(): number;
3667
+ getState_Height(): number | undefined;
3668
3668
  /**
3669
3669
  * 获取属性状态:旋转角度
3670
3670
  *
3671
3671
  * @public
3672
3672
  * @returns 旋转角度
3673
3673
  */
3674
- getState_Rotation(): number;
3674
+ getState_Rotation(): number | undefined;
3675
3675
  /**
3676
3676
  * 获取属性状态:是否水平镜像
3677
3677
  *
3678
3678
  * @public
3679
3679
  * @returns 是否水平镜像
3680
3680
  */
3681
- getState_HorizonMirror(): boolean;
3681
+ getState_HorizonMirror(): boolean | undefined;
3682
3682
  /**
3683
3683
  * 获取属性状态:是否锁定
3684
3684
  *
3685
3685
  * @public
3686
3686
  * @returns 是否锁定
3687
3687
  */
3688
- getState_PrimitiveLock(): boolean;
3688
+ getState_PrimitiveLock(): boolean | undefined;
3689
3689
  /**
3690
3690
  * 设置属性状态:BBox 左上点坐标 X
3691
3691
  *
@@ -3693,7 +3693,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3693
3693
  * @param x - BBox 左上点坐标 X
3694
3694
  * @returns 图像图元对象
3695
3695
  */
3696
- setState_X(x: number): IPCB_PrimitiveImage;
3696
+ setState_X(x: number | undefined): IPCB_PrimitiveImage;
3697
3697
  /**
3698
3698
  * 设置属性状态:BBox 左上点坐标 Y
3699
3699
  *
@@ -3701,7 +3701,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3701
3701
  * @param y - BBox 左上点坐标 Y
3702
3702
  * @returns 图像图元对象
3703
3703
  */
3704
- setState_Y(y: number): IPCB_PrimitiveImage;
3704
+ setState_Y(y: number | undefined): IPCB_PrimitiveImage;
3705
3705
  /**
3706
3706
  * 设置属性状态:层
3707
3707
  *
@@ -3709,7 +3709,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3709
3709
  * @param layer - 层
3710
3710
  * @returns 图像图元对象
3711
3711
  */
3712
- setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveImage;
3712
+ setState_Layer(layer: TPCB_LayersOfImage | undefined): IPCB_PrimitiveImage;
3713
3713
  /**
3714
3714
  * 设置属性状态:宽
3715
3715
  *
@@ -3717,7 +3717,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3717
3717
  * @param width - 宽
3718
3718
  * @returns 图像图元对象
3719
3719
  */
3720
- setState_Width(width: number): IPCB_PrimitiveImage;
3720
+ setState_Width(width: number | undefined): IPCB_PrimitiveImage;
3721
3721
  /**
3722
3722
  * 设置属性状态:高
3723
3723
  *
@@ -3725,7 +3725,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3725
3725
  * @param height - 高
3726
3726
  * @returns 图像图元对象
3727
3727
  */
3728
- setState_Height(height: number): IPCB_PrimitiveImage;
3728
+ setState_Height(height: number | undefined): IPCB_PrimitiveImage;
3729
3729
  /**
3730
3730
  * 设置属性状态:旋转角度
3731
3731
  *
@@ -3733,7 +3733,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3733
3733
  * @param rotation - 旋转角度
3734
3734
  * @returns 图像图元对象
3735
3735
  */
3736
- setState_Rotation(rotation: number): IPCB_PrimitiveImage;
3736
+ setState_Rotation(rotation: number | undefined): IPCB_PrimitiveImage;
3737
3737
  /**
3738
3738
  * 设置属性状态:是否水平镜像
3739
3739
  *
@@ -3741,7 +3741,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3741
3741
  * @param horizonMirror - 是否水平镜像
3742
3742
  * @returns 图像图元对象
3743
3743
  */
3744
- setState_HorizonMirror(horizonMirror: boolean): IPCB_PrimitiveImage;
3744
+ setState_HorizonMirror(horizonMirror: boolean | undefined): IPCB_PrimitiveImage;
3745
3745
  /**
3746
3746
  * 设置属性状态:是否锁定
3747
3747
  *
@@ -3749,7 +3749,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3749
3749
  * @param primitiveLock - 是否锁定
3750
3750
  * @returns 图像图元对象
3751
3751
  */
3752
- setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;
3752
+ setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveImage;
3753
3753
  /**
3754
3754
  * 将图元转换为异步图元
3755
3755
  *
@@ -4067,7 +4067,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4067
4067
  */
4068
4068
  getState_TopLeftX(): number | undefined;
4069
4069
  /**
4070
- * 获取属性状态:左上点 Y
4070
+ * 获取属性状态:左上�� Y
4071
4071
  *
4072
4072
  * @public
4073
4073
  * @returns 左上点 Y
@@ -4392,7 +4392,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4392
4392
  */
4393
4393
  getState_Metallization(): boolean;
4394
4394
  /**
4395
- * ���取属性状态:焊盘功能
4395
+ * 获取属性状态:焊盘功能
4396
4396
  *
4397
4397
  * @public
4398
4398
  * @returns 焊盘功能
@@ -7102,7 +7102,6 @@ declare class LIB_Footprint {
7102
7102
  * @returns 封装 UUID
7103
7103
  */
7104
7104
  create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
7105
- /* Excluded from this release type: createByDocumentSource */
7106
7105
  /**
7107
7106
  * 删除封装
7108
7107
  *
@@ -7125,6 +7124,7 @@ declare class LIB_Footprint {
7125
7124
  * @returns 操作是否成功
7126
7125
  */
7127
7126
  modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
7127
+ /* Excluded from this release type: updateDocumentSource */
7128
7128
  /**
7129
7129
  * 获取封装的所有属性
7130
7130
  *
@@ -7174,7 +7174,7 @@ declare class LIB_Footprint {
7174
7174
  * 综合库 / 库列表类
7175
7175
  *
7176
7176
  * @public
7177
- * @remarks 此处所有接口都基于编辑器当前工作区环境,如需切换到其他工作区,请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
7177
+ * @remarks 此处所有���口都基于编辑器当前工作区环境,如需切换到其他工作区,请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
7178
7178
  */
7179
7179
  declare class LIB_LibrariesList {
7180
7180
  /**
@@ -7320,7 +7320,6 @@ declare class LIB_Symbol {
7320
7320
  * @returns 符号 UUID
7321
7321
  */
7322
7322
  create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
7323
- /* Excluded from this release type: createByDocumentSource */
7324
7323
  /**
7325
7324
  * 删除符号
7326
7325
  *
@@ -7343,6 +7342,7 @@ declare class LIB_Symbol {
7343
7342
  * @returns 操作是否成功
7344
7343
  */
7345
7344
  modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
7345
+ /* Excluded from this release type: updateDocumentSource */
7346
7346
  /**
7347
7347
  * 获取符号的所有属性
7348
7348
  *
@@ -7365,7 +7365,7 @@ declare class LIB_Symbol {
7365
7365
  */
7366
7366
  copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newSymbolName?: string): Promise<string | undefined>;
7367
7367
  /**
7368
- * 搜索符号
7368
+ * 搜索���号
7369
7369
  *
7370
7370
  * @beta
7371
7371
  * @param key - 搜索关键字
@@ -7474,7 +7474,7 @@ declare class PCB_Document {
7474
7474
  * 输入画布坐标返回该坐标对应的数据坐标
7475
7475
  *
7476
7476
  * @public
7477
- * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点;嘉立�� EDA API 使用的均为数据原点;在创建 PCB 时,默认画布原点等于数据原点
7477
+ * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点;嘉立创 EDA API 使用的均为数据原点;在创建 PCB 时,默认画布原点等于数据原点
7478
7478
  * @param canvasOriginX - 画布原点 X
7479
7479
  * @param canvasOriginY - 画布原点 Y
7480
7480
  * @returns 数据原点坐标
@@ -7568,7 +7568,7 @@ declare class PCB_Drc {
7568
7568
  * @public
7569
7569
  * @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false`,否则返回 `true`
7570
7570
  * @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
7571
- * @returns DRC 检查是否无错误
7571
+ * @returns DRC ���查是否无错误
7572
7572
  */
7573
7573
  check(strict?: boolean, userInterface?: boolean): Promise<boolean>;
7574
7574
  /**
@@ -7668,7 +7668,7 @@ declare class PCB_Drc {
7668
7668
  * 覆写网络规则
7669
7669
  *
7670
7670
  * @beta
7671
- * @remarks 将会覆写当前 PCB 的所有网络规则,请注意数据丢失风险
7671
+ * @remarks 将会覆写当前 PCB 的所有网络规则,请注意数据丢失��险
7672
7672
  * @param netRules - 网络规则
7673
7673
  * @returns 覆写是否成功
7674
7674
  */
@@ -8043,7 +8043,7 @@ declare class PCB_Layer {
8043
8043
  *
8044
8044
  * @beta
8045
8045
  * @remarks
8046
- * 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板���将会新增 FPC 补强层图层。
8046
+ * 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC 补强层图层。
8047
8047
  *
8048
8048
  * 请注意:
8049
8049
  *
@@ -9100,7 +9100,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
9100
9100
  * 获取直线
9101
9101
  *
9102
9102
  * @beta
9103
- * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9103
+ * @remarks 如若��入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9104
9104
  * @param primitiveIds - 直线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9105
9105
  * @returns 直线图元对象,空数组表示获取失败
9106
9106
  */
@@ -10024,7 +10024,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
10024
10024
  *
10025
10025
  * @beta
10026
10026
  * @param busName - 总线名称
10027
- * @param line - 多段线坐标组,每段都是连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线,如若多段线彼此无任何连接则创建将会失败
10027
+ * @param line - 多段线坐标组,每段都是连续的��组 `[x1, y1, x2, y2, x3, y3]` 所描述的线,如若多段线彼此无任何连接则创建将会失败
10028
10028
  * @param color - 总线颜色,`null` 表示默认
10029
10029
  * @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
10030
10030
  * @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
@@ -11073,7 +11073,7 @@ declare class SYS_FileSystem {
11073
11073
  *
11074
11074
  * @beta
11075
11075
  * @param filenameExtensions - 文件扩展名
11076
- * @returns File 格式��件
11076
+ * @returns File 格式文件
11077
11077
  */
11078
11078
  openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
11079
11079
  /**
@@ -11248,8 +11248,28 @@ declare class SYS_IFrame {
11248
11248
  * @returns 操作是否成功
11249
11249
  */
11250
11250
  closeIFrame(id?: string): Promise<boolean>;
11251
- /* Excluded from this release type: hideIFrame */
11252
- /* Excluded from this release type: showIFrame */
11251
+ /**
11252
+ * 隐藏内联框架窗口
11253
+ *
11254
+ * @beta
11255
+ * @remarks 本接口为结果导向的:
11256
+ * 如若未找到指定内联框架窗口,接口将会返回 `false`;
11257
+ * 如若在执行操作前该内联框架窗口已处于隐藏状态,接口将会返回 `true`
11258
+ * @param id - 内联框架窗口 ID
11259
+ * @returns 操作是否成功
11260
+ */
11261
+ hideIFrame(id?: string): Promise<boolean>;
11262
+ /**
11263
+ * 显示内联框架窗口
11264
+ *
11265
+ * @beta
11266
+ * @remarks 本接口为结果导向的:
11267
+ * 如若未找到指定内联框架窗口,接口将会返回 `false`;
11268
+ * 如若在执行操作前该内联框架窗口已处于显示状态,接口将会返回 `true`
11269
+ * @param id - 内联框架窗口 ID
11270
+ * @returns 操作是否成功
11271
+ */
11272
+ showIFrame(id?: string): Promise<boolean>;
11253
11273
  }
11254
11274
 
11255
11275
  /**
@@ -11670,7 +11690,7 @@ declare class SYS_Timer {
11670
11690
  */
11671
11691
  declare class SYS_ToastMessage {
11672
11692
  /**
11673
- * 显示吐司消息
11693
+ * 显��吐司消息
11674
11694
  *
11675
11695
  * @public
11676
11696
  * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.108",
3
+ "version": "0.1.109",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [