@jlceda/pro-api-types 0.1.88 → 0.1.89
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 +21 -21
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -413,10 +413,10 @@ declare class DMT_Project {
|
|
|
413
413
|
* @beta
|
|
414
414
|
* @param projectFriendlyName - 工程友好名称
|
|
415
415
|
* @param projectName - 工程名称,仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`,如若不指定,则根据工程友好名称自动生成
|
|
416
|
-
* @param teamUuid - 团队 UUID
|
|
416
|
+
* @param teamUuid - 团队 UUID,如若不指定,则默认为个人;在不存在个人工程的环境下必须指定团队 UUID
|
|
417
417
|
* @param folderUuid - 文件夹 UUID,如若不指定,则为根文件夹
|
|
418
418
|
* @param description - 工程描述
|
|
419
|
-
* @param collaborationMode -
|
|
419
|
+
* @param collaborationMode - 工程协作模式,如若团队权限无需工程设置协作模式,则��参数将被忽略
|
|
420
420
|
* @returns 工程 UUID,如若为 `undefined` 则创建失败
|
|
421
421
|
*/
|
|
422
422
|
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 {
|
|
|
595
595
|
*/
|
|
596
596
|
getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
598
|
+
* 获取当前原��图图页的详细属性
|
|
599
599
|
*
|
|
600
600
|
* @beta
|
|
601
601
|
* @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
|
|
@@ -1187,7 +1187,7 @@ declare enum EPCB_LayerId {
|
|
|
1187
1187
|
SHELL_3D_TOP = 54,
|
|
1188
1188
|
/** 3D 外壳底层 */
|
|
1189
1189
|
SHELL_3D_BOTTOM = 55,
|
|
1190
|
-
/**
|
|
1190
|
+
/** 钻���图层 */
|
|
1191
1191
|
DRILL_DRAWING = 56
|
|
1192
1192
|
}
|
|
1193
1193
|
|
|
@@ -2105,7 +2105,7 @@ declare interface ILIB_DeviceSearchItem {
|
|
|
2105
2105
|
footprintName?: string;
|
|
2106
2106
|
/** 关联封装 UUID */
|
|
2107
2107
|
footprintUuid?: string;
|
|
2108
|
-
/** 关联 3D
|
|
2108
|
+
/** 关联 3D 模型名��� */
|
|
2109
2109
|
model3DName?: string;
|
|
2110
2110
|
/** 关联 3D 模型 UUID */
|
|
2111
2111
|
model3DUuid?: string;
|
|
@@ -2293,7 +2293,7 @@ declare interface ILIB_SymbolSearchItem {
|
|
|
2293
2293
|
*
|
|
2294
2294
|
* @public
|
|
2295
2295
|
* @remarks
|
|
2296
|
-
*
|
|
2296
|
+
* 复杂多边形可以包含多个单多边形,通过 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule | fill-rule} 将其组合,以实现多边形的布尔运算。
|
|
2297
2297
|
* 目前嘉立创 EDA 专业版固定使用 {@link https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule#nonzero | nonzero} 这个 fill-rule。
|
|
2298
2298
|
*/
|
|
2299
2299
|
declare class IPCB_ComplexPolygon {
|
|
@@ -3241,7 +3241,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
|
|
|
3241
3241
|
*/
|
|
3242
3242
|
getState_Rotation(): number;
|
|
3243
3243
|
/**
|
|
3244
|
-
*
|
|
3244
|
+
* 获取属��状态:是否水平镜像
|
|
3245
3245
|
*
|
|
3246
3246
|
* @public
|
|
3247
3247
|
* @returns 是否水平镜像
|
|
@@ -3408,7 +3408,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
|
|
|
3408
3408
|
*/
|
|
3409
3409
|
getState_Net(): string;
|
|
3410
3410
|
/**
|
|
3411
|
-
*
|
|
3411
|
+
* 获取属性状态:层
|
|
3412
3412
|
*
|
|
3413
3413
|
* @public
|
|
3414
3414
|
* @returns 层
|
|
@@ -3863,7 +3863,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
|
|
|
3863
3863
|
* @beta
|
|
3864
3864
|
* @remarks 如若孔不存在,则属性将不会被修改
|
|
3865
3865
|
* @param metallization - 是否金属化孔壁
|
|
3866
|
-
* @returns
|
|
3866
|
+
* @returns 焊盘图元对象
|
|
3867
3867
|
*/
|
|
3868
3868
|
setState_Metallization(metallization: boolean): IPCB_PrimitivePad;
|
|
3869
3869
|
/**
|
|
@@ -4005,7 +4005,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
|
|
|
4005
4005
|
*/
|
|
4006
4006
|
getState_PrimitiveId(): string;
|
|
4007
4007
|
/**
|
|
4008
|
-
*
|
|
4008
|
+
* 获取属性状态:网络名称
|
|
4009
4009
|
*
|
|
4010
4010
|
* @public
|
|
4011
4011
|
* @returns 网络名称
|
|
@@ -4638,7 +4638,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
|
|
|
4638
4638
|
*
|
|
4639
4639
|
* @beta
|
|
4640
4640
|
* @param x - 坐标 X
|
|
4641
|
-
* @returns
|
|
4641
|
+
* @returns 过孔图元对象
|
|
4642
4642
|
*/
|
|
4643
4643
|
setState_X(x: number): IPCB_PrimitiveVia;
|
|
4644
4644
|
/**
|
|
@@ -5671,7 +5671,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
|
|
|
5671
5671
|
private content;
|
|
5672
5672
|
/** 旋转角度 */
|
|
5673
5673
|
private rotation;
|
|
5674
|
-
/**
|
|
5674
|
+
/** 文本颜色 */
|
|
5675
5675
|
private textColor;
|
|
5676
5676
|
/** 字体名称 */
|
|
5677
5677
|
private fontName;
|
|
@@ -7185,7 +7185,7 @@ declare class PCB_Layer {
|
|
|
7185
7185
|
*
|
|
7186
7186
|
* @beta
|
|
7187
7187
|
* @remarks
|
|
7188
|
-
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC
|
|
7188
|
+
* 此处主要是为了适配 FPC 软板的设计,如若将 PCB 类型设置为 FPC 软板,将会新增 FPC 补���层图层。
|
|
7189
7189
|
*
|
|
7190
7190
|
* 请注意:
|
|
7191
7191
|
*
|
|
@@ -7360,7 +7360,7 @@ declare class PCB_ManufactureData {
|
|
|
7360
7360
|
* @param otherData - 其它
|
|
7361
7361
|
* @param layers - 导出层,默认则按照嘉立创生产需求导出
|
|
7362
7362
|
* @param objects - 导出对象,默认则按照嘉立创生产需求导出
|
|
7363
|
-
* @returns ODB++
|
|
7363
|
+
* @returns ODB++ 文件数据
|
|
7364
7364
|
*/
|
|
7365
7365
|
getOpenDatabaseDoublePlusFile(fileName?: string, unit?: ESYS_Unit.INCH, otherData?: {
|
|
7366
7366
|
metallizedDrilledHoles?: boolean;
|
|
@@ -7581,7 +7581,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
|
|
|
7581
7581
|
* @param arcAngle - 圆弧角度
|
|
7582
7582
|
* @param lineWidth - 线宽
|
|
7583
7583
|
* @param interactiveMode - 交互模式
|
|
7584
|
-
* @param primitiveLock -
|
|
7584
|
+
* @param primitiveLock - 是否锁定
|
|
7585
7585
|
* @returns 圆弧线图元对象
|
|
7586
7586
|
*/
|
|
7587
7587
|
create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, arcAngle: number, lineWidth?: number, interactiveMode?: EPCB_PrimitiveArcInteractiveMode, primitiveLock?: boolean): Promise<IPCB_PrimitiveArc | undefined>;
|
|
@@ -7679,7 +7679,7 @@ declare class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI {
|
|
|
7679
7679
|
*
|
|
7680
7680
|
* @beta
|
|
7681
7681
|
* @param primitiveIds - 器件的图元 ID 或器件图元对象
|
|
7682
|
-
* @returns
|
|
7682
|
+
* @returns 删��操作是否成功
|
|
7683
7683
|
*/
|
|
7684
7684
|
delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;
|
|
7685
7685
|
/**
|
|
@@ -8295,7 +8295,7 @@ declare class PCB_PrimitiveVia implements IPCB_PrimitiveAPI {
|
|
|
8295
8295
|
* @beta
|
|
8296
8296
|
* @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
|
|
8297
8297
|
* @param primitiveIds - 过孔的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
|
|
8298
|
-
* @returns
|
|
8298
|
+
* @returns 过孔图元对象,空数组表示获取失��
|
|
8299
8299
|
*/
|
|
8300
8300
|
get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveVia>>;
|
|
8301
8301
|
/**
|
|
@@ -8819,7 +8819,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
|
|
|
8819
8819
|
*
|
|
8820
8820
|
* @beta
|
|
8821
8821
|
* @param component - 关联库器件
|
|
8822
|
-
* @returns
|
|
8822
|
+
* @returns 操作是否成功
|
|
8823
8823
|
*/
|
|
8824
8824
|
setNetFlagComponentUuid_Ground(component: {
|
|
8825
8825
|
libraryUuid: string;
|
|
@@ -9107,7 +9107,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
|
|
|
9107
9107
|
*
|
|
9108
9108
|
* @beta
|
|
9109
9109
|
* @param line - 坐标组,连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线
|
|
9110
|
-
* @param color - 颜色,`null`
|
|
9110
|
+
* @param color - 颜色,`null` 表示默认
|
|
9111
9111
|
* @param fillColor - 填充颜色,`none` 表示无填充,`null` 表示默认
|
|
9112
9112
|
* @param lineWidth - 线宽,范围 `1-10`,`null` 表示默认
|
|
9113
9113
|
* @param lineType - 线型,`0` 实线,`1` 短划线,`2` 点线,`3` 点划线,`null` 表示默认
|
|
@@ -10298,7 +10298,7 @@ declare class SYS_WebSocket {
|
|
|
10298
10298
|
* 可以用来执行前检测 WebSocket 连接是否正常,但需要注意 **不要尝试相同 ID 不同参数的连接**,这会造成混乱:
|
|
10299
10299
|
* 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接,那么其余参数的变更将不会被应用
|
|
10300
10300
|
*
|
|
10301
|
-
*
|
|
10301
|
+
* 注意:本接口需要使用者启用扩展的外部���互权限,如若未启用将始终 `throw Error`
|
|
10302
10302
|
* @param id - 自定义 WebSocket ID
|
|
10303
10303
|
* @param serviceUri - WebSocket 服务地址
|
|
10304
10304
|
* @param receiveMessageCallFn - 接收到消息时的回调函数
|
|
@@ -10377,7 +10377,7 @@ declare class SYS_Window {
|
|
|
10377
10377
|
declare type TPCB_LayersInTheSelectable = TPCB_LayersOfInner | TPCB_LayersOfCustom | EPCB_LayerId.TOP | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.TOP_STIFFENER | EPCB_LayerId.BOTTOM | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.BOTTOM_STIFFENER | EPCB_LayerId.BOARD_OUTLINE | EPCB_LayerId.MULTI | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.DRILL_DRAWING | EPCB_LayerId.RATLINE | EPCB_LayerId.COMPONENT_SHAPE | EPCB_LayerId.COMPONENT_MARKING | EPCB_LayerId.PIN_SOLDERING | EPCB_LayerId.PIN_FLOATING | EPCB_LayerId.SHELL_3D_OUTLINE | EPCB_LayerId.SHELL_3D_TOP | EPCB_LayerId.SHELL_3D_BOTTOM;
|
|
10378
10378
|
|
|
10379
10379
|
/**
|
|
10380
|
-
*
|
|
10380
|
+
* ��件所属层
|
|
10381
10381
|
*
|
|
10382
10382
|
* @public
|
|
10383
10383
|
*/
|