circuit-json 0.0.276 → 0.0.277
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/README.md +126 -0
- package/dist/index.d.mts +893 -23
- package/dist/index.mjs +339 -243
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -103,6 +103,11 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
103
103
|
- [PcbManualEditConflictWarning](#pcbmanualeditconflictwarning)
|
|
104
104
|
- [PcbMissingFootprintError](#pcbmissingfootprinterror)
|
|
105
105
|
- [PcbNet](#pcbnet)
|
|
106
|
+
- [PcbNoteDimension](#pcbnotedimension)
|
|
107
|
+
- [PcbNoteLine](#pcbnoteline)
|
|
108
|
+
- [PcbNotePath](#pcbnotepath)
|
|
109
|
+
- [PcbNoteRect](#pcbnoterect)
|
|
110
|
+
- [PcbNoteText](#pcbnotetext)
|
|
106
111
|
- [PcbPlacementError](#pcbplacementerror)
|
|
107
112
|
- [PcbPlatedHole](#pcbplatedhole)
|
|
108
113
|
- [PcbPort](#pcbport)
|
|
@@ -1244,6 +1249,127 @@ interface PcbNet {
|
|
|
1244
1249
|
}
|
|
1245
1250
|
```
|
|
1246
1251
|
|
|
1252
|
+
### PcbNoteDimension
|
|
1253
|
+
|
|
1254
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_dimension.ts)
|
|
1255
|
+
|
|
1256
|
+
Defines a measurement annotation within PCB documentation notes
|
|
1257
|
+
|
|
1258
|
+
```typescript
|
|
1259
|
+
/** Defines a measurement annotation within PCB documentation notes */
|
|
1260
|
+
interface PcbNoteDimension {
|
|
1261
|
+
type: "pcb_note_dimension"
|
|
1262
|
+
pcb_note_dimension_id: string
|
|
1263
|
+
pcb_component_id?: string
|
|
1264
|
+
pcb_group_id?: string
|
|
1265
|
+
subcircuit_id?: string
|
|
1266
|
+
from: Point
|
|
1267
|
+
to: Point
|
|
1268
|
+
text?: string
|
|
1269
|
+
font: "tscircuit2024"
|
|
1270
|
+
font_size: Length
|
|
1271
|
+
color?: string
|
|
1272
|
+
arrow_size: Length
|
|
1273
|
+
}
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
### PcbNoteLine
|
|
1277
|
+
|
|
1278
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_line.ts)
|
|
1279
|
+
|
|
1280
|
+
Defines a straight documentation note line on the PCB
|
|
1281
|
+
|
|
1282
|
+
```typescript
|
|
1283
|
+
/** Defines a straight documentation note line on the PCB */
|
|
1284
|
+
interface PcbNoteLine {
|
|
1285
|
+
type: "pcb_note_line"
|
|
1286
|
+
pcb_note_line_id: string
|
|
1287
|
+
pcb_component_id?: string
|
|
1288
|
+
pcb_group_id?: string
|
|
1289
|
+
subcircuit_id?: string
|
|
1290
|
+
x1: Distance
|
|
1291
|
+
y1: Distance
|
|
1292
|
+
x2: Distance
|
|
1293
|
+
y2: Distance
|
|
1294
|
+
stroke_width: Distance
|
|
1295
|
+
color?: string
|
|
1296
|
+
is_dashed?: boolean
|
|
1297
|
+
}
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
### PcbNotePath
|
|
1301
|
+
|
|
1302
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_path.ts)
|
|
1303
|
+
|
|
1304
|
+
Defines a polyline documentation note on the PCB
|
|
1305
|
+
|
|
1306
|
+
```typescript
|
|
1307
|
+
/** Defines a polyline documentation note on the PCB */
|
|
1308
|
+
interface PcbNotePath {
|
|
1309
|
+
type: "pcb_note_path"
|
|
1310
|
+
pcb_note_path_id: string
|
|
1311
|
+
pcb_component_id?: string
|
|
1312
|
+
pcb_group_id?: string
|
|
1313
|
+
subcircuit_id?: string
|
|
1314
|
+
route: Point[]
|
|
1315
|
+
stroke_width: Length
|
|
1316
|
+
color?: string
|
|
1317
|
+
}
|
|
1318
|
+
```
|
|
1319
|
+
|
|
1320
|
+
### PcbNoteRect
|
|
1321
|
+
|
|
1322
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_rect.ts)
|
|
1323
|
+
|
|
1324
|
+
Defines a rectangular documentation note on the PCB
|
|
1325
|
+
|
|
1326
|
+
```typescript
|
|
1327
|
+
/** Defines a rectangular documentation note on the PCB */
|
|
1328
|
+
interface PcbNoteRect {
|
|
1329
|
+
type: "pcb_note_rect"
|
|
1330
|
+
pcb_note_rect_id: string
|
|
1331
|
+
pcb_component_id?: string
|
|
1332
|
+
pcb_group_id?: string
|
|
1333
|
+
subcircuit_id?: string
|
|
1334
|
+
center: Point
|
|
1335
|
+
width: Length
|
|
1336
|
+
height: Length
|
|
1337
|
+
stroke_width: Length
|
|
1338
|
+
is_filled?: boolean
|
|
1339
|
+
has_stroke?: boolean
|
|
1340
|
+
is_stroke_dashed?: boolean
|
|
1341
|
+
color?: string
|
|
1342
|
+
}
|
|
1343
|
+
```
|
|
1344
|
+
|
|
1345
|
+
### PcbNoteText
|
|
1346
|
+
|
|
1347
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_text.ts)
|
|
1348
|
+
|
|
1349
|
+
Defines a documentation note in text on the PCB
|
|
1350
|
+
|
|
1351
|
+
```typescript
|
|
1352
|
+
/** Defines a documentation note in text on the PCB */
|
|
1353
|
+
interface PcbNoteText {
|
|
1354
|
+
type: "pcb_note_text"
|
|
1355
|
+
pcb_note_text_id: string
|
|
1356
|
+
pcb_component_id?: string
|
|
1357
|
+
pcb_group_id?: string
|
|
1358
|
+
subcircuit_id?: string
|
|
1359
|
+
font: "tscircuit2024"
|
|
1360
|
+
font_size: Length
|
|
1361
|
+
text: string
|
|
1362
|
+
anchor_position: Point
|
|
1363
|
+
anchor_alignment:
|
|
1364
|
+
| "center"
|
|
1365
|
+
| "top_left"
|
|
1366
|
+
| "top_right"
|
|
1367
|
+
| "bottom_left"
|
|
1368
|
+
| "bottom_right"
|
|
1369
|
+
color?: string
|
|
1370
|
+
}
|
|
1371
|
+
```
|
|
1372
|
+
|
|
1247
1373
|
### PcbPlacementError
|
|
1248
1374
|
|
|
1249
1375
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_placement_error.ts)
|