js-draw 1.21.3 → 1.23.1

package/dist/cjs/components/builders/CircleBuilder.d.ts

@@ -1,2 +1,8 @@
 import { ComponentBuilderFactory } from './types';
+/**
+ * Creates a stroke builder that generates outlined circles.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 export declare const makeOutlinedCircleBuilder: ComponentBuilderFactory;

package/dist/cjs/components/builders/CircleBuilder.js

@@ -9,6 +9,12 @@ const RenderablePathSpec_1 = require("../../rendering/RenderablePathSpec");
 const Viewport_1 = __importDefault(require("../../Viewport"));
 const Stroke_1 = __importDefault(require("../Stroke"));
 const makeSnapToGridAutocorrect_1 = __importDefault(require("./autocorrect/makeSnapToGridAutocorrect"));
+/**
+ * Creates a stroke builder that generates outlined circles.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 exports.makeOutlinedCircleBuilder = (0, makeSnapToGridAutocorrect_1.default)((initialPoint, viewport) => {
     return new CircleBuilder(initialPoint, viewport);
 });
@@ -26,7 +32,7 @@ class CircleBuilder {
     buildPreview() {
         const pathCommands = [];
         const numDivisions = 6;
-        const stepSize = Math.PI * 2 / numDivisions;
+        const stepSize = (Math.PI * 2) / numDivisions;
         // Round the stroke width so that when exported it doesn't have unnecessary trailing decimals.
         const strokeWidth = Viewport_1.default.roundPoint(this.endPoint.width, 5 / this.viewport.getScaleFactor());
         const center = this.startPoint.pos.lerp(this.endPoint.pos, 0.5);
@@ -38,7 +44,9 @@ class CircleBuilder {
             // controlPointRadiusScale is selected to make the circles appear circular and
             // **does** depend on stepSize.
             const controlPointRadiusScale = 1.141;
-            const controlPoint = math_1.Vec2.of(Math.cos(t - stepSize / 2), -Math.sin(t - stepSize / 2)).times(radius * controlPointRadiusScale).plus(center);
+            const controlPoint = math_1.Vec2.of(Math.cos(t - stepSize / 2), -Math.sin(t - stepSize / 2))
+                .times(radius * controlPointRadiusScale)
+                .plus(center);
             pathCommands.push({
                 kind: math_1.PathCommandType.QuadraticBezierTo,
                 controlPoint,
@@ -49,8 +57,7 @@ class CircleBuilder {
             kind: math_1.PathCommandType.LineTo,
             point: startPoint,
         });
-        const path = new math_1.Path(startPoint, pathCommands)
-            .mapPoints(point => this.viewport.roundPoint(point));
+        const path = new math_1.Path(startPoint, pathCommands).mapPoints((point) => this.viewport.roundPoint(point));
         const preview = new Stroke_1.default([
             (0, RenderablePathSpec_1.pathToRenderable)(path, {
                 fill: math_1.Color4.transparent,

package/dist/cjs/components/builders/FreehandLineBuilder.d.ts

@@ -6,6 +6,12 @@ import Viewport from '../../Viewport';
 import { StrokeDataPoint } from '../../types';
 import { ComponentBuilder, ComponentBuilderFactory } from './types';
 import RenderingStyle from '../../rendering/RenderingStyle';
+/**
+ * Creates a stroke builder that draws freehand lines.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 export declare const makeFreehandLineBuilder: ComponentBuilderFactory;
 export default class FreehandLineBuilder implements ComponentBuilder {
     private startPoint;

package/dist/cjs/components/builders/FreehandLineBuilder.js

@@ -9,6 +9,12 @@ const Stroke_1 = __importDefault(require("../Stroke"));
 const Viewport_1 = __importDefault(require("../../Viewport"));
 const StrokeSmoother_1 = require("../util/StrokeSmoother");
 const makeShapeFitAutocorrect_1 = __importDefault(require("./autocorrect/makeShapeFitAutocorrect"));
+/**
+ * Creates a stroke builder that draws freehand lines.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 exports.makeFreehandLineBuilder = (0, makeShapeFitAutocorrect_1.default)((initialPoint, viewport) => {
     // Don't smooth if input is more than ± 3 pixels from the true curve, do smooth if
     // less than ±1 px from the curve.
@@ -38,7 +44,7 @@ class FreehandLineBuilder {
             stroke: {
                 color: this.startPoint.color,
                 width: this.roundDistance(this.averageWidth),
-            }
+            },
         };
     }
     previewCurrentPath() {
@@ -135,7 +141,7 @@ class FreehandLineBuilder {
                     kind: math_1.PathCommandType.QuadraticBezierTo,
                     controlPoint: center.plus(math_1.Vec2.of(width, -width)),
                     endPoint: center.plus(math_1.Vec2.of(width, 0)),
-                }
+                },
             ];
         }
         const result = [];
@@ -163,8 +169,8 @@ class FreehandLineBuilder {
         this.curveFitter.addPoint(newPoint);
         this.widthAverageNumSamples++;
         this.averageWidth =
-            this.averageWidth * (this.widthAverageNumSamples - 1) / this.widthAverageNumSamples
-                + newPoint.width / this.widthAverageNumSamples;
+            (this.averageWidth * (this.widthAverageNumSamples - 1)) / this.widthAverageNumSamples +
+                newPoint.width / this.widthAverageNumSamples;
     }
 }
 exports.default = FreehandLineBuilder;

package/dist/cjs/components/builders/LineBuilder.d.ts

@@ -4,6 +4,12 @@ import { StrokeDataPoint } from '../../types';
 import Viewport from '../../Viewport';
 import AbstractComponent from '../AbstractComponent';
 import { ComponentBuilder, ComponentBuilderFactory } from './types';
+/**
+ * Creates a stroke builder that generates filled lines.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 export declare const makeLineBuilder: ComponentBuilderFactory;
 export default class LineBuilder implements ComponentBuilder {
     private readonly startPoint;

package/dist/cjs/components/builders/LineBuilder.js

@@ -8,6 +8,12 @@ const math_1 = require("@js-draw/math");
 const RenderablePathSpec_1 = require("../../rendering/RenderablePathSpec");
 const Stroke_1 = __importDefault(require("../Stroke"));
 const makeSnapToGridAutocorrect_1 = __importDefault(require("./autocorrect/makeSnapToGridAutocorrect"));
+/**
+ * Creates a stroke builder that generates filled lines.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 exports.makeLineBuilder = (0, makeSnapToGridAutocorrect_1.default)((initialPoint, viewport) => {
     return new LineBuilder(initialPoint, viewport);
 });
@@ -48,10 +54,8 @@ class LineBuilder {
                 kind: math_1.PathCommandType.LineTo,
                 point: startPoint.minus(scaledStartNormal),
             },
-        ]).mapPoints(point => this.viewport.roundPoint(point));
-        const preview = new Stroke_1.default([
-            (0, RenderablePathSpec_1.pathToRenderable)(path, { fill: this.startPoint.color })
-        ]);
+        ]).mapPoints((point) => this.viewport.roundPoint(point));
+        const preview = new Stroke_1.default([(0, RenderablePathSpec_1.pathToRenderable)(path, { fill: this.startPoint.color })]);
         return preview;
     }
     build() {

package/dist/cjs/components/builders/PolylineBuilder.d.ts

@@ -7,8 +7,11 @@ import { StrokeDataPoint } from '../../types';
 import { ComponentBuilder, ComponentBuilderFactory } from './types';
 import RenderingStyle from '../../rendering/RenderingStyle';
 /**
- * Creates strokes from line segments rather than Bézier curves.
+ * Creates a freehand line builder that creates strokes from line segments
+ * rather than Bézier curves.
  *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
  */
 export declare const makePolylineBuilder: ComponentBuilderFactory;
 export default class PolylineBuilder implements ComponentBuilder {

package/dist/cjs/components/builders/PolylineBuilder.js

@@ -9,8 +9,11 @@ const Stroke_1 = __importDefault(require("../Stroke"));
 const Viewport_1 = __importDefault(require("../../Viewport"));
 const makeShapeFitAutocorrect_1 = __importDefault(require("./autocorrect/makeShapeFitAutocorrect"));
 /**
- * Creates strokes from line segments rather than Bézier curves.
+ * Creates a freehand line builder that creates strokes from line segments
+ * rather than Bézier curves.
  *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
  */
 exports.makePolylineBuilder = (0, makeShapeFitAutocorrect_1.default)((initialPoint, viewport) => {
     // Fit to a value slightly smaller than the pixel size. A larger value can
@@ -48,7 +51,7 @@ class PolylineBuilder {
             stroke: {
                 color: this.startPoint.color,
                 width: this.roundDistance(this.averageWidth),
-            }
+            },
         };
     }
     previewCurrentPath() {
@@ -102,12 +105,13 @@ class PolylineBuilder {
     addPoint(newPoint) {
         this.widthAverageNumSamples++;
         this.averageWidth =
-            this.averageWidth * (this.widthAverageNumSamples - 1) / this.widthAverageNumSamples
-                + newPoint.width / this.widthAverageNumSamples;
+            (this.averageWidth * (this.widthAverageNumSamples - 1)) / this.widthAverageNumSamples +
+                newPoint.width / this.widthAverageNumSamples;
         const roundedPoint = this.roundPoint(newPoint.pos);
         if (!roundedPoint.eq(this.lastPoint)) {
             // If almost exactly in the same line as the previous
-            if (this.lastLineSegment && this.lastLineSegment.direction.dot(roundedPoint.minus(this.lastPoint).normalized()) > 0.997) {
+            if (this.lastLineSegment &&
+                this.lastLineSegment.direction.dot(roundedPoint.minus(this.lastPoint).normalized()) > 0.997) {
                 this.parts.pop();
                 this.lastPoint = this.lastLineSegment.p1;
             }

package/dist/cjs/components/builders/PressureSensitiveFreehandLineBuilder.js

@@ -36,7 +36,7 @@ class PressureSensitiveFreehandLineBuilder {
         this.parts = [];
         this.upperSegments = [];
         this.lowerSegments = [];
-        this.curveFitter = new StrokeSmoother_1.StrokeSmoother(startPoint, minFitAllowed, maxFitAllowed, curve => this.addCurve(curve));
+        this.curveFitter = new StrokeSmoother_1.StrokeSmoother(startPoint, minFitAllowed, maxFitAllowed, (curve) => this.addCurve(curve));
         this.curveStartWidth = startPoint.width;
         this.bbox = new math_1.Rect2(this.startPoint.pos.x, this.startPoint.pos.y, 0, 0);
     }
@@ -70,7 +70,8 @@ class PressureSensitiveFreehandLineBuilder {
         }
         let startPoint;
         const lastLowerSegment = lowerPath[lowerPath.length - 1];
-        if (lastLowerSegment.kind === math_1.PathCommandType.LineTo || lastLowerSegment.kind === math_1.PathCommandType.MoveTo) {
+        if (lastLowerSegment.kind === math_1.PathCommandType.LineTo ||
+            lastLowerSegment.kind === math_1.PathCommandType.MoveTo) {
             startPoint = lastLowerSegment.point;
         }
         else {
@@ -169,11 +170,11 @@ class PressureSensitiveFreehandLineBuilder {
         // where the next stroke and the previous stroke are in different directions.
         //
         // Are the exit/enter directions of the previous and current curves in different enough directions?
-        if (getEnterDirection(upperCurve).dot(getExitDirection(this.lastUpperBezier)) < 0.35
-            || getEnterDirection(lowerCurve).dot(getExitDirection(this.lastLowerBezier)) < 0.35
+        if (getEnterDirection(upperCurve).dot(getExitDirection(this.lastUpperBezier)) < 0.35 ||
+            getEnterDirection(lowerCurve).dot(getExitDirection(this.lastLowerBezier)) < 0.35 ||
             // Also handle if the curves exit/enter directions differ
-            || getEnterDirection(upperCurve).dot(getExitDirection(upperCurve)) < 0
-            || getEnterDirection(lowerCurve).dot(getExitDirection(lowerCurve)) < 0) {
+            getEnterDirection(upperCurve).dot(getExitDirection(upperCurve)) < 0 ||
+            getEnterDirection(lowerCurve).dot(getExitDirection(lowerCurve)) < 0) {
             return true;
         }
         // Check whether the lower curve intersects the other wall:
@@ -280,8 +281,9 @@ class PressureSensitiveFreehandLineBuilder {
         // Approximate the normal at the location of the control point
         const projectionT = bezier.nearestPointTo(controlPoint).parameterValue;
         const halfVecT = projectionT;
-        const halfVec = bezier.normal(halfVecT).times(curve.startWidth / 2 * halfVecT
-            + curve.endWidth / 2 * (1 - halfVecT));
+        const halfVec = bezier
+            .normal(halfVecT)
+            .times((curve.startWidth / 2) * halfVecT + (curve.endWidth / 2) * (1 - halfVecT));
         // Each starts at startPt ± startVec
         const lowerCurveStartPoint = this.roundPoint(startPt.plus(startVec));
         const lowerCurveControlPoint = this.roundPoint(controlPoint.plus(halfVec));
@@ -324,8 +326,12 @@ class PressureSensitiveFreehandLineBuilder {
         const upperCurve = new math_1.QuadraticBezier(upperCurveStartPoint, upperCurveControlPoint, upperCurveEndPoint);
         const lowerCurve = new math_1.QuadraticBezier(lowerCurveStartPoint, lowerCurveControlPoint, lowerCurveEndPoint);
         return {
-            upperCurveCommand, upperToLowerConnector, lowerToUpperConnector, lowerCurveCommand,
-            upperCurve, lowerCurve,
+            upperCurveCommand,
+            upperToLowerConnector,
+            lowerToUpperConnector,
+            lowerCurveCommand,
+            upperCurve,
+            lowerCurve,
             nextCurveStartConnector,
         };
     }

package/dist/cjs/components/builders/RectangleBuilder.d.ts

@@ -4,7 +4,19 @@ import { StrokeDataPoint } from '../../types';
 import Viewport from '../../Viewport';
 import AbstractComponent from '../AbstractComponent';
 import { ComponentBuilder, ComponentBuilderFactory } from './types';
+/**
+ * Creates filled rectangles with sharp corners.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 export declare const makeFilledRectangleBuilder: ComponentBuilderFactory;
+/**
+ * Creates outlined rectangles with sharp corners.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 export declare const makeOutlinedRectangleBuilder: ComponentBuilderFactory;
 export default class RectangleBuilder implements ComponentBuilder {
     private readonly startPoint;

package/dist/cjs/components/builders/RectangleBuilder.js

@@ -8,9 +8,21 @@ const math_1 = require("@js-draw/math");
 const RenderablePathSpec_1 = require("../../rendering/RenderablePathSpec");
 const Stroke_1 = __importDefault(require("../Stroke"));
 const makeSnapToGridAutocorrect_1 = __importDefault(require("./autocorrect/makeSnapToGridAutocorrect"));
+/**
+ * Creates filled rectangles with sharp corners.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 exports.makeFilledRectangleBuilder = (0, makeSnapToGridAutocorrect_1.default)((initialPoint, viewport) => {
     return new RectangleBuilder(initialPoint, true, viewport);
 });
+/**
+ * Creates outlined rectangles with sharp corners.
+ *
+ * Example:
+ * [[include:doc-pages/inline-examples/changing-pen-types.md]]
+ */
 exports.makeOutlinedRectangleBuilder = (0, makeSnapToGridAutocorrect_1.default)((initialPoint, viewport) => {
     return new RectangleBuilder(initialPoint, false, viewport);
 });
@@ -34,12 +46,14 @@ class RectangleBuilder {
         const startPoint = rotationMat.inverse().transformVec2(this.startPoint.pos);
         const endPoint = rotationMat.inverse().transformVec2(this.endPoint.pos);
         const rect = math_1.Rect2.fromCorners(startPoint, endPoint);
-        const path = math_1.Path.fromRect(rect, this.filled ? null : this.endPoint.width).transformedBy(
+        const path = math_1.Path.fromRect(rect, this.filled ? null : this.endPoint.width)
+            .transformedBy(
         // Rotate the canvas rectangle so that its rotation matches the screen
-        rotationMat).mapPoints(point => this.viewport.roundPoint(point));
+        rotationMat)
+            .mapPoints((point) => this.viewport.roundPoint(point));
         const preview = new Stroke_1.default([
             (0, RenderablePathSpec_1.pathToRenderable)(path, {
-                fill: this.endPoint.color
+                fill: this.endPoint.color,
             }),
         ]);
         return preview;

package/dist/cjs/components/builders/autocorrect/makeShapeFitAutocorrect.js

@@ -8,14 +8,11 @@ const makeShapeFitAutocorrect = (sourceFactory) => {
 };
 exports.default = makeShapeFitAutocorrect;
 const makeLineTemplate = (startPoint, points, _bbox) => {
-    const templatePoints = [
-        startPoint,
-        points[points.length - 1],
-    ];
-    return { points: templatePoints, };
+    const templatePoints = [startPoint, points[points.length - 1]];
+    return { points: templatePoints };
 };
 const makeRectangleTemplate = (_startPoint, _points, bbox) => {
-    return { points: [...bbox.corners, bbox.corners[0]], };
+    return { points: [...bbox.corners, bbox.corners[0]] };
 };
 class ShapeFitBuilder {
     constructor(sourceFactory, startPoint, viewport) {
@@ -41,10 +38,10 @@ class ShapeFitBuilder {
     async autocorrectShape() {
         // Use screen points so that autocorrected shapes rotate with the screen.
         const startPoint = this.viewport.canvasToScreen(this.startPoint.pos);
-        const points = this.points.map(point => this.viewport.canvasToScreen(point.pos));
+        const points = this.points.map((point) => this.viewport.canvasToScreen(point.pos));
         const bbox = math_1.Rect2.bboxOf(points);
         const snappedStartPoint = this.viewport.canvasToScreen(this.viewport.snapToGrid(this.startPoint.pos));
-        const snappedPoints = this.points.map(point => this.viewport.canvasToScreen(this.viewport.snapToGrid(point.pos)));
+        const snappedPoints = this.points.map((point) => this.viewport.canvasToScreen(this.viewport.snapToGrid(point.pos)));
         const snappedBBox = math_1.Rect2.bboxOf(snappedPoints);
         // Only fit larger shapes
         if (bbox.maxDimension < 32) {

package/dist/cjs/components/builders/autocorrect/makeSnapToGridAutocorrect.js

@@ -37,7 +37,7 @@ class SnapToGridAutocompleteBuilder {
         // Use screen points so that snapped shapes rotate with the screen.
         const startPoint = snapToGrid(this.startPoint);
         const builder = this.sourceFactory(startPoint, this.viewport);
-        const points = this.points.map(point => snapToGrid(point));
+        const points = this.points.map((point) => snapToGrid(point));
         for (const point of points) {
             builder.addPoint(point);
         }

package/dist/cjs/components/builders/lib.d.ts

@@ -0,0 +1,7 @@
+export { makeFreehandLineBuilder } from './FreehandLineBuilder';
+export { makePolylineBuilder } from './PolylineBuilder';
+export { makePressureSensitiveFreehandLineBuilder } from './PressureSensitiveFreehandLineBuilder';
+export { makeOutlinedCircleBuilder } from './CircleBuilder';
+export { makeArrowBuilder } from './ArrowBuilder';
+export { makeLineBuilder } from './LineBuilder';
+export { makeFilledRectangleBuilder, makeOutlinedRectangleBuilder } from './RectangleBuilder';

package/dist/cjs/components/builders/lib.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeOutlinedRectangleBuilder = exports.makeFilledRectangleBuilder = exports.makeLineBuilder = exports.makeArrowBuilder = exports.makeOutlinedCircleBuilder = exports.makePressureSensitiveFreehandLineBuilder = exports.makePolylineBuilder = exports.makeFreehandLineBuilder = void 0;
+var FreehandLineBuilder_1 = require("./FreehandLineBuilder");
+Object.defineProperty(exports, "makeFreehandLineBuilder", { enumerable: true, get: function () { return FreehandLineBuilder_1.makeFreehandLineBuilder; } });
+var PolylineBuilder_1 = require("./PolylineBuilder");
+Object.defineProperty(exports, "makePolylineBuilder", { enumerable: true, get: function () { return PolylineBuilder_1.makePolylineBuilder; } });
+var PressureSensitiveFreehandLineBuilder_1 = require("./PressureSensitiveFreehandLineBuilder");
+Object.defineProperty(exports, "makePressureSensitiveFreehandLineBuilder", { enumerable: true, get: function () { return PressureSensitiveFreehandLineBuilder_1.makePressureSensitiveFreehandLineBuilder; } });
+var CircleBuilder_1 = require("./CircleBuilder");
+Object.defineProperty(exports, "makeOutlinedCircleBuilder", { enumerable: true, get: function () { return CircleBuilder_1.makeOutlinedCircleBuilder; } });
+var ArrowBuilder_1 = require("./ArrowBuilder");
+Object.defineProperty(exports, "makeArrowBuilder", { enumerable: true, get: function () { return ArrowBuilder_1.makeArrowBuilder; } });
+var LineBuilder_1 = require("./LineBuilder");
+Object.defineProperty(exports, "makeLineBuilder", { enumerable: true, get: function () { return LineBuilder_1.makeLineBuilder; } });
+var RectangleBuilder_1 = require("./RectangleBuilder");
+Object.defineProperty(exports, "makeFilledRectangleBuilder", { enumerable: true, get: function () { return RectangleBuilder_1.makeFilledRectangleBuilder; } });
+Object.defineProperty(exports, "makeOutlinedRectangleBuilder", { enumerable: true, get: function () { return RectangleBuilder_1.makeOutlinedRectangleBuilder; } });

package/dist/cjs/components/lib.d.ts

@@ -1,8 +1,5 @@
 export * from './builders/types';
-export { makeFreehandLineBuilder } from './builders/FreehandLineBuilder';
-export { makePolylineBuilder } from './builders/PolylineBuilder';
-export { makePressureSensitiveFreehandLineBuilder } from './builders/PressureSensitiveFreehandLineBuilder';
-export { makeOutlinedCircleBuilder } from './builders/CircleBuilder';
+export * from './builders/lib';
 export { default as StrokeSmoother, Curve as StrokeSmootherCurve } from './util/StrokeSmoother';
 export * from './AbstractComponent';
 export { default as AbstractComponent } from './AbstractComponent';

package/dist/cjs/components/lib.js

@@ -29,16 +29,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImageComponent = exports.BackgroundComponentBackgroundType = exports.BackgroundComponent = exports.StrokeComponent = exports.Text = exports.TextComponent = exports.isRestylableComponent = exports.createRestyleComponentCommand = exports.Stroke = exports.AbstractComponent = exports.StrokeSmoother = exports.makeOutlinedCircleBuilder = exports.makePressureSensitiveFreehandLineBuilder = exports.makePolylineBuilder = exports.makeFreehandLineBuilder = void 0;
+exports.ImageComponent = exports.BackgroundComponentBackgroundType = exports.BackgroundComponent = exports.StrokeComponent = exports.Text = exports.TextComponent = exports.isRestylableComponent = exports.createRestyleComponentCommand = exports.Stroke = exports.AbstractComponent = exports.StrokeSmoother = void 0;
 __exportStar(require("./builders/types"), exports);
-var FreehandLineBuilder_1 = require("./builders/FreehandLineBuilder");
-Object.defineProperty(exports, "makeFreehandLineBuilder", { enumerable: true, get: function () { return FreehandLineBuilder_1.makeFreehandLineBuilder; } });
-var PolylineBuilder_1 = require("./builders/PolylineBuilder");
-Object.defineProperty(exports, "makePolylineBuilder", { enumerable: true, get: function () { return PolylineBuilder_1.makePolylineBuilder; } });
-var PressureSensitiveFreehandLineBuilder_1 = require("./builders/PressureSensitiveFreehandLineBuilder");
-Object.defineProperty(exports, "makePressureSensitiveFreehandLineBuilder", { enumerable: true, get: function () { return PressureSensitiveFreehandLineBuilder_1.makePressureSensitiveFreehandLineBuilder; } });
-var CircleBuilder_1 = require("./builders/CircleBuilder");
-Object.defineProperty(exports, "makeOutlinedCircleBuilder", { enumerable: true, get: function () { return CircleBuilder_1.makeOutlinedCircleBuilder; } });
+__exportStar(require("./builders/lib"), exports);
 var StrokeSmoother_1 = require("./util/StrokeSmoother");
 Object.defineProperty(exports, "StrokeSmoother", { enumerable: true, get: function () { return __importDefault(StrokeSmoother_1).default; } });
 __exportStar(require("./AbstractComponent"), exports);

package/dist/cjs/components/util/StrokeSmoother.js

@@ -56,9 +56,7 @@ class StrokeSmoother {
         console.assert(this.lastExitingVec.magnitude() !== 0, 'lastExitingVec has zero length!');
         // Use the last two points to start a new curve (the last point isn't used
         // in the current curve and we want connected curves to share end points)
-        this.buffer = [
-            this.buffer[this.buffer.length - 2], lastPoint,
-        ];
+        this.buffer = [this.buffer[this.buffer.length - 2], lastPoint];
         this.currentCurve = null;
         this.isFirstSegment = false;
     }
@@ -99,8 +97,7 @@ class StrokeSmoother {
                 return;
             }
             const threshold = Math.min(this.lastPoint.width, newPoint.width) / 3;
-            const shouldSnapToInitial = this.startPoint.pos.distanceTo(newPoint.pos) < threshold
-                && this.isFirstSegment;
+            const shouldSnapToInitial = this.startPoint.pos.distanceTo(newPoint.pos) < threshold && this.isFirstSegment;
             // Snap to the starting point if the stroke is contained within a small ball centered
             // at the starting point.
             // This allows us to create a circle/dot at the start of the stroke.
@@ -153,7 +150,9 @@ class StrokeSmoother {
         const startEndDist = segmentEnd.distanceTo(segmentStart);
         const maxControlPointDist = maxRelativeLength * startEndDist;
         // Exit in cases where we would divide by zero
-        if (maxControlPointDist === 0 || exitingVec.magnitude() === 0 || !isFinite(exitingVec.magnitude())) {
+        if (maxControlPointDist === 0 ||
+            exitingVec.magnitude() === 0 ||
+            !isFinite(exitingVec.magnitude())) {
             return;
         }
         console.assert(isFinite(enteringVec.magnitude()), 'Pre-normalized enteringVec has NaN or ∞ magnitude!');

package/dist/cjs/dialogs/makeAboutDialog.js

@@ -13,7 +13,7 @@ const makeAboutDialog = (editor, entries) => {
         const container = document.createElement(entry.minimized ? 'details' : 'div');
         container.classList.add('about-entry');
         const header = document.createElement(entry.minimized ? 'summary' : 'h2');
-        if (typeof (entry.heading) === 'string') {
+        if (typeof entry.heading === 'string') {
             header.innerText = entry.heading;
         }
         else {

package/dist/cjs/dialogs/makeMessageDialog.js

@@ -20,7 +20,7 @@ const makeAboutDialog = (editor, options) => {
     const scrollRegion = document.createElement('div');
     scrollRegion.classList.add('scroll');
     // Allow scrolling in the scrollable container -- don't forward wheel events.
-    scrollRegion.onwheel = evt => evt.stopPropagation();
+    scrollRegion.onwheel = (evt) => evt.stopPropagation();
     contentWrapper.replaceChildren(heading, scrollRegion, closeButton);
     dialog.replaceChildren(contentWrapper);
     overlay.replaceChildren(dialog);
@@ -32,7 +32,7 @@ const makeAboutDialog = (editor, options) => {
         dialog.close();
     };
     const addCloseListeners = () => {
-        dialog.addEventListener('pointerdown', event => {
+        dialog.addEventListener('pointerdown', (event) => {
             if (event.target === dialog) {
                 void closeDialog();
             }

package/dist/cjs/image/EditorImage.d.ts

@@ -22,7 +22,20 @@ export type EditorImageNotifier = EventDispatcher<EditorImageEventType, {
  */
 export type PreRenderComponentCallback = (component: AbstractComponent, componentsProcessed: number, totalComponents: number) => Promise<boolean>;
 /**
- * Handles lookup/storage of elements in the image.
+ * @summary Handles lookup/storage of elements in the image.
+ *
+ * `js-draw` images are made up of a collection of {@link AbstractComponent}s (which
+ * includes {@link Stroke}s, {@link TextComponent}s, etc.). An `EditorImage`
+ * is the data structure that stores these components.
+ *
+ * Here's how to do a few common operations:
+ * - **Get all components in a {@link @js-draw/math!Rect2 | Rect2}**:
+ *    {@link EditorImage.getElementsIntersectingRegion}.
+ * - **Draw an `EditorImage` onto a canvas/SVG**: {@link EditorImage.render}.
+ * - **Adding a new component**: {@link EditorImage.addElement}.
+ *
+ * **Example**:
+ * [[include:doc-pages/inline-examples/image-add-and-lookup.md]]
  */
 export default class EditorImage {
     private root;
@@ -40,10 +53,13 @@ export default class EditorImage {
     /** @internal */
     renderWithCache(screenRenderer: AbstractRenderer, cache: RenderingCache, viewport: Viewport): void;
     /**
-     * Renders all nodes visible from `viewport` (or all nodes if `viewport = null`).
+     * Renders this image to the given `renderer`.
      *
-     * `viewport` is used to improve rendering performance. If given, it must match
-     * the viewport used by the `renderer` (if any).
+     * If `viewport` is non-null, only components that can be seen from that viewport
+     * will be rendered. If `viewport` is `null`, **all** components are rendered.
+     *
+     * **Example**:
+     * [[include:doc-pages/inline-examples/canvas-renderer.md]]
      */
     render(renderer: AbstractRenderer, viewport: Viewport | null): void;
     /**
@@ -63,14 +79,21 @@ export default class EditorImage {
      */
     renderAll(renderer: AbstractRenderer): void;
     /**
-     * @returns all elements in the image, sorted by z-index. This can be slow for large images.
+     * @returns all elements in the image, sorted by z-index (low to high).
      *
-     * Does not include background elements. See {@link getBackgroundComponents}.
+     * This can be slow for large images. If you only need all elemenst in part of the image,
+     * consider using {@link getElementsIntersectingRegion} instead.
+     *
+     * **Note**: The result does not include background elements. See {@link getBackgroundComponents}.
      */
     getAllElements(): AbstractComponent[];
     /** Returns the number of elements added to this image. @internal */
     estimateNumElements(): number;
-    /** @returns a list of `AbstractComponent`s intersecting `region`, sorted by z-index. */
+    /**
+     * @returns a list of `AbstractComponent`s intersecting `region`, sorted by increasing z-index.
+     *
+     * Components in the background layer are only included if `includeBackground` is `true`.
+     */
     getElementsIntersectingRegion(region: Rect2, includeBackground?: boolean): AbstractComponent[];
     /** Called whenever (just after) an element is completely removed. @internal */
     onDestroyElement(elem: AbstractComponent): void;