@jlceda/pro-api-types 0.1.123 → 0.1.124
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 +15 -15
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
|
|
|
86
86
|
* 关闭文档
|
|
87
87
|
*
|
|
88
88
|
* @public
|
|
89
|
-
* @remarks
|
|
89
|
+
* @remarks 如若文档尚未保存,执行此操作将会直接丢失所有未保存的数据,请在修改操作完成后首先执行 {@link SCH_Document.save}、{@link PCB_Document.save}、{@link PNL_Document.save} 保存数据
|
|
90
90
|
* @param tabId - 标签页 ID,此处支持 {@link IDMT_SchematicPageItem.uuid}、{@link IDMT_PcbItem.uuid}、{@link IDMT_PanelItem.uuid} 作为输入
|
|
91
91
|
* @returns 操作是否成功
|
|
92
92
|
*/
|
|
@@ -410,7 +410,7 @@ declare class DMT_Project {
|
|
|
410
410
|
*
|
|
411
411
|
* @beta
|
|
412
412
|
* @param projectFriendlyName - 工程友好名称
|
|
413
|
-
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线
|
|
413
|
+
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名���自动生成
|
|
414
414
|
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
415
415
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
416
416
|
* @param description - 工程描述
|
|
@@ -1925,7 +1925,7 @@ declare interface IDMT_PanelItem {
|
|
|
1925
1925
|
readonly itemType: EDMT_ItemType.PANEL;
|
|
1926
1926
|
/** 面板 UUID */
|
|
1927
1927
|
uuid: string;
|
|
1928
|
-
/**
|
|
1928
|
+
/** 面板���称 */
|
|
1929
1929
|
name: string;
|
|
1930
1930
|
/** 所属工程 UUID */
|
|
1931
1931
|
parentProjectUuid: string;
|
|
@@ -4674,7 +4674,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
4674
4674
|
*/
|
|
4675
4675
|
setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;
|
|
4676
4676
|
/**
|
|
4677
|
-
*
|
|
4677
|
+
* ���置属性状态:网络
|
|
4678
4678
|
*
|
|
4679
4679
|
* @beta
|
|
4680
4680
|
* @remarks 本接口仅在 PCB 编辑器可用,空字符串与 `undefined` 均被视为空网络
|
|
@@ -4961,7 +4961,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4961
4961
|
*/
|
|
4962
4962
|
toSync(): IPCB_PrimitivePolyline;
|
|
4963
4963
|
/**
|
|
4964
|
-
*
|
|
4964
|
+
* 查询图元是否为异步图元
|
|
4965
4965
|
*
|
|
4966
4966
|
* @public
|
|
4967
4967
|
* @returns 是否为异步图元
|
|
@@ -5607,7 +5607,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
5607
5607
|
*
|
|
5608
5608
|
* @beta
|
|
5609
5609
|
* @param diameter - 外径
|
|
5610
|
-
* @returns
|
|
5610
|
+
* @returns 过孔图元对象
|
|
5611
5611
|
*/
|
|
5612
5612
|
setState_Diameter(diameter: number): IPCB_PrimitiveVia;
|
|
5613
5613
|
/**
|
|
@@ -6913,7 +6913,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
|
|
|
6913
6913
|
*
|
|
6914
6914
|
* @beta
|
|
6915
6915
|
* @param y - 坐标 Y
|
|
6916
|
-
* @returns
|
|
6916
|
+
* @returns 器件图元对象
|
|
6917
6917
|
*/
|
|
6918
6918
|
setState_Y(y: number): ISCH_PrimitiveComponent_2;
|
|
6919
6919
|
/**
|
|
@@ -7054,7 +7054,7 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
|
|
|
7054
7054
|
* 将对图元的更改应用到画布
|
|
7055
7055
|
*
|
|
7056
7056
|
* @beta
|
|
7057
|
-
* @returns
|
|
7057
|
+
* @returns 器件图元对象
|
|
7058
7058
|
*/
|
|
7059
7059
|
done(): Promise<ISCH_PrimitiveComponent_2>;
|
|
7060
7060
|
/* Excluded from this release type: getAllPins */
|
|
@@ -7690,7 +7690,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
|
|
|
7690
7690
|
* 设置属性状态:填充样式
|
|
7691
7691
|
*
|
|
7692
7692
|
* @beta
|
|
7693
|
-
* @param fillStyle -
|
|
7693
|
+
* @param fillStyle - 填充样式
|
|
7694
7694
|
* @returns 矩形图元对象
|
|
7695
7695
|
*/
|
|
7696
7696
|
setState_FillStyle(fillStyle: ESCH_PrimitiveFillStyle | null): ISCH_PrimitiveRectangle;
|
|
@@ -8305,7 +8305,7 @@ declare class LIB_Cbb {
|
|
|
8305
8305
|
* 修改复用模块
|
|
8306
8306
|
*
|
|
8307
8307
|
* @beta
|
|
8308
|
-
* @remarks
|
|
8308
|
+
* @remarks 如希望清除某些属性,则将其的值设置为 `null`
|
|
8309
8309
|
* @param cbbUuid - 复用模块 UUID
|
|
8310
8310
|
* @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
|
|
8311
8311
|
* @param cbbName - 复用模块名称
|
|
@@ -8667,7 +8667,7 @@ declare class LIB_Footprint {
|
|
|
8667
8667
|
*/
|
|
8668
8668
|
modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
|
|
8669
8669
|
/**
|
|
8670
|
-
*
|
|
8670
|
+
* 更新封装的文档源码
|
|
8671
8671
|
*
|
|
8672
8672
|
* @beta
|
|
8673
8673
|
* @param footprintUuid - 封装 UUID
|
|
@@ -9771,7 +9771,7 @@ declare class PCB_ManufactureData {
|
|
|
9771
9771
|
* @param fileName - 文件名
|
|
9772
9772
|
* @param fileType - 文件类型
|
|
9773
9773
|
* @param template - 模板名称
|
|
9774
|
-
* @param filterOptions - 过滤规则,仅应包含需要启用的规则,`property` 为规则名称,`includeValue`
|
|
9774
|
+
* @param filterOptions - 过滤规则,仅应包含需要启用的规则,`property` 为规则名称,`includeValue` 为匹配的值
|
|
9775
9775
|
* @param statistics - 统计,包含所有需要启用的统计项的名称
|
|
9776
9776
|
* @param property - 属性,包含所有需要启用的属性的名称
|
|
9777
9777
|
* @param columns - 列的属性及排序,`title`、`sort`、`group`、`orderWeight` 不传入则取默认值,`null` 代表 **无** 或 **空**
|
|
@@ -10317,7 +10317,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
|
|
|
10317
10317
|
*
|
|
10318
10318
|
* @beta
|
|
10319
10319
|
* @param primitiveIds - 器件的图元 ID 或器件图元对象
|
|
10320
|
-
* @returns
|
|
10320
|
+
* @returns 删除操作是否��功
|
|
10321
10321
|
*/
|
|
10322
10322
|
delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;
|
|
10323
10323
|
/**
|
|
@@ -13624,7 +13624,7 @@ declare class SYS_Storage {
|
|
|
13624
13624
|
* 获取扩展所有用户配置
|
|
13625
13625
|
*
|
|
13626
13626
|
* @public
|
|
13627
|
-
* @remarks
|
|
13627
|
+
* @remarks 注意:本接口仅扩展有效,在独立脚本环境���调用将始终 `throw Error`
|
|
13628
13628
|
* @returns 扩展所有用户配置信息
|
|
13629
13629
|
*/
|
|
13630
13630
|
getExtensionAllUserConfigs(): {
|
|
@@ -14030,7 +14030,7 @@ declare type TPCB_LayerTypesOfInnerLayer = EPCB_LayerType.SIGNAL | EPCB_LayerTyp
|
|
|
14030
14030
|
*
|
|
14031
14031
|
* @public
|
|
14032
14032
|
* @remarks
|
|
14033
|
-
*
|
|
14033
|
+
* 单多边形为首尾重��的一条不间断的线所描述的区域,如果首尾不重合将会自动重合。
|
|
14034
14034
|
*
|
|
14035
14035
|
* 单多边形的数据格式举例:
|
|
14036
14036
|
*
|