@jlceda/pro-api-types 0.1.82 → 0.1.84

package/index.d.ts

@@ -1187,7 +1187,7 @@ declare enum EPCB_LayerId {
     SHELL_3D_TOP = 54,
     /** 3D 外壳底层 */
     SHELL_3D_BOTTOM = 55,
-    /** 钻���图层 */
+    /** 钻��图层 */
     DRILL_DRAWING = 56
 }
 
@@ -1930,7 +1930,7 @@ declare interface ILIB_CbbItem {
 }
 
 /**
- * 搜索到的复用模块属性
+ * 搜索��的复用模块属性
  *
  * @public
  */
@@ -3066,7 +3066,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveFill;
     /**
-     * 将图元转换为异步图元
+     * 将图元转换为异步���元
      *
      * @public
      * @returns 填充图元对象
@@ -3844,7 +3844,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_SolderMaskAndPasteMaskExpansion(solderMaskAndPasteMaskExpansion: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：热焊优化参数
+     * 设置属性状态��热焊优化参数
      *
      * @beta
      * @param heatWelding - 热焊优化参数
@@ -4004,7 +4004,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
      */
     setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitivePolyline;
     /**
-     * 设置属性状态：单多边形
+     * 设置属性���态：单多边形
      *
      * @beta
      * @param polygon - 单多边形
@@ -6267,14 +6267,23 @@ declare class PCB_Document {
      */
     importChanges(uuid: string): Promise<boolean>;
     /**
-     * 导入旧版自动布线文件（JSON）
+     * 导入自动布线文件（JSON）
      *
-     * @public
+     * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
      * @param autoRouteFile - 欲导入的 JSON 文件
      * @returns 导入操作是否成功
      */
-    importOldAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
+    importAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
+    /**
+     * 导入自动布局文件（JSON）
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
+     * @param autoLayoutFile - 欲导入的 JSON 文件
+     * @returns 导入操作是否成功
+     */
+    importAutoLayoutJsonFile(autoLayoutFile: File): Promise<boolean>;
     /**
      * 保存文档
      *
@@ -6340,7 +6349,7 @@ declare class PCB_Document {
      * 嘉立创 EDA 专业版 API 使用的均为数据原点；
      *
      * 如果返回的数据为 `{ canvasOriginOffsetX: 100, canvasOriginOffsetY: 200 }`，
-     * 则代表画布原点在数据原点的向右 100 单位且向上 200 单位的位置；
+     * 则代表画布原点在数据原点的向右 100 单位且向上 200 单位的位��；
      *
      * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
      * @returns 画布原点相对于数据原点的偏移坐标
@@ -6411,7 +6420,7 @@ declare class PCB_Drc {
     /**
      * 获取当前设计规则配置
      *
-     * @public
+     * @beta
      * @returns 当前设计规则配置，`undefined` 为获取失败
      */
     getCurrentRuleConfiguration(): Promise<{
@@ -6420,7 +6429,7 @@ declare class PCB_Drc {
     /**
      * 获取指定设计规则配置
      *
-     * @beta
+     * @public
      * @param configurationName - 配置名称
      * @returns 设计规则配置，`undefined` 为不存在该设计规则
      */
@@ -6453,6 +6462,7 @@ declare class PCB_Drc {
      * 重命名设计规则配置
      *
      * @beta
+     * @remarks 只有自定义配置可以重命名，系统配置不允许重命名
      * @param originalConfigurationName - 原设计规则配置名称
      * @param configurationName - 新设计规则配置名称
      * @returns 重命名是否成功
@@ -6462,6 +6472,7 @@ declare class PCB_Drc {
      * 删除设计规则配置
      *
      * @beta
+     * @remarks 系统配置不允许删除
      * @param configurationName - 配置名称
      * @returns 删除是否成功
      */
@@ -6477,6 +6488,7 @@ declare class PCB_Drc {
      * 设置为新建 PCB 默认设计规则配置
      *
      * @beta
+     * @remarks 返回值为结果导向，重复设置相同的设计规则为默认设计规则也将返回 `true`
      * @param configurationName - 配置名称
      * @returns 设置是否成功
      */
@@ -6925,7 +6937,7 @@ declare class PCB_ManufactureData {
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      * @param fileName - 文件名
-     * @param colorSilkscreen - 是否生成彩色丝印制造文件（嘉立创专用文件）
+     * @param colorSilkscreen - 是否生成彩色丝印制造文件（嘉立���专用文件）
      * @param unit - 单位
      * @param digitalFormat - 数字格式
      * @param drilledHole - 钻孔
@@ -7062,35 +7074,41 @@ declare class PCB_ManufactureData {
     /**
      * 获取旧版自动布线文件（JSON）
      *
-     * @alpha
+     * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      * @deprecated 新版自动布线 JSON 文件正在开发中，之后将会取代本接口
      * @param fileName - 文件名
-     * @param routeNet - 布线网络，`All` 所有网络、`SelectedNet` 所选网络、`SelectedComponentsNet` 所选器件的网络
-     * @param cablingCorner - 布线拐角，支持 `45` 度或 `90` 度
-     * @param existingWiresAndVias - 已有导线/过孔的处理方式，`Save` 保留、`Remove` 移除
-     * @param performancePriority - 效果优先级，`Quality` 质量（完成度优先）、`Fast` 快速（速度优先）
-     * @param netPriority - 网络优先级，
-     *
-     * `Default` 默认、`Random` 随机、`Custom net names are preferred` 有自定义网络名的网络优先、
+     * @returns 旧版自动布线 JSON 文件数据
+     */
+    getOldAutoRouteJsonFile(fileName?: string): Promise<File | undefined>;
+    /**
+     * 获取自动布线文件（JSON）
      *
-     * `Pads from more to less` 焊盘从多到少、`Pads from less to more` 焊盘从少到多、
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @param fileName - 文件名
+     * @returns 自动布线 JSON 文件数据
+     */
+    getAutoRouteJsonFile(fileName?: string): Promise<File | undefined>;
+    /**
+     * 获取旧版自动布局文件（JSON）
      *
-     * `Pads from far to near` 焊盘从远到近、`Pads from near to far` 焊盘从近到远
-     * @param routeLayers - 布线图层，`All` 所有层，你也可以在数组内列出所有需要布线的铜箔层
-     * @param ignoredNets - 忽略的网络，请在数组内列出所有忽略的网络的名称
-     * @returns 旧版自动布线 JSON 文件数据
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * @deprecated 新版自动布局 JSON 文件正在开发中，之后将会取代本接口
+     * @param fileName - 文件名
+     * @returns 旧版自动布局 JSON 文件数据
      */
+    getOldAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
     /**
-     * 获取旧版自动布线文件（JSON）
+     * 获取自动布局文件（JSON）
      *
-     * @public
+     * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @deprecated 新版自动布线 JSON 文件正在开发中，之后将会取代本接口
      * @param fileName - 文件名
-     * @returns 旧版自动布线 JSON 文件数据
+     * @returns 自动布局 JSON 文件数据
      */
-    getOldAutoRouteJsonFile(fileName?: string): Promise<File | undefined>;
+    getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
     /**
      * 获取 PCB 信息文件
      *
@@ -7423,9 +7441,10 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      * @beta
      * @param layer - 层
      * @param primitiveLock - 是否锁定
-     * @returns 器件图元对象数组
+     * @returns 器件图��对象数组
      */
     getAll(layer?: TPCB_LayersOfComponent, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveComponent>>;
+    /* Excluded from this release type: placeComponentWithMouse */
 }
 
 /**
@@ -8024,6 +8043,7 @@ declare class PCB_SelectControl {
      *
      * @beta
      * @param primitiveIds - 图元 ID
+     * @returns 操作是否成功
      */
     doSelectPrimitives(primitiveIds: string | Array<string>): Promise<boolean>;
     /**
@@ -8034,16 +8054,17 @@ declare class PCB_SelectControl {
      * @param pins - 器件位号_引脚编号，格式为 ['U1_1', 'U1_2']
      * @param nets - 网络名称
      * @param highlight - 是否高亮
-     * @param select - 是否选中
+     * @param select - 操作是否成功
      */
     doCrossProbeSelect(components?: Array<string>, pins?: Array<string>, nets?: Array<string>, highlight?: boolean, select?: boolean): Promise<boolean>;
     /**
      * 清除选中
      *
      * @beta
-     * @returns 是否清除成功
+     * @returns 操作是否成功
      */
     clearSelected(): Promise<boolean>;
+    /* Excluded from this release type: getCurrentMousePosition */
 }
 
 declare enum PIN_TYPE {
@@ -8295,7 +8316,7 @@ declare class SCH_PrimitiveArc implements ISCH_PrimitiveAPI {
      * 获取圆弧
      *
      * @beta
-     * @param primitiveIds - 圆弧的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 圆弧的图元 ID，可以为字符串或字符串数组，如若为数组，则返回��也是数组
      * @returns 圆弧图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveArc | undefined>;
@@ -8532,17 +8553,17 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param componentUuid - 关联库器件 UUID
+     * @param libraryPath - 库路
      * @param subLibraryId - 子库编号 part名称
      * @param x - 坐标 X
      * @param y - 坐标 Y
      * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param mirror - 是否镜像
-     * @param libraryPath - 库路径，默认为系统库
      * @param addIntoBom - 是否加入 BOM
      * @param addIntoPcb - 是否转到 PCB
      * @returns 器件图元对象
      */
-    create(componentUuid: string, subLibraryId: string, x: number, y: number, rotation?: number, mirror?: boolean, libraryPath?: string, addIntoBom?: boolean, addIntoPcb?: boolean): Promise<ISCH_PrimitiveComponent | undefined>;
+    create(componentUuid: string, libraryPath: string, subLibraryId: string, x: number, y: number, rotation?: number, mirror?: boolean, addIntoBom?: boolean, addIntoPcb?: boolean): Promise<ISCH_PrimitiveComponent | undefined>;
     /**
      * 创建网络标识
      *
@@ -8620,14 +8641,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveComponent | undefined>;
     get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveComponent>>;
-    /**
-     * 转换 PrimitiveType 到 CmdKey
-     *
-     * @beta
-     * @param primitiveType - 图元类型
-     * @returns CmdKey
-     */
-    transformPrimitiveTypeToCmdKey(primitiveType: string): string;
+    /* Excluded from this release type: transformPrimitiveTypeToCmdKey */
     /**
      * 获取所有器件的图元 ID
      *
@@ -8644,6 +8658,8 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @returns 器件图元对象数组
      */
     getAll(componentType?: string, allSchematicPages?: boolean): Promise<Array<ISCH_PrimitiveComponent>>;
+    /* Excluded from this release type: getAllPinsByPrimitiveId */
+    /* Excluded from this release type: placeComponentWithMouse */
     /**
      * 到 pro-ui 获取器件的详细信息
      *
@@ -9054,6 +9070,7 @@ declare class SCH_SelectControl {
      *
      * @public
      * @param primitiveIds - 图元 ID
+     * @returns 操作是否成功
      */
     doSelectPrimitives(primitiveIds: string | Array<string>): Promise<boolean>;
     /**
@@ -9065,14 +9082,17 @@ declare class SCH_SelectControl {
      * @param nets - 网络名称
      * @param highlight - 是否高亮
      * @param select - 是否选中
+     * @returns 操作是否成功
      */
     doCrossProbeSelect(components?: Array<string>, pins?: Array<string>, nets?: Array<string>, highlight?: boolean, select?: boolean): boolean;
     /**
      * 清除选中
      *
      * @public
+     * @returns 操作是否成功
      */
     clearSelected(): boolean;
+    /* Excluded from this release type: getCurrentMousePosition */
 }
 
 /**
@@ -9295,9 +9315,10 @@ declare class SYS_FileSystem {
      * 打开读入文件窗口
      *
      * @beta
+     * @param filenameExtensions - 文件扩展名
      * @returns File 格式文件
      */
-    openReadFileDialog(): Promise<File | undefined>;
+    openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
     /**
      * 保存文件
      *
@@ -9376,13 +9397,6 @@ declare class SYS_I18n {
      * @returns 语言
      */
     getCurrentLanguage(): Promise<string>;
-    /**
-     * 刷新当前语言环境
-     *
-     * @public
-     * @remarks 使扩展内部语言环境与 EDA 当前语言环境同步
-     */
-    flushCurrentLanguage(): Promise<void>;
     /**
      * 查询所有支持的语言
      *
@@ -9443,6 +9457,8 @@ declare class SYS_IFrame {
      *
      * @beta
      * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
+     * @param width - 内联框架窗口的宽度
+     * @param height - 内联框架窗口的高度
      */
     openIFrame(htmlFileName: string, width?: number, height?: number): Promise<void>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.82",
+	"version": "0.1.84",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [