circuit-json 0.0.276 → 0.0.278
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 +153 -0
- package/dist/index.d.mts +1534 -413
- package/dist/index.mjs +363 -243
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -92,6 +92,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
92
92
|
- [PcbCourtyardOutline](#pcbcourtyardoutline)
|
|
93
93
|
- [PcbCourtyardRect](#pcbcourtyardrect)
|
|
94
94
|
- [PcbCutout](#pcbcutout)
|
|
95
|
+
- [PcbFabricationNoteDimension](#pcbfabricationnotedimension)
|
|
95
96
|
- [PcbFabricationNotePath](#pcbfabricationnotepath)
|
|
96
97
|
- [PcbFabricationNoteRect](#pcbfabricationnoterect)
|
|
97
98
|
- [PcbFabricationNoteText](#pcbfabricationnotetext)
|
|
@@ -103,6 +104,11 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
103
104
|
- [PcbManualEditConflictWarning](#pcbmanualeditconflictwarning)
|
|
104
105
|
- [PcbMissingFootprintError](#pcbmissingfootprinterror)
|
|
105
106
|
- [PcbNet](#pcbnet)
|
|
107
|
+
- [PcbNoteDimension](#pcbnotedimension)
|
|
108
|
+
- [PcbNoteLine](#pcbnoteline)
|
|
109
|
+
- [PcbNotePath](#pcbnotepath)
|
|
110
|
+
- [PcbNoteRect](#pcbnoterect)
|
|
111
|
+
- [PcbNoteText](#pcbnotetext)
|
|
106
112
|
- [PcbPlacementError](#pcbplacementerror)
|
|
107
113
|
- [PcbPlatedHole](#pcbplatedhole)
|
|
108
114
|
- [PcbPort](#pcbport)
|
|
@@ -1009,6 +1015,32 @@ interface PcbCutoutRect {
|
|
|
1009
1015
|
}
|
|
1010
1016
|
```
|
|
1011
1017
|
|
|
1018
|
+
### PcbFabricationNoteDimension
|
|
1019
|
+
|
|
1020
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_dimension.ts)
|
|
1021
|
+
|
|
1022
|
+
Defines a measurement annotation within PCB fabrication notes
|
|
1023
|
+
|
|
1024
|
+
```typescript
|
|
1025
|
+
/** Defines a measurement annotation within PCB fabrication notes */
|
|
1026
|
+
interface PcbFabricationNoteDimension {
|
|
1027
|
+
type: "pcb_fabrication_note_dimension"
|
|
1028
|
+
pcb_fabrication_note_dimension_id: string
|
|
1029
|
+
pcb_component_id: string
|
|
1030
|
+
pcb_group_id?: string
|
|
1031
|
+
subcircuit_id?: string
|
|
1032
|
+
layer: VisibleLayer
|
|
1033
|
+
from: Point | string
|
|
1034
|
+
to: Point | string
|
|
1035
|
+
text?: string
|
|
1036
|
+
offset?: Length
|
|
1037
|
+
font: "tscircuit2024"
|
|
1038
|
+
font_size: Length
|
|
1039
|
+
color?: string
|
|
1040
|
+
arrow_size: Length
|
|
1041
|
+
}
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1012
1044
|
### PcbFabricationNotePath
|
|
1013
1045
|
|
|
1014
1046
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_path.ts)
|
|
@@ -1244,6 +1276,127 @@ interface PcbNet {
|
|
|
1244
1276
|
}
|
|
1245
1277
|
```
|
|
1246
1278
|
|
|
1279
|
+
### PcbNoteDimension
|
|
1280
|
+
|
|
1281
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_dimension.ts)
|
|
1282
|
+
|
|
1283
|
+
Defines a measurement annotation within PCB documentation notes
|
|
1284
|
+
|
|
1285
|
+
```typescript
|
|
1286
|
+
/** Defines a measurement annotation within PCB documentation notes */
|
|
1287
|
+
interface PcbNoteDimension {
|
|
1288
|
+
type: "pcb_note_dimension"
|
|
1289
|
+
pcb_note_dimension_id: string
|
|
1290
|
+
pcb_component_id?: string
|
|
1291
|
+
pcb_group_id?: string
|
|
1292
|
+
subcircuit_id?: string
|
|
1293
|
+
from: Point
|
|
1294
|
+
to: Point
|
|
1295
|
+
text?: string
|
|
1296
|
+
font: "tscircuit2024"
|
|
1297
|
+
font_size: Length
|
|
1298
|
+
color?: string
|
|
1299
|
+
arrow_size: Length
|
|
1300
|
+
}
|
|
1301
|
+
```
|
|
1302
|
+
|
|
1303
|
+
### PcbNoteLine
|
|
1304
|
+
|
|
1305
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_line.ts)
|
|
1306
|
+
|
|
1307
|
+
Defines a straight documentation note line on the PCB
|
|
1308
|
+
|
|
1309
|
+
```typescript
|
|
1310
|
+
/** Defines a straight documentation note line on the PCB */
|
|
1311
|
+
interface PcbNoteLine {
|
|
1312
|
+
type: "pcb_note_line"
|
|
1313
|
+
pcb_note_line_id: string
|
|
1314
|
+
pcb_component_id?: string
|
|
1315
|
+
pcb_group_id?: string
|
|
1316
|
+
subcircuit_id?: string
|
|
1317
|
+
x1: Distance
|
|
1318
|
+
y1: Distance
|
|
1319
|
+
x2: Distance
|
|
1320
|
+
y2: Distance
|
|
1321
|
+
stroke_width: Distance
|
|
1322
|
+
color?: string
|
|
1323
|
+
is_dashed?: boolean
|
|
1324
|
+
}
|
|
1325
|
+
```
|
|
1326
|
+
|
|
1327
|
+
### PcbNotePath
|
|
1328
|
+
|
|
1329
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_path.ts)
|
|
1330
|
+
|
|
1331
|
+
Defines a polyline documentation note on the PCB
|
|
1332
|
+
|
|
1333
|
+
```typescript
|
|
1334
|
+
/** Defines a polyline documentation note on the PCB */
|
|
1335
|
+
interface PcbNotePath {
|
|
1336
|
+
type: "pcb_note_path"
|
|
1337
|
+
pcb_note_path_id: string
|
|
1338
|
+
pcb_component_id?: string
|
|
1339
|
+
pcb_group_id?: string
|
|
1340
|
+
subcircuit_id?: string
|
|
1341
|
+
route: Point[]
|
|
1342
|
+
stroke_width: Length
|
|
1343
|
+
color?: string
|
|
1344
|
+
}
|
|
1345
|
+
```
|
|
1346
|
+
|
|
1347
|
+
### PcbNoteRect
|
|
1348
|
+
|
|
1349
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_rect.ts)
|
|
1350
|
+
|
|
1351
|
+
Defines a rectangular documentation note on the PCB
|
|
1352
|
+
|
|
1353
|
+
```typescript
|
|
1354
|
+
/** Defines a rectangular documentation note on the PCB */
|
|
1355
|
+
interface PcbNoteRect {
|
|
1356
|
+
type: "pcb_note_rect"
|
|
1357
|
+
pcb_note_rect_id: string
|
|
1358
|
+
pcb_component_id?: string
|
|
1359
|
+
pcb_group_id?: string
|
|
1360
|
+
subcircuit_id?: string
|
|
1361
|
+
center: Point
|
|
1362
|
+
width: Length
|
|
1363
|
+
height: Length
|
|
1364
|
+
stroke_width: Length
|
|
1365
|
+
is_filled?: boolean
|
|
1366
|
+
has_stroke?: boolean
|
|
1367
|
+
is_stroke_dashed?: boolean
|
|
1368
|
+
color?: string
|
|
1369
|
+
}
|
|
1370
|
+
```
|
|
1371
|
+
|
|
1372
|
+
### PcbNoteText
|
|
1373
|
+
|
|
1374
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_note_text.ts)
|
|
1375
|
+
|
|
1376
|
+
Defines a documentation note in text on the PCB
|
|
1377
|
+
|
|
1378
|
+
```typescript
|
|
1379
|
+
/** Defines a documentation note in text on the PCB */
|
|
1380
|
+
interface PcbNoteText {
|
|
1381
|
+
type: "pcb_note_text"
|
|
1382
|
+
pcb_note_text_id: string
|
|
1383
|
+
pcb_component_id?: string
|
|
1384
|
+
pcb_group_id?: string
|
|
1385
|
+
subcircuit_id?: string
|
|
1386
|
+
font: "tscircuit2024"
|
|
1387
|
+
font_size: Length
|
|
1388
|
+
text: string
|
|
1389
|
+
anchor_position: Point
|
|
1390
|
+
anchor_alignment:
|
|
1391
|
+
| "center"
|
|
1392
|
+
| "top_left"
|
|
1393
|
+
| "top_right"
|
|
1394
|
+
| "bottom_left"
|
|
1395
|
+
| "bottom_right"
|
|
1396
|
+
color?: string
|
|
1397
|
+
}
|
|
1398
|
+
```
|
|
1399
|
+
|
|
1247
1400
|
### PcbPlacementError
|
|
1248
1401
|
|
|
1249
1402
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_placement_error.ts)
|