@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/references/interfaces/IPCB_AutoLayoutResult.md

@@ -0,0 +1,169 @@
+# IPCB\_AutoLayoutResult interface
+
+Auto layout result
+
+## Signature
+
+```typescript
+interface IPCB_AutoLayoutResult
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[duration](./IPCB_AutoLayoutResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Auto layout duration (milliseconds)
+
+</td></tr>
+<tr><td>
+
+[failedComponents](./IPCB_AutoLayoutResult.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+List of device primitive IDs that failed to be laid out
+
+</td></tr>
+<tr><td>
+
+[success](./IPCB_AutoLayoutResult.md)
+
+</td><td>
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether auto layout started successfully
+
+</td></tr>
+<tr><td>
+
+[successComponentsCount](./IPCB_AutoLayoutResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Number of devices that were laid out successfully
+
+</td></tr>
+<tr><td>
+
+[totalComponentsCount](./IPCB_AutoLayoutResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Total number of devices participating in auto layout
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### duration
+
+# IPCB\_AutoLayoutResult.duration property
+
+Auto layout duration (milliseconds)
+
+## Signature
+
+```typescript
+duration: number;
+```
+
+### failedcomponents
+
+# IPCB\_AutoLayoutResult.failedComponents property
+
+List of device primitive IDs that failed to be laid out
+
+## Signature
+
+```typescript
+failedComponents: Array<string>;
+```
+
+### success
+
+# IPCB\_AutoLayoutResult.success property
+
+Whether auto layout started successfully
+
+## Signature
+
+```typescript
+success: boolean;
+```
+
+### successcomponentscount
+
+# IPCB\_AutoLayoutResult.successComponentsCount property
+
+Number of devices that were laid out successfully
+
+## Signature
+
+```typescript
+successComponentsCount: number;
+```
+
+### totalcomponentscount
+
+# IPCB\_AutoLayoutResult.totalComponentsCount property
+
+Total number of devices participating in auto layout
+
+## Signature
+
+```typescript
+totalComponentsCount: number;
+```

package/skill/references/interfaces/IPCB_AutoRoutingProps.md

@@ -0,0 +1,220 @@
+# IPCB\_AutoRoutingProps interface
+
+Auto routing props
+
+## Signature
+
+```typescript
+interface IPCB_AutoRoutingProps
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cornerStyle?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+[EPCB\_AutoRoutingCornerStyle](../enums/EPCB_AutoRoutingCornerStyle.md)
+
+</td><td>
+
+_(Optional)_ 布线拐角风格
+
+</td></tr>
+<tr><td>
+
+[existingPrimitiveMode?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+[EPCB\_AutoRoutingExistingPrimitiveMode](../enums/EPCB_AutoRoutingExistingPrimitiveMode.md)
+
+</td><td>
+
+_(Optional)_ 已有导线/过孔的处理方式
+
+</td></tr>
+<tr><td>
+
+[ignoreNets?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+_(Optional)_ 忽略网络
+
+</td></tr>
+<tr><td>
+
+[layers?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[TPCB\_LayersOfCopper](../types/TPCB_LayersOfCopper.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ 布线图层
+
+</td></tr>
+<tr><td>
+
+[optimization?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+[EPCB\_AutoRoutingOptimization](../enums/EPCB_AutoRoutingOptimization.md)
+
+</td><td>
+
+_(Optional)_ 效果优先级
+
+</td></tr>
+<tr><td>
+
+[RoutingNets?](./IPCB_AutoRoutingProps.md)
+
+</td><td>
+
+</td><td>
+
+'selected' \| 'selectedComponents' \| Array&lt;string&gt;
+
+</td><td>
+
+_(Optional)_ 布线网络
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### cornerstyle
+
+# IPCB\_AutoRoutingProps.cornerStyle property
+
+布线拐角风格
+
+## Signature
+
+```typescript
+cornerStyle?: EPCB_AutoRoutingCornerStyle;
+```
+
+## Remarks
+
+指定自动布线使用的拐角风格，默认为 45 度
+
+### existingprimitivemode
+
+# IPCB\_AutoRoutingProps.existingPrimitiveMode property
+
+已有导线/过孔的处理方式
+
+## Signature
+
+```typescript
+existingPrimitiveMode?: EPCB_AutoRoutingExistingPrimitiveMode;
+```
+
+## Remarks
+
+指定对画布上已有导线和过孔的处理方式，默认为保留
+
+### ignorenets
+
+# IPCB\_AutoRoutingProps.ignoreNets property
+
+忽略网络
+
+## Signature
+
+```typescript
+ignoreNets?: Array<string>;
+```
+
+## Remarks
+
+指定需要忽略（不参与自动布线）的网络名称数组；如不传入，则不忽略任何网络
+
+### layers
+
+# IPCB\_AutoRoutingProps.layers property
+
+布线图层
+
+## Signature
+
+```typescript
+layers?: Array<TPCB_LayersOfCopper>;
+```
+
+## Remarks
+
+指定允许参与自动布线的图层 ID 数组；如不传入，则使用当前 PCB 的所有可用信号层
+
+### optimization
+
+# IPCB\_AutoRoutingProps.optimization property
+
+效果优先级
+
+## Signature
+
+```typescript
+optimization?: EPCB_AutoRoutingOptimization;
+```
+
+## Remarks
+
+指定自动布线的优化目标，默认为布通率
+
+### routingnets
+
+# IPCB\_AutoRoutingProps.RoutingNets property
+
+布线网络
+
+## Signature
+
+```typescript
+RoutingNets?: 'selected' | 'selectedComponents' | Array<string>;
+```
+
+## Remarks
+
+指定需要参与自动布线的网络名称数组；如不传入或传入空数组，则对所有未布线的网络进行自动布线

package/skill/references/interfaces/IPCB_AutoRoutingResult.md

@@ -0,0 +1,169 @@
+# IPCB\_AutoRoutingResult interface
+
+Auto routing result
+
+## Signature
+
+```typescript
+interface IPCB_AutoRoutingResult
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[duration](./IPCB_AutoRoutingResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Auto routing duration (milliseconds)
+
+</td></tr>
+<tr><td>
+
+[failedNets](./IPCB_AutoRoutingResult.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+List of net names that failed to be routed
+
+</td></tr>
+<tr><td>
+
+[success](./IPCB_AutoRoutingResult.md)
+
+</td><td>
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether auto routing started successfully
+
+</td></tr>
+<tr><td>
+
+[successNetsCount](./IPCB_AutoRoutingResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Number of nets that were routed successfully
+
+</td></tr>
+<tr><td>
+
+[totalNetsCount](./IPCB_AutoRoutingResult.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Total number of nets participating in auto routing
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### duration
+
+# IPCB\_AutoRoutingResult.duration property
+
+Auto routing duration (milliseconds)
+
+## Signature
+
+```typescript
+duration: number;
+```
+
+### failednets
+
+# IPCB\_AutoRoutingResult.failedNets property
+
+List of net names that failed to be routed
+
+## Signature
+
+```typescript
+failedNets: Array<string>;
+```
+
+### success
+
+# IPCB\_AutoRoutingResult.success property
+
+Whether auto routing started successfully
+
+## Signature
+
+```typescript
+success: boolean;
+```
+
+### successnetscount
+
+# IPCB\_AutoRoutingResult.successNetsCount property
+
+Number of nets that were routed successfully
+
+## Signature
+
+```typescript
+successNetsCount: number;
+```
+
+### totalnetscount
+
+# IPCB\_AutoRoutingResult.totalNetsCount property
+
+Total number of nets participating in auto routing
+
+## Signature
+
+```typescript
+totalNetsCount: number;
+```

package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md

@@ -0,0 +1,169 @@
+# IPCB\_BomPropertiesTableColumns interface
+
+BOM column properties and sorting rules
+
+## Signature
+
+```typescript
+interface IPCB_BomPropertiesTableColumns
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[group?](./IPCB_BomPropertiesTableColumns.md)
+
+</td><td>
+
+</td><td>
+
+null \| 'Yes' \| 'No'
+
+</td><td>
+
+_(Optional)_ Whether to group
+
+</td></tr>
+<tr><td>
+
+[orderWeight?](./IPCB_BomPropertiesTableColumns.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Order weight (a larger weight is placed on the left side of the BOM first)
+
+</td></tr>
+<tr><td>
+
+[property](./IPCB_BomPropertiesTableColumns.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+Property
+
+</td></tr>
+<tr><td>
+
+[sort?](./IPCB_BomPropertiesTableColumns.md)
+
+</td><td>
+
+</td><td>
+
+null \| 'asc' \| 'desc'
+
+</td><td>
+
+_(Optional)_ Sorting rule
+
+</td></tr>
+<tr><td>
+
+[title?](./IPCB_BomPropertiesTableColumns.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Show name
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### group
+
+# IPCB\_BomPropertiesTableColumns.group property
+
+Whether to group
+
+## Signature
+
+```typescript
+group?: null | 'Yes' | 'No';
+```
+
+### orderweight
+
+# IPCB\_BomPropertiesTableColumns.orderWeight property
+
+Order weight (a larger weight is placed on the left side of the BOM first)
+
+## Signature
+
+```typescript
+orderWeight?: number;
+```
+
+### property
+
+# IPCB\_BomPropertiesTableColumns.property property
+
+Property
+
+## Signature
+
+```typescript
+property: string;
+```
+
+### sort
+
+# IPCB\_BomPropertiesTableColumns.sort property
+
+Sorting rule
+
+## Signature
+
+```typescript
+sort?: null | 'asc' | 'desc';
+```
+
+### title
+
+# IPCB\_BomPropertiesTableColumns.title property
+
+Show name
+
+## Signature
+
+```typescript
+title?: string;
+```