circuit-to-svg 0.0.140 → 0.0.141

package/README.md

@@ -57,6 +57,8 @@ Converts a PCB layout description to an SVG string.
   resulting aspect ratio matches the `pcb_board` found in the circuit JSON.
 - `backgroundColor` – fill color for the SVG background rectangle. Defaults to
   `"#000"`.
+- `drawPaddingOutsideBoard` – if `false`, omit the board outline and extra
+  padding around it. Defaults to `true`.
 
 ## Contributing
 

package/dist/index.d.ts

@@ -9,11 +9,13 @@ interface Options$3 {
     layer?: "top" | "bottom";
     matchBoardAspectRatio?: boolean;
     backgroundColor?: string;
+    drawPaddingOutsideBoard?: boolean;
 }
 interface PcbContext {
     transform: Matrix;
     layer?: "top" | "bottom";
     shouldDrawErrors?: boolean;
+    drawPaddingOutsideBoard?: boolean;
 }
 declare function convertCircuitJsonToPcbSvg(circuitJson: AnyCircuitElement[], options?: Options$3): string;
 /**

package/dist/index.js

@@ -1337,6 +1337,7 @@ var OBJECT_ORDER = [
   "pcb_board"
 ];
 function convertCircuitJsonToPcbSvg(circuitJson, options) {
+  const drawPaddingOutsideBoard = options?.drawPaddingOutsideBoard ?? true;
   const layer = options?.layer;
   let minX = Number.POSITIVE_INFINITY;
   let minY = Number.POSITIVE_INFINITY;
@@ -1371,7 +1372,7 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
       updateSilkscreenBounds(circuitJsonElm);
     }
   }
-  const padding = 1;
+  const padding = drawPaddingOutsideBoard ? 1 : 0;
   const circuitWidth = maxX - minX + 2 * padding;
   const circuitHeight = maxY - minY + 2 * padding;
   let svgWidth = options?.width ?? 800;
@@ -1412,7 +1413,8 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
   const ctx = {
     transform,
     layer,
-    shouldDrawErrors: options?.shouldDrawErrors
+    shouldDrawErrors: options?.shouldDrawErrors,
+    drawPaddingOutsideBoard
   };
   let svgObjects = circuitJson.sort(
     (a, b) => (OBJECT_ORDER.indexOf(b.type) ?? 9999) - (OBJECT_ORDER.indexOf(a.type) ?? 9999)
@@ -1428,6 +1430,43 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
     const ratsNestObjects = createSvgObjectsForRatsNest(circuitJson, ctx);
     svgObjects = svgObjects.concat(ratsNestObjects);
   }
+  const children = [
+    {
+      name: "style",
+      type: "element",
+      value: "",
+      attributes: {},
+      children: [
+        {
+          type: "text",
+          value: "",
+          name: "",
+          attributes: {},
+          children: []
+        }
+      ]
+    },
+    {
+      name: "rect",
+      type: "element",
+      value: "",
+      attributes: {
+        class: "boundary",
+        x: "0",
+        y: "0",
+        fill: options?.backgroundColor ?? "#000",
+        width: svgWidth.toString(),
+        height: svgHeight.toString()
+      },
+      children: []
+    }
+  ];
+  if (drawPaddingOutsideBoard) {
+    children.push(
+      createSvgObjectFromPcbBoundary(transform, minX, minY, maxX, maxY)
+    );
+  }
+  children.push(...svgObjects);
   const svgObject = {
     name: "svg",
     type: "element",
@@ -1437,32 +1476,7 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
       height: svgHeight.toString()
     },
     value: "",
-    children: [
-      {
-        name: "style",
-        type: "element",
-        children: [
-          {
-            type: "text",
-            value: ""
-          }
-        ]
-      },
-      {
-        name: "rect",
-        type: "element",
-        attributes: {
-          class: "boundary",
-          x: "0",
-          y: "0",
-          fill: options?.backgroundColor ?? "#000",
-          width: svgWidth.toString(),
-          height: svgHeight.toString()
-        }
-      },
-      createSvgObjectFromPcbBoundary(transform, minX, minY, maxX, maxY),
-      ...svgObjects
-    ].filter((child) => child !== null)
+    children: children.filter((child) => child !== null)
   };
   try {
     return stringify(svgObject);
@@ -1570,7 +1584,7 @@ function createSvgObjects({
     case "pcb_silkscreen_path":
       return createSvgObjectsFromPcbSilkscreenPath(elm, ctx);
     case "pcb_board":
-      return createSvgObjectsFromPcbBoard(elm, ctx);
+      return ctx.drawPaddingOutsideBoard ? createSvgObjectsFromPcbBoard(elm, ctx) : [];
     case "pcb_via":
       return createSvgObjectsFromPcbVia(elm, ctx);
     case "pcb_cutout":