@jlceda/pro-api-types 0.1.98 → 0.1.100

package/index.d.ts

@@ -595,7 +595,7 @@ declare class DMT_Schematic {
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
-     * 获取当前原理图图页的详细属性
+     * 获取当前原理���图页的详细属性
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -797,7 +797,6 @@ declare class EDA {
     /* Excluded from this release type: extensionUuid */
     /* Excluded from this release type: allowExternalInteractions */
     /* Excluded from this release type: __constructor */
-    /* Excluded from this release type: reassignInstantiatedObjectsBeforeAllowExternalInteractionsChange */
 }
 
 /**
@@ -2602,7 +2601,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      */
     setState_Net(net: string): IPCB_PrimitiveArc;
     /**
-     * 设置属性状���：层
+     * 设置属性状态：层
      *
      * @beta
      * @param layer - 层
@@ -2708,6 +2707,8 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      * @returns 圆弧线图元对象
      */
     done(): Promise<IPCB_PrimitiveArc>;
+    /* Excluded from this release type: getAdjacentPrimitives */
+    /* Excluded from this release type: getEntireTrack */
 }
 
 /**
@@ -3395,7 +3396,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
 }
 
 /**
- * 导线图元
+ * 直线图元
  *
  * @public
  */
@@ -3499,7 +3500,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param net - 网络名称
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_Net(net: string): IPCB_PrimitiveLine;
     /**
@@ -3507,7 +3508,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param layer - 层
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveLine;
     /**
@@ -3515,7 +3516,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param startX - 起始位置 X
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_StartX(startX: number): IPCB_PrimitiveLine;
     /**
@@ -3523,7 +3524,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param startY - 起始位置 Y
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_StartY(startY: number): IPCB_PrimitiveLine;
     /**
@@ -3531,7 +3532,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param endX - 终止位置 X
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_EndX(endX: number): IPCB_PrimitiveLine;
     /**
@@ -3539,7 +3540,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param endY - 终止位置 Y
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_EndY(endY: number): IPCB_PrimitiveLine;
     /**
@@ -3547,7 +3548,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param lineWidth - 线宽
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_LineWidth(lineWidth: number): IPCB_PrimitiveLine;
     /**
@@ -3555,25 +3556,25 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param primitiveLock - 是否锁定
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveLine;
     /**
      * 将图元转换为异步图元
      *
      * @public
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     toAsync(): IPCB_PrimitiveLine;
     /**
      * 将图元转换为同步图元
      *
      * @public
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     toSync(): IPCB_PrimitiveLine;
     /**
-     * 查询图元是否为异步��元
+     * 查询图元是否为异步图元
      *
      * @public
      * @returns 是否为异步图元
@@ -3583,16 +3584,18 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      * 将异步图元重置为当前画布状态
      *
      * @beta
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     reset(): Promise<IPCB_PrimitiveLine>;
     /**
      * 将对图元的更改应用到画布
      *
      * @beta
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     done(): Promise<IPCB_PrimitiveLine>;
+    /* Excluded from this release type: getAdjacentPrimitives */
+    /* Excluded from this release type: getEntireTrack */
 }
 
 /**
@@ -4770,6 +4773,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      * @returns 过孔图元对象
      */
     done(): Promise<IPCB_PrimitiveVia>;
+    /* Excluded from this release type: getAdjacentPrimitives */
 }
 
 /**
@@ -4789,7 +4793,7 @@ declare interface ISCH_Primitive {
 }
 
 /**
- * 原理图图元接��
+ * 原理图图元接口
  *
  * @public
  */
@@ -6637,14 +6641,24 @@ declare class PCB_Document {
      */
     importChanges(uuid: string): Promise<boolean>;
     /**
-     * 导入自动布线文件（JSON）
+     * 导入旧版自动布线文件（JSON）
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
      * @param autoRouteFile - 欲导入的 JSON 文件
      * @returns 导入操作是否成功
      */
-    importAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
+    importOldAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;
+    /**
+     * 导入旧版自动布局文件（JSON）
+     *
+     * @beta
+     * @remarks 可以使用 {@link SYS_FileSystem.openReadFileDialog} 读入文件
+     * @deprecated 建议使用 {@link PCB_ManufactureData.getAutoLayoutJsonFile} 接口提供的自动布线文件，它对应 {@link PCB_Document.importAutoLayoutJsonFile} 导入接口
+     * @param autoLayoutFile - 欲导入的 JSON 文件
+     * @returns 导入操作是否成功
+     */
+    importOldAutoLayoutJsonFile(autoLayoutFile: File): Promise<boolean>;
     /**
      * 导入自动布局文件（JSON）
      *
@@ -7065,7 +7079,7 @@ declare class PCB_Drc {
      * 从等长网络组中移除网络
      *
      * @beta
-     * @param equalLengthNetGroupName - 等长网��组名称
+     * @param equalLengthNetGroupName - 等长网络组名称
      * @param net - 网络名称
      * @returns 操作是否成功
      */
@@ -7306,7 +7320,7 @@ declare class PCB_ManufactureData {
      * 获取 PCB 制版文件（Gerber）
      *
      * @beta
-     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文��系统
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      * @param fileName - 文件名
      * @param colorSilkscreen - 是否生成彩色丝印制造文件（嘉立创专用文件）
      * @param unit - 单位
@@ -7389,7 +7403,7 @@ declare class PCB_ManufactureData {
      * 获取网表文件（Netlist）
      *
      * @beta
-     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接���将文件导出到本地文件系统
+     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      * @param fileName - 文件名
      * @param netlistType - 网表类型
      * @returns 网表文件数据
@@ -7449,7 +7463,7 @@ declare class PCB_ManufactureData {
      *
      * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @deprecated 新版自动布线 JSON 文件正在开发中，之后将会取代本接口
+     * @deprecated 建议使用 {@link PCB_ManufactureData.getAutoRouteJsonFile} 接口提供的自动布线文件
      * @param fileName - 文件名
      * @returns 旧版自动布线 JSON 文件数据
      */
@@ -7468,8 +7482,8 @@ declare class PCB_ManufactureData {
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @deprecated 新版自动布局 JSON 文件正在开发中，之后将会取代本接口
-     * @param fileName - ���件名
+     * @deprecated 建议使用 {@link PCB_ManufactureData.getAutoLayoutJsonFile} 接口提供的自动布局文件
+     * @param fileName - 文件名
      * @returns 旧版自动布局 JSON 文件数据
      */
     getOldAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;
@@ -7629,6 +7643,7 @@ declare class PCB_Primitive {
  * PCB & 封装 / 圆弧线图元类
  *
  * @public
+ * @remarks 直线和圆弧线均为导线，对应画布的线条走线和圆弧走线
  */
 declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
     /**
@@ -7996,13 +8011,14 @@ declare class PCB_PrimitiveImage implements IPCB_PrimitiveAPI {
 }
 
 /**
- * PCB & 封装 / 导线图元类
+ * PCB & 封装 / 直线图元类
  *
  * @public
+ * @remarks 直线和圆弧线均为导线，对应画布的线条走线和圆弧走线
  */
 declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
     /**
-     * 创建导线
+     * 创建直线
      *
      * @public
      * @param net - 网络名称
@@ -8013,24 +8029,24 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * @param endY - 终止位置 Y
      * @param lineWidth - 线宽
      * @param primitiveLock - 是否锁定
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, lineWidth?: number, primitiveLock?: boolean): Promise<IPCB_PrimitiveLine | undefined>;
     /**
-     * 删除导线
+     * 删除直线
      *
      * @beta
-     * @param primitiveIds - 导线的图元 ID 或导线图元对象
+     * @param primitiveIds - 直线的图元 ID 或直线图元对象
      * @returns 删除操作是否成功
      */
     delete(primitiveIds: string | IPCB_PrimitiveLine | Array<string> | Array<IPCB_PrimitiveLine>): Promise<boolean>;
     /**
-     * 修改导线
+     * 修改直线
      *
      * @beta
      * @param primitiveId - 图元 ID
      * @param property - 修改参数
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     modify(primitiveId: string | IPCB_PrimitiveLine, property: {
         net?: string;
@@ -8043,24 +8059,24 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
         primitiveLock?: boolean;
     }): Promise<IPCB_PrimitiveLine | undefined>;
     /**
-     * 获取导线
+     * 获取直线
      *
      * @beta
-     * @param primitiveIds - 导线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 导线图元对象，`undefined` 表示获取失败
+     * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 直线图元对象，`undefined` 表示获取失败
      */
     get(primitiveIds: string): Promise<IPCB_PrimitiveLine | undefined>;
     /**
-     * 获取导线
+     * 获取直线
      *
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
-     * @param primitiveIds - 导线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 导线图元对象，空数组表示获取失败
+     * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @returns 直线图元对象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveLine>>;
     /**
-     * 获取所有导线的图元 ID
+     * 获取所有直线的图元 ID
      *
      * @beta
      * @param net - 网络名称
@@ -8070,13 +8086,13 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      */
     getAllPrimitiveId(net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean): Promise<Array<string>>;
     /**
-     * 获取所有导线
+     * 获取所有直线
      *
      * @beta
      * @param net - 网络名称
      * @param layer - 层
      * @param primitiveLock - 是否锁定
-     * @returns 导线图元对象数组
+     * @returns 直线图元对象数组
      */
     getAll(net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveLine>>;
 }
@@ -9517,8 +9533,8 @@ declare class SCH_Utils {
  * @remarks 向外部服务器发起安全的 cURL 请求
  */
 declare class SYS_ClientUrl {
-    /** 是否允许外部交互 */
-    private allowExternalInteractions?;
+    /** 扩展 UUID */
+    private extensionUuid?;
     /* Excluded from this release type: __constructor */
     /**
      * 发起即时请求
@@ -9583,7 +9599,7 @@ declare class SYS_Dialog {
  * 系统 / 运行环境类
  *
  * @public
- * @remarks 获取嘉立创 EDA 专���版运行环境参数
+ * @remarks 获取嘉立创 EDA 专业版运行环境参数
  */
 declare class SYS_Environment {
     /**
@@ -9748,8 +9764,8 @@ declare class SYS_FileManager {
  * @public
  */
 declare class SYS_FileSystem {
-    /** 是否允许外部交互 */
-    private allowExternalInteractions?;
+    /** 扩展 UUID */
+    private extensionUuid?;
     /* Excluded from this release type: __constructor */
     /**
      * 打开读入文件窗口
@@ -9763,7 +9779,7 @@ declare class SYS_FileSystem {
      * 保存文件
      *
      * @public
-     * @remarks 调用浏览器下载接口或 Electron 保存文件接口，将传入的文件流保存到本地
+     * @remarks 调用浏览器下载接口或 Electron 保存文件接口，将传入的文件流��存到本地
      * @param fileData - 文件数据
      * @param fileName - 文件名称
      */
@@ -10402,8 +10418,6 @@ declare class SYS_Unit {
 declare class SYS_WebSocket {
     /** 扩展 UUID */
     private extensionUuid?;
-    /** 是否允许外部交互 */
-    private allowExternalInteractions?;
     /* Excluded from this release type: __constructor */
     /**
      * 注册 WebSocket 连接

package/package.json

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