circuit-to-svg 0.0.229 → 0.0.230

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