@jlceda/pro-api-types 0.1.111 → 0.1.112

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 +246 -78
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -418,7 +418,7 @@ declare class DMT_Project {
418
418
  *
419
419
  * @beta
420
420
  * @param projectFriendlyName - 工程友好名称
421
- * @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生��
421
+ * @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生成
422
422
  * @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
423
423
  * @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
424
424
  * @param description - 工程描述
@@ -505,7 +505,7 @@ declare class DMT_Schematic {
505
505
  * 修改原理图名称
506
506
  *
507
507
  * @beta
508
- * @remarks 如若原理图已关联复用模块(在工程库内存在同名的复用模块符号),则修改名称时将同步修改复用模块符号名称与关联 PCB 名称
508
+ * @remarks 如若原理图已关联复用模块(在工程库内存在同名的复用模块符号),则修改名称时将同步修改复用模块符号名称与关联 PCB ���称
509
509
  * @param schematicUuid - 原理图 UUID
510
510
  * @param schematicName - 原理图名称
511
511
  * @returns 是否修改成功
@@ -1186,7 +1186,7 @@ declare enum EPCB_LayerId {
1186
1186
  CUSTOM_28 = 98,
1187
1187
  /** 自定义层 29 */
1188
1188
  CUSTOM_29 = 99,
1189
- /** ���定义层 30 */
1189
+ /** ��定义层 30 */
1190
1190
  CUSTOM_30 = 100,
1191
1191
  /** 夹层(介电基板)1 */
1192
1192
  SUBSTRATE_1 = 101,
@@ -1918,7 +1918,7 @@ declare interface IDMT_ProjectItem extends IDMT_BriefProjectItem {
1918
1918
  description?: string;
1919
1919
  /** 工程内文档数据 */
1920
1920
  data: Array<IDMT_BoardItem | IDMT_SchematicItem | IDMT_PcbItem | IDMT_PanelItem>;
1921
- /** 工��协作模式 */
1921
+ /** 工程协作模式 */
1922
1922
  collaborationMode?: EDMT_ProjectCollaborationMode;
1923
1923
  }
1924
1924
 
@@ -2113,12 +2113,36 @@ declare interface ILIB_ClassificationIndex {
2113
2113
  * @public
2114
2114
  */
2115
2115
  declare interface ILIB_DeviceAssociationItem {
2116
- /** 符号类型 */
2116
+ /**
2117
+ * 符号类型
2118
+ *
2119
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.symbol | symbol} 替代
2120
+ */
2117
2121
  symbolType: ELIB_SymbolType;
2118
- /** 符号 UUID */
2122
+ /**
2123
+ * 符号 UUID
2124
+ *
2125
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.symbol | symbol} 替代
2126
+ */
2119
2127
  symbolUuid: string;
2120
- /** 封装 UUID */
2121
- footprintUuid?: string;
2128
+ /** 符号 */
2129
+ symbol: {
2130
+ type: ELIB_SymbolType;
2131
+ uuid: string;
2132
+ libraryUuid: string;
2133
+ };
2134
+ /**
2135
+ * 封装 UUID
2136
+ *
2137
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.footprint | footprint} 替代
2138
+ */
2139
+ footprintUuid: string;
2140
+ /** 封装 */
2141
+ footprint?: {
2142
+ uuid: string;
2143
+ libraryUuid: string;
2144
+ };
2145
+ images?: Array<string>;
2122
2146
  }
2123
2147
 
2124
2148
  /**
@@ -2145,8 +2169,10 @@ declare interface ILIB_DeviceExtendPropertyItem {
2145
2169
  supplier?: string;
2146
2170
  /** 供应商编号 */
2147
2171
  supplierId?: string;
2148
- /** 其它 */
2149
- [key: string]: boolean | number | string | undefined;
2172
+ /** 其它参数 */
2173
+ otherProperty?: {
2174
+ [key: string]: boolean | number | string | undefined;
2175
+ };
2150
2176
  }
2151
2177
 
2152
2178
  /**
@@ -2215,18 +2241,60 @@ declare interface ILIB_DeviceSearchItem {
2215
2241
  ordinal: number;
2216
2242
  /** 器件名称 */
2217
2243
  name: string;
2218
- /** 关联符号名称 */
2244
+ /**
2245
+ * 关联符号名称
2246
+ *
2247
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.symbol | symbol} 替代
2248
+ */
2219
2249
  symbolName: string;
2220
- /** 关联符号 UUID */
2250
+ /**
2251
+ * 关联符号 UUID
2252
+ *
2253
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.symbol | symbol} 替代
2254
+ */
2221
2255
  symbolUuid: string;
2222
- /** 关联封装名称 */
2256
+ /** 关联符号 */
2257
+ symbol: {
2258
+ name: string;
2259
+ uuid: string;
2260
+ libraryUuid: string;
2261
+ };
2262
+ /**
2263
+ * 关联封装名称
2264
+ *
2265
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.footprint | footprint} 替代
2266
+ */
2223
2267
  footprintName?: string;
2224
- /** 关联封装 UUID */
2225
- footprintUuid?: string;
2226
- /** 关联 3D 模型名称 */
2268
+ /**
2269
+ * 关联封装 UUID
2270
+ *
2271
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.footprint | footprint} 替代
2272
+ */
2273
+ footprintUuid: string;
2274
+ /** 关联封装 */
2275
+ footprint?: {
2276
+ name: string;
2277
+ uuid: string;
2278
+ libraryUuid: string;
2279
+ };
2280
+ /**
2281
+ * 关联 3D 模型名称
2282
+ *
2283
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.model3D | model3D} 替代
2284
+ */
2227
2285
  model3DName?: string;
2228
- /** 关联 3D 模型 UUID */
2229
- model3DUuid?: string;
2286
+ /**
2287
+ * 关联 3D 模型 UUID
2288
+ *
2289
+ * @deprecated 请使用 {@link ILIB_DeviceSearchItem.model3D | model3D} 替代
2290
+ */
2291
+ model3DUuid: string;
2292
+ /** 关联 3D 模型 */
2293
+ model3D?: {
2294
+ name: string;
2295
+ uuid: string;
2296
+ libraryUuid: string;
2297
+ };
2230
2298
  /** 关联图片 UUID */
2231
2299
  imageUuid?: string;
2232
2300
  /** 描述 */
@@ -2434,7 +2502,7 @@ declare class IPCB_ComplexPolygon {
2434
2502
  */
2435
2503
  getSource(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;
2436
2504
  /**
2437
- * 获��复杂多边形数据
2505
+ * 获取复杂多边形数据
2438
2506
  *
2439
2507
  * @public
2440
2508
  * @remarks 强制返回复杂多边形格式数据,即使它仅包含单一的单多边形
@@ -2838,9 +2906,18 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
2838
2906
  * 获取整段导线
2839
2907
  *
2840
2908
  * @beta
2909
+ * @param includeVias - 是否包含导线两端的过孔
2841
2910
  * @returns 整段导线内的所有直线和圆弧线
2842
2911
  */
2843
- getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
2912
+ getEntireTrack(includeVias: false): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
2913
+ /**
2914
+ * 获取整段导线
2915
+ *
2916
+ * @beta
2917
+ * @param includeVias - 是否包含导线两端的过孔
2918
+ * @returns 整段导线内的所有直线、圆弧线,以及两端连接的过孔(如果有)
2919
+ */
2920
+ getEntireTrack(includeVias: true): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;
2844
2921
  }
2845
2922
 
2846
2923
  /**
@@ -3033,7 +3110,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
3033
3110
  */
3034
3111
  getState_Supplier(): string | undefined;
3035
3112
  /**
3036
- * 获取属性状态:供应商编号
3113
+ * 获取属���状态:供应商编号
3037
3114
  *
3038
3115
  * @public
3039
3116
  * @returns 供应商编号
@@ -3184,7 +3261,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
3184
3261
  */
3185
3262
  isAsync(): boolean;
3186
3263
  /**
3187
- * 将异步图元重置为当前画布状态
3264
+ * 将异���图元重置为当前画布状态
3188
3265
  *
3189
3266
  * @beta
3190
3267
  * @returns 器件图元对象
@@ -3231,6 +3308,8 @@ declare class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad {
3231
3308
  * @returns 器件焊盘图元对象
3232
3309
  */
3233
3310
  done(): Promise<IPCB_PrimitiveComponentPad>;
3311
+ /* Excluded from this release type: getConnectedPrimitives */
3312
+ getConnectedPrimitives(onlyCentreConnection: false): Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia | IPCB_PrimitivePolyline | IPCB_PrimitiveFill>;
3234
3313
  }
3235
3314
 
3236
3315
  /**
@@ -3722,7 +3801,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3722
3801
  * @public
3723
3802
  * @returns 是否锁定
3724
3803
  */
3725
- getState_PrimitiveLock(): boolean | undefined;
3804
+ getState_PrimitiveLock(): boolean;
3726
3805
  /**
3727
3806
  * 设置属性状态:BBox 左上点坐标 X
3728
3807
  *
@@ -3730,7 +3809,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3730
3809
  * @param x - BBox 左上点坐标 X
3731
3810
  * @returns 图像图元对象
3732
3811
  */
3733
- setState_X(x: number | undefined): IPCB_PrimitiveImage;
3812
+ setState_X(x: number): IPCB_PrimitiveImage;
3734
3813
  /**
3735
3814
  * 设置属性状态:BBox 左上点坐标 Y
3736
3815
  *
@@ -3738,7 +3817,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3738
3817
  * @param y - BBox 左上点坐标 Y
3739
3818
  * @returns 图像图元对象
3740
3819
  */
3741
- setState_Y(y: number | undefined): IPCB_PrimitiveImage;
3820
+ setState_Y(y: number): IPCB_PrimitiveImage;
3742
3821
  /**
3743
3822
  * 设置属性状态:层
3744
3823
  *
@@ -3746,7 +3825,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3746
3825
  * @param layer - 层
3747
3826
  * @returns 图像图元对象
3748
3827
  */
3749
- setState_Layer(layer: TPCB_LayersOfImage | undefined): IPCB_PrimitiveImage;
3828
+ setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveImage;
3750
3829
  /**
3751
3830
  * 设置属性状态:宽
3752
3831
  *
@@ -3754,7 +3833,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3754
3833
  * @param width - 宽
3755
3834
  * @returns 图像图元对象
3756
3835
  */
3757
- setState_Width(width: number | undefined): IPCB_PrimitiveImage;
3836
+ setState_Width(width: number): IPCB_PrimitiveImage;
3758
3837
  /**
3759
3838
  * 设置属性状态:高
3760
3839
  *
@@ -3762,7 +3841,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3762
3841
  * @param height - 高
3763
3842
  * @returns 图像图元对象
3764
3843
  */
3765
- setState_Height(height: number | undefined): IPCB_PrimitiveImage;
3844
+ setState_Height(height: number): IPCB_PrimitiveImage;
3766
3845
  /**
3767
3846
  * 设置属性状态:旋转角度
3768
3847
  *
@@ -3770,7 +3849,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3770
3849
  * @param rotation - 旋转角度
3771
3850
  * @returns 图像图元对象
3772
3851
  */
3773
- setState_Rotation(rotation: number | undefined): IPCB_PrimitiveImage;
3852
+ setState_Rotation(rotation: number): IPCB_PrimitiveImage;
3774
3853
  /**
3775
3854
  * 设置属性状态:是否水平镜像
3776
3855
  *
@@ -3778,7 +3857,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3778
3857
  * @param horizonMirror - 是否水平镜像
3779
3858
  * @returns 图像图元对象
3780
3859
  */
3781
- setState_HorizonMirror(horizonMirror: boolean | undefined): IPCB_PrimitiveImage;
3860
+ setState_HorizonMirror(horizonMirror: boolean): IPCB_PrimitiveImage;
3782
3861
  /**
3783
3862
  * 设置属性状态:是否锁定
3784
3863
  *
@@ -3786,7 +3865,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
3786
3865
  * @param primitiveLock - 是否锁定
3787
3866
  * @returns 图像图元对象
3788
3867
  */
3789
- setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveImage;
3868
+ setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;
3790
3869
  /**
3791
3870
  * 将图元转换为异步图元
3792
3871
  *
@@ -3978,7 +4057,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
3978
4057
  *
3979
4058
  * @beta
3980
4059
  * @param lineWidth - 线宽
3981
- * @returns 直线图元对象
4060
+ * @returns 直线图元对���
3982
4061
  */
3983
4062
  setState_LineWidth(lineWidth: number): IPCB_PrimitiveLine;
3984
4063
  /**
@@ -4036,9 +4115,18 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
4036
4115
  * 获取整段导线
4037
4116
  *
4038
4117
  * @beta
4118
+ * @param includeVias - 是否包含导线两端的过孔
4039
4119
  * @returns 整段导线内的所有直线和圆弧线
4040
4120
  */
4041
- getEntireTrack(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
4121
+ getEntireTrack(includeVias: false): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
4122
+ /**
4123
+ * 获取整段导线
4124
+ *
4125
+ * @beta
4126
+ * @param includeVias - 是否包含导线两端的过孔
4127
+ * @returns 整段导线内的所有直线、圆弧线,以及两端连接的过孔(如果有)
4128
+ */
4129
+ getEntireTrack(includeVias: true): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;
4042
4130
  }
4043
4131
 
4044
4132
  /**
@@ -4065,7 +4153,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4065
4153
  private width;
4066
4154
  /** 高 */
4067
4155
  private height;
4068
- /** 旋���角度 */
4156
+ /** 旋转角度 */
4069
4157
  private rotation;
4070
4158
  /** 是否水平镜像 */
4071
4159
  private mirror;
@@ -4123,42 +4211,42 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4123
4211
  * @public
4124
4212
  * @returns 宽
4125
4213
  */
4126
- getState_Width(): number | undefined;
4214
+ getState_Width(): number;
4127
4215
  /**
4128
4216
  * 获取属性状态:高
4129
4217
  *
4130
4218
  * @public
4131
4219
  * @returns 高
4132
4220
  */
4133
- getState_Height(): number | undefined;
4221
+ getState_Height(): number;
4134
4222
  /**
4135
4223
  * 获取属性状态:旋转角度
4136
4224
  *
4137
4225
  * @public
4138
4226
  * @returns 旋转角度
4139
4227
  */
4140
- getState_Rotation(): number | undefined;
4228
+ getState_Rotation(): number;
4141
4229
  /**
4142
4230
  * 获取属性状态:是否水平镜像
4143
4231
  *
4144
4232
  * @public
4145
4233
  * @returns 是否水平镜像
4146
4234
  */
4147
- getState_Mirror(): boolean | undefined;
4235
+ getState_Mirror(): boolean;
4148
4236
  /**
4149
4237
  * 获取属性状态:文件名
4150
4238
  *
4151
4239
  * @public
4152
4240
  * @returns 文件名
4153
4241
  */
4154
- getState_FileName(): string | undefined;
4242
+ getState_FileName(): string;
4155
4243
  /**
4156
4244
  * 获取属性状态:是否锁定
4157
4245
  *
4158
4246
  * @public
4159
4247
  * @returns 是否锁定
4160
4248
  */
4161
- getState_PrimitiveLock(): boolean | undefined;
4249
+ getState_PrimitiveLock(): boolean;
4162
4250
  /**
4163
4251
  * 设置属性状态:层
4164
4252
  *
@@ -4166,7 +4254,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4166
4254
  * @param layer - 层
4167
4255
  * @returns 二进制内嵌对象图元对象
4168
4256
  */
4169
- setState_Layer(layer: TPCB_LayersOfObject | undefined): IPCB_PrimitiveObject;
4257
+ setState_Layer(layer: TPCB_LayersOfObject): IPCB_PrimitiveObject;
4170
4258
  /**
4171
4259
  * 设置属性状态:左上点 X
4172
4260
  *
@@ -4174,7 +4262,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4174
4262
  * @param topLeftX - 左上点 X
4175
4263
  * @returns 二进制内嵌对象图元对象
4176
4264
  */
4177
- setState_TopLeftX(topLeftX: number | undefined): IPCB_PrimitiveObject;
4265
+ setState_TopLeftX(topLeftX: number): IPCB_PrimitiveObject;
4178
4266
  /**
4179
4267
  * 设置属性状态:左上点 Y
4180
4268
  *
@@ -4182,7 +4270,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4182
4270
  * @param topLeftY - 左上点 Y
4183
4271
  * @returns 二进制内嵌对象图元对象
4184
4272
  */
4185
- setState_TopLeftY(topLeftY: number | undefined): IPCB_PrimitiveObject;
4273
+ setState_TopLeftY(topLeftY: number): IPCB_PrimitiveObject;
4186
4274
  /**
4187
4275
  * 设置属性状态:二进制数据
4188
4276
  *
@@ -4198,7 +4286,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4198
4286
  * @param width - 宽
4199
4287
  * @returns 二进制内嵌对象图元对象
4200
4288
  */
4201
- setState_Width(width: number | undefined): IPCB_PrimitiveObject;
4289
+ setState_Width(width: number): IPCB_PrimitiveObject;
4202
4290
  /**
4203
4291
  * 设置属性状态:高
4204
4292
  *
@@ -4206,7 +4294,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4206
4294
  * @param height - 高
4207
4295
  * @returns 二进制内嵌对象图元对象
4208
4296
  */
4209
- setState_Height(height: number | undefined): IPCB_PrimitiveObject;
4297
+ setState_Height(height: number): IPCB_PrimitiveObject;
4210
4298
  /**
4211
4299
  * 设置属性状态:旋转角度
4212
4300
  *
@@ -4214,7 +4302,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4214
4302
  * @param rotation - 旋转角度
4215
4303
  * @returns 二进制内嵌对象图元对象
4216
4304
  */
4217
- setState_Rotation(rotation: number | undefined): IPCB_PrimitiveObject;
4305
+ setState_Rotation(rotation: number): IPCB_PrimitiveObject;
4218
4306
  /**
4219
4307
  * 设置属性状态:是否水平镜像
4220
4308
  *
@@ -4222,7 +4310,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4222
4310
  * @param mirror - 是否水平镜像
4223
4311
  * @returns 二进制内嵌对象图元对象
4224
4312
  */
4225
- setState_Mirror(mirror: boolean | undefined): IPCB_PrimitiveObject;
4313
+ setState_Mirror(mirror: boolean): IPCB_PrimitiveObject;
4226
4314
  /**
4227
4315
  * 设置属性状态:文件名
4228
4316
  *
@@ -4230,7 +4318,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4230
4318
  * @param fileName - 文件名
4231
4319
  * @returns 二进制内嵌对象图元对象
4232
4320
  */
4233
- setState_FileName(fileName: string | undefined): IPCB_PrimitiveObject;
4321
+ setState_FileName(fileName: string): IPCB_PrimitiveObject;
4234
4322
  /**
4235
4323
  * 设置属性状态:是否锁定
4236
4324
  *
@@ -4238,7 +4326,7 @@ declare class IPCB_PrimitiveObject implements IPCB_Primitive {
4238
4326
  * @param primitiveLock - 是否锁定
4239
4327
  * @returns 二进制内嵌对象图元对象
4240
4328
  */
4241
- setState_PrimitiveLock(primitiveLock: boolean | undefined): IPCB_PrimitiveObject;
4329
+ setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveObject;
4242
4330
  /**
4243
4331
  * 将图元转换为异步图元
4244
4332
  *
@@ -4513,7 +4601,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4513
4601
  */
4514
4602
  setState_Rotation(rotation: number): IPCB_PrimitivePad;
4515
4603
  /**
4516
- * 设置属性状��:焊盘外形
4604
+ * 设置属性状态:焊盘外形
4517
4605
  *
4518
4606
  * @beta
4519
4607
  * @remarks
@@ -4638,7 +4726,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
4638
4726
  */
4639
4727
  toAsync(): IPCB_PrimitivePad;
4640
4728
  /**
4641
- * ���图元转换为同步图元
4729
+ * 将图元转换为同步图元
4642
4730
  *
4643
4731
  * @public
4644
4732
  * @returns 焊盘图元对象
@@ -7004,7 +7092,7 @@ declare class LIB_Device {
7004
7092
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
7005
7093
  * @param deviceName - 器件名称
7006
7094
  * @param classification - 分类
7007
- * @param association - 关联符号、封装、图像,指定 `symbolType` 则创建新符号,无需新建符号则无需指定 `symbolType`,但请注意,如若不新建符号也不指定符号的 UUID 将无法创建器件
7095
+ * @param association - 关联符号、封装、图像,指定 `symbolType` 则创建新符号,无需新建符号则无需指定 `symbolType`,但请注意,如若不新建符号也不指定符号的关联信息将无法创建器件
7008
7096
  * @param description - 描述
7009
7097
  * @param property - 其它参数,仅 `designator`、`addIntoBom`、`addIntoPcb` 存在默认值
7010
7098
  * @returns 器件 UUID
@@ -7012,14 +7100,27 @@ declare class LIB_Device {
7012
7100
  create(libraryUuid: string, deviceName: string, classification?: ILIB_ClassificationIndex, association?: {
7013
7101
  symbolType?: ELIB_SymbolType;
7014
7102
  symbolUuid?: string;
7103
+ symbol?: {
7104
+ uuid: string;
7105
+ libraryUuid: string;
7106
+ };
7015
7107
  footprintUuid?: string;
7108
+ footprint?: {
7109
+ uuid: string;
7110
+ libraryUuid: string;
7111
+ };
7112
+ model3D?: {
7113
+ uuid: string;
7114
+ libraryUuid: string;
7115
+ };
7116
+ imageData?: File | Blob;
7016
7117
  }, description?: string, property?: ILIB_DeviceExtendPropertyItem): Promise<string | undefined>;
7017
7118
  /**
7018
7119
  * 删除器件
7019
7120
  *
7020
7121
  * @beta
7021
- * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
7022
7122
  * @param deviceUuid - 器件 UUID
7123
+ * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
7023
7124
  * @returns 操作是否成功
7024
7125
  */
7025
7126
  delete(deviceUuid: string, libraryUuid: string): Promise<boolean>;
@@ -7039,8 +7140,20 @@ declare class LIB_Device {
7039
7140
  */
7040
7141
  modify(deviceUuid: string, libraryUuid: string, deviceName?: string, classification?: ILIB_ClassificationIndex | null, association?: {
7041
7142
  symbolUuid?: string;
7143
+ symbol?: {
7144
+ uuid: string;
7145
+ libraryUuid: string;
7146
+ };
7042
7147
  footprintUuid?: string | null;
7043
- imageData?: Blob | null;
7148
+ footprint?: {
7149
+ uuid: string;
7150
+ libraryUuid: string;
7151
+ } | null;
7152
+ model3D?: {
7153
+ uuid: string;
7154
+ libraryUuid: string;
7155
+ } | null;
7156
+ imageData?: File | Blob | null;
7044
7157
  }, description?: string | null, property?: {
7045
7158
  name?: string | null;
7046
7159
  designator?: string;
@@ -7051,7 +7164,9 @@ declare class LIB_Device {
7051
7164
  manufacturerId?: string | null;
7052
7165
  supplier?: string | null;
7053
7166
  supplierId?: string | null;
7054
- [key: string]: boolean | number | string | undefined | null;
7167
+ otherProperty?: {
7168
+ [key: string]: boolean | number | string | undefined | null;
7169
+ };
7055
7170
  }): Promise<boolean>;
7056
7171
  /**
7057
7172
  * 获取器件的所有属性
@@ -7100,7 +7215,7 @@ declare class LIB_Device {
7100
7215
  * 私有化部署环境暂无法使用本接口
7101
7216
  * @param lcscIds - 立创 C 编号
7102
7217
  * @param libraryUuid - 库 UUID,默认为系统库,可以使用 {@link LIB_LibrariesList} 内的接口获取
7103
- * @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个���果
7218
+ * @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个结果
7104
7219
  * @returns 搜索到的器件属性
7105
7220
  */
7106
7221
  getByLcscIds<T extends boolean>(lcscIds: string, libraryUuid?: string, allowMultiMatch?: T): Promise<T extends true ? ILIB_DeviceSearchItem | undefined : Array<ILIB_DeviceSearchItem>>;
@@ -7590,7 +7705,7 @@ declare class PCB_Document {
7590
7705
  */
7591
7706
  setCanvasOrigin(offsetX: number, offsetY: number): Promise<boolean>;
7592
7707
  /**
7593
- * 定位到画布坐标
7708
+ * 定位到画布���标
7594
7709
  *
7595
7710
  * @public
7596
7711
  * @remarks
@@ -7621,12 +7736,23 @@ declare class PCB_Drc {
7621
7736
  /**
7622
7737
  * 检查 DRC
7623
7738
  *
7624
- * @public
7625
- * @param strict - 是否严格检查,严格检查时存在 Warning 将返回 `false`,否则返回 `true`
7739
+ * @beta
7740
+ * @param strict - 是否严格检查,当前 PCB 统一为严格检查模式
7626
7741
  * @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
7627
- * @returns DRC 检查是否无错误
7742
+ * @param includeVerboseError - 是否在返回值中包含详细错误信息,如若为 `true`,则返回值将始终为数组
7743
+ * @returns DRC 检查是否通过
7628
7744
  */
7629
- check(strict?: boolean, userInterface?: boolean): Promise<boolean>;
7745
+ check(strict: boolean, userInterface: boolean, includeVerboseError: false): Promise<boolean>;
7746
+ /**
7747
+ * 检查 DRC
7748
+ *
7749
+ * @beta
7750
+ * @param strict - 是否严格检查,当前 PCB 统一为严格检查模式
7751
+ * @param userInterface - 是否显示 UI(呼出底部 DRC 窗口)
7752
+ * @param includeVerboseError - 是否在返回值中包含详细错误信息,如若为 `true`,则返回值将始终为数组
7753
+ * @returns DRC 检查的详细结果
7754
+ */
7755
+ check(strict: boolean, userInterface: boolean, includeVerboseError: true): Promise<Array<any>>;
7630
7756
  /**
7631
7757
  * 获取当前设计规则配置名称
7632
7758
  *
@@ -7670,7 +7796,7 @@ declare class PCB_Drc {
7670
7796
  * @remarks 只有自定义配置可以覆盖保存,系统配置不允许修改和覆盖
7671
7797
  * @param ruleConfiguration - 设计规则配置
7672
7798
  * @param configurationName - 配置名称
7673
- * @param allowOverwrite - 是否允许覆写同名设计规则配置,`false` 则将在遇到同名设计规则配置时返回 `false`,请注意可能的数据丢失风险
7799
+ * @param allowOverwrite - ��否允许覆写同名设计规则配置,`false` 则将在遇到同名设计规则配置时返回 `false`,请注意可能的数据丢失风险
7674
7800
  * @returns 保存是否成功
7675
7801
  */
7676
7802
  saveRuleConfiguration(ruleConfiguration: {
@@ -7793,7 +7919,7 @@ declare class PCB_Drc {
7793
7919
  * 修改网络类的名称
7794
7920
  *
7795
7921
  * @beta
7796
- * @param originalNetClassName - 原网络类名称
7922
+ * @param originalNetClassName - ��网络类名称
7797
7923
  * @param netClassName - 新网络类名称
7798
7924
  * @returns 操作是否成功
7799
7925
  */
@@ -7934,6 +8060,10 @@ declare class PCB_Drc {
7934
8060
  * @param padPairGroupName - 焊盘对组名称
7935
8061
  * @param padPairs - 焊盘对数组
7936
8062
  * @returns 操作是否成功
8063
+ * @example 有三种不同的用法,确保画布上已有对应的焊盘。 分别是 一,游离焊盘-游离焊盘;二,器件焊盘 - 器件焊盘;三,器件焊盘 - 游离焊盘
8064
+ * await eda.pcb_Drc.createPadPairGroup('test',[['e0','e1']]) // 游离焊盘-游离焊盘
8065
+ * await eda.pcb_Drc.createPadPairGroup('test',[['R1:1','R1:2'],['R2:1','R2:2']]) // 器件焊盘 - 器件焊盘
8066
+ * await eda.pcb_Drc.createPadPairGroup('test',[['R1:1','e0'],['R1:2','e1']]) // 器件焊盘 - 游离焊盘
7937
8067
  */
7938
8068
  createPadPairGroup(padPairGroupName: string, padPairs: Array<[string, string]>): Promise<boolean>;
7939
8069
  /**
@@ -7960,6 +8090,10 @@ declare class PCB_Drc {
7960
8090
  * @param padPairGroupName - 焊盘对组名称
7961
8091
  * @param padPair - 焊盘对
7962
8092
  * @returns 操作是否成功
8093
+ * @example 有三种不同的用法,确保画布上已有对应的焊盘。 分别是 一,游离焊盘-游离焊盘;二,器件焊盘 - 器件焊盘;三,器件焊盘 - 游离焊盘
8094
+ * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离焊盘
8095
+ * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','R1:2']) // 器件焊盘 - 器件焊盘
8096
+ * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','e1']) // 器件焊盘 - 游离焊盘
7963
8097
  */
7964
8098
  addPadPairToPadPairGroup(padPairGroupName: string, padPair: [string, string] | Array<[string, string]>): Promise<boolean>;
7965
8099
  /**
@@ -7969,6 +8103,10 @@ declare class PCB_Drc {
7969
8103
  * @param padPairGroupName - 焊盘对组名称
7970
8104
  * @param padPair - 焊盘对
7971
8105
  * @returns 操作是否成功
8106
+ * @example 有三种不同的用法,确保画布上已有对应的焊盘。 分别是 一,游离焊盘-游离焊盘;二,器件焊盘 - 器件焊盘;三,器件焊盘 - 游离焊盘
8107
+ * await eda.pcb_Drc.removePadPairFromPadPairGroup('test',['e0','e1']) // 游离焊盘-游离焊盘
8108
+ * await eda.pcb_Drc.removePadPairFromPadPairGroup('test',['R1:1','R1:2']) // 器件焊盘 - 器件焊盘
8109
+ * await eda.pcb_Drc.removePadPairFromPadPairGroup('test',['R1:2','e1']) // 器件焊盘 - 游离焊盘
7972
8110
  */
7973
8111
  removePadPairFromPadPairGroup(padPairGroupName: string, padPair: [string, string] | Array<[string, string]>): Promise<boolean>;
7974
8112
  /**
@@ -8537,7 +8675,7 @@ declare class PCB_MathPolygon {
8537
8675
  * @param smoothing - 平滑,取值范围 `0`-`1.33`
8538
8676
  * @param despeckling - 去斑,取值范围 `0`-`5`
8539
8677
  * @param inversion - 是否反相
8540
- * @returns 复杂多边形对象
8678
+ * @returns 复杂多���形对象
8541
8679
  */
8542
8680
  convertImageToComplexPolygon(imageBlob: Blob, imageWidth: number, imageHeight: number, tolerance?: number, simplification?: number, smoothing?: number, despeckling?: number, inversion?: boolean): Promise<IPCB_ComplexPolygon | undefined>;
8543
8681
  }
@@ -9000,7 +9138,7 @@ declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
9000
9138
  * @beta
9001
9139
  * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
9002
9140
  * @param primitiveIds - 填充的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
9003
- * @returns 填充图元对象,空��组表示获取失败
9141
+ * @returns 填充图元对象,空数组表示获取失败
9004
9142
  */
9005
9143
  get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
9006
9144
  /**
@@ -9548,7 +9686,7 @@ declare class PCB_PrimitivePour implements IPCB_PrimitiveAPI {
9548
9686
  */
9549
9687
  getAllPrimitiveId(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<string>>;
9550
9688
  /**
9551
- * 获取所有填充
9689
+ * 获取所有覆铜边框图元
9552
9690
  *
9553
9691
  * @beta
9554
9692
  * @param net - 网络名称
@@ -9765,7 +9903,7 @@ declare class PCB_SelectControl {
9765
9903
  */
9766
9904
  doSelectPrimitives(primitiveIds: string | Array<string>): Promise<boolean>;
9767
9905
  /**
9768
- * 进行交叉选择
9906
+ * 进行交���选择
9769
9907
  *
9770
9908
  * @beta
9771
9909
  * @param components - 器件位号
@@ -10402,7 +10540,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
10402
10540
  * @param uniqueId - 唯一 ID,`null` 表示留空
10403
10541
  * @param manufacturer - 制造商,`null` 表示留空
10404
10542
  * @param manufacturerId - 制造商编号,`null` 表示留空
10405
- * @param supplier - 供应���,`null` 表示留空
10543
+ * @param supplier - 供应商,`null` 表示留空
10406
10544
  * @param supplierId - 供应商编号,`null` 表示留空
10407
10545
  * @returns 器件图元对象
10408
10546
  */
@@ -10802,7 +10940,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
10802
10940
  * 获取导线
10803
10941
  *
10804
10942
  * @beta
10805
- * @param primitiveIds - 导线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
10943
+ * @param primitiveIds - 导线��图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
10806
10944
  * @returns 导线图元对象
10807
10945
  */
10808
10946
  get(primitiveIds: string): ISCH_PrimitiveWire | undefined;
@@ -11054,7 +11192,10 @@ declare class SYS_FileManager {
11054
11192
  * 获取工程文件
11055
11193
  *
11056
11194
  * @public
11057
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11195
+ * @remarks
11196
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11197
+ *
11198
+ * 注意:本接口需要启用 **工程管理 \> 下载工程** 权限,没有权限调用将始终 `throw Error`
11058
11199
  * @param fileName - 文件名
11059
11200
  * @param password - 加密密码
11060
11201
  * @returns 工程文件数据,`undefined` 表示当前未打开工程或数据获取失败
@@ -11064,7 +11205,10 @@ declare class SYS_FileManager {
11064
11205
  * 获取文档文件
11065
11206
  *
11066
11207
  * @public
11067
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11208
+ * @remarks
11209
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11210
+ *
11211
+ * 注意:本接口需要启用 **工程设计图 \> 文件导出** 权限,没有权限调用将始终 `throw Error`
11068
11212
  * @param fileName - 文件名
11069
11213
  * @param password - 加密密码
11070
11214
  * @returns 文档文件数据,`undefined` 表示当前未打开文档或数据获取失败
@@ -11099,7 +11243,10 @@ declare class SYS_FileManager {
11099
11243
  * 使用工程 UUID 获取工程文件
11100
11244
  *
11101
11245
  * @public
11102
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11246
+ * @remarks
11247
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11248
+ *
11249
+ * 注意:本接口需要启用 **工程管理 \> 下载工程** 权限,没有权限调用将始终 `throw Error`
11103
11250
  * @param projectUuid - 工程 UUID
11104
11251
  * @param fileName - 文件名
11105
11252
  * @param password - 加密密码
@@ -11110,7 +11257,10 @@ declare class SYS_FileManager {
11110
11257
  * 使用器件 UUID 获取器件文件
11111
11258
  *
11112
11259
  * @public
11113
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11260
+ * @remarks
11261
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11262
+ *
11263
+ * 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
11114
11264
  * @param deviceUuid - 器件 UUID 或器件 UUID 列表
11115
11265
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
11116
11266
  * @returns 器件文件数据,`undefined` 表示数据获取失败
@@ -11121,7 +11271,10 @@ declare class SYS_FileManager {
11121
11271
  * 使用封装 UUID 获取封装文件
11122
11272
  *
11123
11273
  * @beta
11124
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11274
+ * @remarks
11275
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11276
+ *
11277
+ * 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
11125
11278
  * @param footprintUuid - 封装 UUID 或封装 UUID 列表
11126
11279
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
11127
11280
  * @returns 封装文件数据,`undefined` 表示数据获取失败
@@ -11131,7 +11284,10 @@ declare class SYS_FileManager {
11131
11284
  * 使用复用模块 UUID 获取复用模块文件
11132
11285
  *
11133
11286
  * @beta
11134
- * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11287
+ * @remarks
11288
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11289
+ *
11290
+ * 注意:本接口需要启用 **团队模块 \> 下载模块** 权限,没有权限调用将始终 `throw Error`
11135
11291
  * @param cbbUuid - 复用模块 UUID
11136
11292
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
11137
11293
  * @param fileName - 复用模块名
@@ -11139,7 +11295,19 @@ declare class SYS_FileManager {
11139
11295
  * @returns 复用模块文件数据,`undefined` 表示数据获取失败
11140
11296
  */
11141
11297
  getCbbFileByCbbUuid(cbbUuid: string, libraryUuid?: string, cbbName?: string, password?: string): Promise<File | undefined>;
11142
- /* Excluded from this release type: getPanelLibraryFileByPanelLibraryUuid */
11298
+ /**
11299
+ * 使用面板库 UUID 获取面板库文件
11300
+ *
11301
+ * @beta
11302
+ * @remarks
11303
+ * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
11304
+ *
11305
+ * 注意:本接口需要启用 **团队库 \> 下载库** 权限,没有权限调用将始终 `throw Error`
11306
+ * @param panelLibraryUuid - 面板库 UUID 或面板库 UUID 列表
11307
+ * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
11308
+ * @returns 面板库文件数据,`undefined` 表示数据获取失败
11309
+ */
11310
+ getPanelLibraryFileByPanelLibraryUuid(panelLibraryUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
11143
11311
  }
11144
11312
 
11145
11313
  /**
@@ -11546,7 +11714,7 @@ declare class SYS_PanelControl {
11546
11714
  */
11547
11715
  openRightPanel(tab?: ESYS_RightPanelTab): void;
11548
11716
  /**
11549
- * 关闭���侧面板
11717
+ * 关闭右侧面板
11550
11718
  *
11551
11719
  * @public
11552
11720
  */
@@ -11693,7 +11861,7 @@ declare class SYS_Storage {
11693
11861
  *
11694
11862
  * @public
11695
11863
  * @remarks
11696
- * 新建扩展用户配置也使用本接口,在设置时如果不存在将会自动新建
11864
+ * 新建扩展用户配置也使用本接口,���设置时如果不存在将会自动新建
11697
11865
  *
11698
11866
  * 注意:本接口仅扩展有效,在独立脚本环境内调用将始终 `throw Error`
11699
11867
  * @param key - 配置项
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.111",
3
+ "version": "0.1.112",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [