circuit-to-svg 0.0.228 → 0.0.230

package/README.md

@@ -102,7 +102,11 @@ const pcbSvg = convertCircuitJsonToPcbSvg(circuitJson, {
   `"#000"`.
 - `drawPaddingOutsideBoard` – if `false`, omit the board outline and extra
   padding around it. Defaults to `true`.
-- `shouldDrawErrors` – if `true`, display visual error indicators (red diamonds with text) for any `pcb_trace_error` elements in the circuit JSON. Defaults to `false`.
+- `shouldDrawErrors` – if `true`, display visual error indicators (red diamonds with text) for error elements in the circuit JSON. Supports:
+  - `pcb_trace_error` – errors related to PCB traces
+  - `pcb_footprint_overlap_error` – errors for overlapping pads, plated holes, and holes (displays error indicators at each affected element with connecting lines)
+  
+  Defaults to `false`.
 - `includeVersion` – if `true`, add a `data-circuit-to-svg-version` attribute to
   the root `<svg>`.
 

package/dist/index.d.ts

@@ -2,6 +2,13 @@ import { AnyCircuitElement, PcbPort, SchematicComponent } from 'circuit-json';
 import { Matrix } from 'transformation-matrix';
 import { INode } from 'svgson';
 
+interface PcbGridOptions {
+    cellSize: number;
+    lineColor?: string;
+    majorCellSize?: number;
+    majorLineColor?: string;
+}
+
 type CopperLayerName = "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
 type CopperColorMap = Record<CopperLayerName, string> & {
     [layer: string]: string;
@@ -44,6 +51,7 @@ interface Options$4 {
     drawPaddingOutsideBoard?: boolean;
     includeVersion?: boolean;
     renderSolderMask?: boolean;
+    grid?: PcbGridOptions;
 }
 interface PcbContext {
     transform: Matrix;