@jlceda/pro-api-types 0.1.99 → 0.1.100

package/index.d.ts

@@ -416,7 +416,7 @@ declare class DMT_Project {
      * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
-     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则��参数将被忽略
+     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
      * @returns 工程 UUID，如若为 `undefined` 则创建失败
      */
     createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -595,7 +595,7 @@ declare class DMT_Schematic {
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
-     * 获取当前原��图图页的详细属性
+     * 获取当前原理���图页的详细属性
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -2707,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 */
 }
 
 /**
@@ -3394,7 +3396,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
 }
 
 /**
- * 导线图元
+ * 直线图元
  *
  * @public
  */
@@ -3498,7 +3500,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param net - 网络名称
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_Net(net: string): IPCB_PrimitiveLine;
     /**
@@ -3506,7 +3508,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param layer - 层
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveLine;
     /**
@@ -3514,7 +3516,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param startX - 起始位置 X
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_StartX(startX: number): IPCB_PrimitiveLine;
     /**
@@ -3522,7 +3524,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param startY - 起始位置 Y
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_StartY(startY: number): IPCB_PrimitiveLine;
     /**
@@ -3530,7 +3532,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param endX - 终止位置 X
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_EndX(endX: number): IPCB_PrimitiveLine;
     /**
@@ -3538,7 +3540,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param endY - 终止位置 Y
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_EndY(endY: number): IPCB_PrimitiveLine;
     /**
@@ -3546,7 +3548,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      *
      * @beta
      * @param lineWidth - 线宽
-     * @returns 导线图元对象
+     * @returns 直线图元对象
      */
     setState_LineWidth(lineWidth: number): IPCB_PrimitiveLine;
     /**
@@ -3554,21 +3556,21 @@ 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;
     /**
@@ -3582,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 */
 }
 
 /**
@@ -4174,7 +4178,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
     private layer;
     /** 复杂多边形 */
     private complexPolygon;
-    /** 覆���填充方法 */
+    /** 覆铜填充方法 */
     private pourFillMethod;
     /** 是否保留孤岛 */
     private preserveSilos;
@@ -4769,6 +4773,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      * @returns 过孔图元对象
      */
     done(): Promise<IPCB_PrimitiveVia>;
+    /* Excluded from this release type: getAdjacentPrimitives */
 }
 
 /**
@@ -5950,7 +5955,7 @@ declare class LIB_3DModel {
      *
      * @beta
      * @param modelUuid - 3D 模型 UUID
-     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接��获取
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @returns 操作是否成功
      */
     delete(modelUuid: string, libraryUuid: string): Promise<boolean>;
@@ -6636,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）
      *
@@ -7448,7 +7463,7 @@ declare class PCB_ManufactureData {
      *
      * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @deprecated 新版自动布线 JSON 文件正在开发中，之后将会取代本接口
+     * @deprecated 建议使用 {@link PCB_ManufactureData.getAutoRouteJsonFile} 接口提供的自动布线文件
      * @param fileName - 文件名
      * @returns 旧版自动布线 JSON 文件数据
      */
@@ -7467,7 +7482,7 @@ declare class PCB_ManufactureData {
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @deprecated 新版自动布局 JSON 文件正在开发中，之后将会取代本接口
+     * @deprecated 建议使用 {@link PCB_ManufactureData.getAutoLayoutJsonFile} 接口提供的自动布局文件
      * @param fileName - 文件名
      * @returns 旧版自动布局 JSON 文件数据
      */
@@ -7628,6 +7643,7 @@ declare class PCB_Primitive {
  * PCB & 封装 / 圆弧线图元类
  *
  * @public
+ * @remarks 直线和圆弧线均为导线，对应画布的线条走线和圆弧走线
  */
 declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
     /**
@@ -7797,7 +7813,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
      * @beta
      * @param layer - 层
      * @param primitiveLock - 是否锁定
-     * @returns 器件��图元 ID 数组
+     * @returns 器件的图元 ID 数组
      */
     getAllPrimitiveId(layer?: TPCB_LayersOfComponent, primitiveLock?: boolean): Promise<Array<string>>;
     /**
@@ -7995,13 +8011,14 @@ declare class PCB_PrimitiveImage implements IPCB_PrimitiveAPI {
 }
 
 /**
- * PCB & 封装 / 导线图元类
+ * PCB & 封装 / 直线图元类
  *
  * @public
+ * @remarks 直线和圆弧线均为导线，对应画布的线条走线和圆弧走线
  */
 declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
     /**
-     * 创建导线
+     * 创建直线
      *
      * @public
      * @param net - 网络名称
@@ -8012,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;
@@ -8042,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 - 网络名称
@@ -8069,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>>;
 }
@@ -8423,7 +8440,7 @@ declare class PCB_SelectControl {
      */
     doCrossProbeSelect(components?: Array<string>, pins?: Array<string>, nets?: Array<string>, highlight?: boolean, select?: boolean): Promise<boolean>;
     /**
-     * 清除��中
+     * 清除选中
      *
      * @beta
      * @returns 操作是否成功
@@ -8739,7 +8756,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
      * 删除总线
      *
      * @beta
-     * @param primitiveIds - 总线的图�� ID 或总线图元对象
+     * @param primitiveIds - 总线的图元 ID 或总线图元对象
      * @returns 删除操作是否成功
      */
     delete(primitiveIds: string | ISCH_PrimitiveBus | Array<string> | Array<ISCH_PrimitiveBus>): boolean;
@@ -9022,7 +9039,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @param name - 名称，`null` 表示留空
      * @param uniqueId - 唯一 ID，`null` 表示留空
      * @param manufacturer - 制造商，`null` 表示留空
-     * @param manufacturerId - 制造商编号，`null` 表示���空
+     * @param manufacturerId - 制造商编号，`null` 表示留空
      * @param supplier - 供应商，`null` 表示留空
      * @param supplierId - 供应商编号，`null` 表示留空
      * @returns 器件图元对象
@@ -9123,7 +9140,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
      * @param y - 坐标 Y
      * @param pinNumber - 引脚编号
      * @param pinName - 引脚名称
-     * @param rotation - 旋转角度，可�� `0` `90` `180` `270`
+     * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param pinLength - 引脚长度
      * @param pinColor - 引脚颜色，`null` 表示默认
      * @param activeLow - 是否低电平有效
@@ -9308,7 +9325,7 @@ declare class SCH_PrimitiveText implements ISCH_PrimitiveAPI {
      * @beta
      * @param x - 坐标 X
      * @param y - 坐标 Y
-     * @param content - 文���内容
+     * @param content - 文本内容
      * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param textColor - 文本颜色，`null` 表示默认
      * @param fontName - 字体名称，`null` 表示默认
@@ -9390,7 +9407,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
      *
      * 如若已指定，则遵循：
      * 1. 有一个或多个坐标点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
-     * 2. 如若其他图元指定了网络，则创建失���
+     * 2. 如若其他图元指定了网络，则创建失败
      * @param color - 导线颜色，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
@@ -9706,7 +9723,7 @@ declare class SYS_FileManager {
      */
     getProjectFileByProjectUuid(projectUuid: string, fileName?: string, password?: string): Promise<File | undefined>;
     /**
-     * 使用器件 UUID 获取���件文件
+     * 使用器件 UUID 获取器件文件
      *
      * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -9762,7 +9779,7 @@ declare class SYS_FileSystem {
      * 保存文件
      *
      * @public
-     * @remarks 调用浏览器下载接口或 Electron 保存文件接口，将传入的文件流保存到本地
+     * @remarks 调用浏览器下载接口或 Electron 保存文件接口，将传入的文件流��存到本地
      * @param fileData - 文件数据
      * @param fileName - 文件名称
      */
@@ -10031,7 +10048,7 @@ declare class SYS_MessageBox {
      *
      * @public
      * @deprecated 请使用 {@link SYS_Dialog.showConfirmationMessage} 替代
-     * @remarks 显示一个拥有确认和取消按钮的���认框
+     * @remarks 显示一个拥有确认和取消按钮的确认框
      * @param content - 消息文本，支持使用 `\n` 换行
      * @param title - 确认框标题
      * @param mainButtonTitle - 主要按钮标题
@@ -10568,7 +10585,7 @@ declare type TPCB_LayersOfRegion = TPCB_LayersOfCopper | EPCB_LayerId.MULTI;
 declare type TPCB_LayerTypesOfInnerLayer = EPCB_LayerType.SIGNAL | EPCB_LayerType.INTERNAL_ELECTRICAL;
 
 /**
- * ��多边形源数组
+ * 单多边形源数组
  *
  * @public
  * @remarks

package/package.json

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