circuit-to-svg 0.0.133 → 0.0.134

package/README.md

@@ -50,6 +50,12 @@ Converts a schematic circuit description to an SVG string.
 
 Converts a PCB layout description to an SVG string.
 
+#### Options
+
+- `width` and `height` – dimensions of the output SVG. Defaults to `800x600`.
+- `matchBoardAspectRatio` – if `true`, adjust the SVG dimensions so the
+  resulting aspect ratio matches the `pcb_board` found in the circuit JSON.
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/index.d.ts

@@ -7,6 +7,7 @@ interface Options$3 {
     shouldDrawErrors?: boolean;
     shouldDrawRatsNest?: boolean;
     layer?: "top" | "bottom";
+    matchBoardAspectRatio?: boolean;
 }
 interface PcbContext {
     transform: Matrix;

package/dist/index.js

@@ -1323,16 +1323,27 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
   let minY = Number.POSITIVE_INFINITY;
   let maxX = Number.NEGATIVE_INFINITY;
   let maxY = Number.NEGATIVE_INFINITY;
+  let boardMinX = Number.POSITIVE_INFINITY;
+  let boardMinY = Number.POSITIVE_INFINITY;
+  let boardMaxX = Number.NEGATIVE_INFINITY;
+  let boardMaxY = Number.NEGATIVE_INFINITY;
   for (const circuitJsonElm of circuitJson) {
     if (circuitJsonElm.type === "pcb_board") {
-      if (circuitJsonElm.outline && Array.isArray(circuitJsonElm.outline) && circuitJsonElm.outline.length >= 3)
+      if (circuitJsonElm.outline && Array.isArray(circuitJsonElm.outline) && circuitJsonElm.outline.length >= 3) {
         updateBoundsToIncludeOutline(circuitJsonElm.outline);
-      else if ("center" in circuitJsonElm && "width" in circuitJsonElm && "height" in circuitJsonElm)
+        updateBoardBoundsToIncludeOutline(circuitJsonElm.outline);
+      } else if ("center" in circuitJsonElm && "width" in circuitJsonElm && "height" in circuitJsonElm) {
         updateBounds(
           circuitJsonElm.center,
           circuitJsonElm.width,
           circuitJsonElm.height
         );
+        updateBoardBounds(
+          circuitJsonElm.center,
+          circuitJsonElm.width,
+          circuitJsonElm.height
+        );
+      }
     } else if ("x" in circuitJsonElm && "y" in circuitJsonElm) {
       updateBounds({ x: circuitJsonElm.x, y: circuitJsonElm.y }, 0, 0);
     } else if ("route" in circuitJsonElm) {
@@ -1344,8 +1355,22 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
   const padding = 1;
   const circuitWidth = maxX - minX + 2 * padding;
   const circuitHeight = maxY - minY + 2 * padding;
-  const svgWidth = options?.width ?? 800;
-  const svgHeight = options?.height ?? 600;
+  let svgWidth = options?.width ?? 800;
+  let svgHeight = options?.height ?? 600;
+  if (options?.matchBoardAspectRatio) {
+    const boardWidth = boardMaxX - boardMinX;
+    const boardHeight = boardMaxY - boardMinY;
+    if (boardWidth > 0 && boardHeight > 0) {
+      const aspect = boardWidth / boardHeight;
+      if (options?.width && !options?.height) {
+        svgHeight = options.width / aspect;
+      } else if (options?.height && !options?.width) {
+        svgWidth = options.height * aspect;
+      } else {
+        svgHeight = svgWidth / aspect;
+      }
+    }
+  }
   const paths = [];
   for (const circuitJsonElm of circuitJson) {
     if ("route" in circuitJsonElm && circuitJsonElm.route !== void 0) {
@@ -1434,6 +1459,14 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
     maxX = Math.max(maxX, center.x + halfWidth);
     maxY = Math.max(maxY, center.y + halfHeight);
   }
+  function updateBoardBounds(center, width, height) {
+    const halfWidth = width / 2;
+    const halfHeight = height / 2;
+    boardMinX = Math.min(boardMinX, center.x - halfWidth);
+    boardMinY = Math.min(boardMinY, center.y - halfHeight);
+    boardMaxX = Math.max(boardMaxX, center.x + halfWidth);
+    boardMaxY = Math.max(boardMaxY, center.y + halfHeight);
+  }
   function updateBoundsToIncludeOutline(outline) {
     for (const point of outline) {
       minX = Math.min(minX, point.x);
@@ -1442,6 +1475,14 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
       maxY = Math.max(maxY, point.y);
     }
   }
+  function updateBoardBoundsToIncludeOutline(outline) {
+    for (const point of outline) {
+      boardMinX = Math.min(boardMinX, point.x);
+      boardMinY = Math.min(boardMinY, point.y);
+      boardMaxX = Math.max(boardMaxX, point.x);
+      boardMaxY = Math.max(boardMaxY, point.y);
+    }
+  }
   function updateTraceBounds(route) {
     for (const point of route) {
       minX = Math.min(minX, point.x);