plotboilerplate 1.27.0 → 1.28.0

package/src/_esm/src/ts/utils/helpers/VEllipseHelper.js

@@ -0,0 +1,83 @@
+/**
+ * A helper for VEllipses.
+ *
+ * @author   Ikaros Kappler
+ * @date     2025-03-31
+ * @modified 2025-04-02 Adding `VEllipseHelper.drawHandleLines()`.
+ * @modified 2025-04-09 Adding `VEllipseHelper.destroy()`.
+ * @modified 2025-05-05 Fixed a typo in the `VEllipseHelper.destroy` method (was named `detroy`).
+ * @modified 2025-05-05 `VEllipseHelper` is now implementing `IShapeInteractionHelper`.
+ * @version  1.0.1
+ */
+import { Line } from "../../Line";
+export class VEllipseHelper {
+    constructor(ellipse, rotationControlPoint) {
+        this.ellipse = ellipse;
+        this.rotationControlPoint = rotationControlPoint;
+        // const rotationControlLine: Line = new Line(ellipse.center, rotationControlPoint);
+        this._rotationControlLine = new Line(ellipse.center, rotationControlPoint);
+        // +---------------------------------------------------------------------
+        // | Listen for the center to be moved.
+        // +-------------------------------------------
+        // ellipse.center.listeners.addDragListener((event: VertEvent) => {
+        //   rotationControlPoint.add(event.params.dragAmount);
+        // });
+        ellipse.center.listeners.addDragListener((this._centerPointHandler = this._handleDragCenterPoint()));
+        // +---------------------------------------------------------------------
+        // | Listen for rotation changes.
+        // +-------------------------------------------
+        // rotationControlPoint.listeners.addDragListener((_event: VertEvent) => {
+        //   var newRotation = rotationControlLine.angle();
+        //   var rDiff = newRotation - ellipse.rotation;
+        //   ellipse.rotation = newRotation;
+        //   ellipse.axis.rotate(rDiff, ellipse.center);
+        // });
+        rotationControlPoint.listeners.addDragListener((this._rotationPointHandler = this._handleRotationCenterPoint()));
+    }
+    _handleDragCenterPoint() {
+        const _self = this;
+        return (event) => {
+            _self.rotationControlPoint.add(event.params.dragAmount);
+        };
+    }
+    _handleRotationCenterPoint() {
+        const _self = this;
+        return (_event) => {
+            var newRotation = _self._rotationControlLine.angle();
+            var rDiff = newRotation - _self.ellipse.rotation;
+            _self.ellipse.rotation = newRotation;
+            _self.ellipse.axis.rotate(rDiff, _self.ellipse.center);
+        };
+    }
+    /**
+     * Draw grey handle lines.
+     *
+     * @param {DrawLib<any>} draw - The draw library instance to use.
+     * @param {DrawLib<any>} fill - The fill library instance to use.
+     */
+    drawHandleLines(draw, fill) {
+        // Draw rotation handle line
+        draw.line(this.ellipse.center, this.rotationControlPoint, "rgba(192,64,128,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        // Draw helper box
+        draw.setCurrentId(`${this.ellipse.uid}_e0`);
+        draw.setCurrentClassName(`${this.ellipse.className}-v-line`);
+        draw.line(this.ellipse.center.clone().add(0, this.ellipse.signedRadiusV()).rotate(this.ellipse.rotation, this.ellipse.center), this.ellipse.axis, "rgba(64,128,192,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        draw.setCurrentId(`${this.ellipse.uid}_e1`);
+        draw.setCurrentClassName(`${this.ellipse.className}-h-line`);
+        draw.line(this.ellipse.center.clone().add(this.ellipse.signedRadiusH(), 0).rotate(this.ellipse.rotation, this.ellipse.center), this.ellipse.axis, "rgba(64,128,192,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+    }
+    destroy() {
+        this.ellipse.center.listeners.removeDragListener(this._centerPointHandler);
+        this.rotationControlPoint.listeners.removeDragListener(this._rotationPointHandler);
+    }
+}
+//# sourceMappingURL=VEllipseHelper.js.map

package/src/_esm/src/ts/utils/helpers/VEllipseHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VEllipseHelper.js","sourceRoot":"","sources":["../../../../../ts/utils/helpers/VEllipseHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAMlC,MAAM,OAAO,cAAc;IASzB,YAAY,OAAiB,EAAE,oBAA4B;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAEjD,oFAAoF;QACpF,IAAI,CAAC,oBAAoB,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QAE3E,yEAAyE;QACzE,uCAAuC;QACvC,+CAA+C;QAC/C,mEAAmE;QACnE,uDAAuD;QACvD,MAAM;QACN,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;QAErG,yEAAyE;QACzE,iCAAiC;QACjC,+CAA+C;QAC/C,0EAA0E;QAC1E,mDAAmD;QACnD,gDAAgD;QAChD,oCAAoC;QACpC,gDAAgD;QAChD,MAAM;QACN,oBAAoB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC;IACnH,CAAC;IAEO,sBAAsB;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,OAAO,CAAC,KAAgB,EAAE,EAAE;YAC1B,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC;IACJ,CAAC;IAEO,0BAA0B;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,OAAO,CAAC,MAAiB,EAAE,EAAE;YAC3B,IAAI,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;YACrD,IAAI,KAAK,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YACjD,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC;YACrC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAkB,EAAE,IAAkB;QACpD,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,wBAAwB,EAAE,GAAG,EAAE;YACvF,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CAAC,CAAC;QACH,kBAAkB;QAClB,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EACnH,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,wBAAwB,EACxB,GAAG,EACH;YACE,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CACF,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EACnH,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,wBAAwB,EACxB,GAAG,EACH;YACE,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3E,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACrF,CAAC;CACF"}

package/src/_esm/src/ts/utils/helpers/VEllipseSectorHelper.d.ts

@@ -0,0 +1,52 @@
+/**
+ * A helper for VEllipseSectors.
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-03-24
+ * @modified 2025-04-02 Adding `VEllipseSectorHelper.drawHandleLines`.
+ * @modified 2025-04-07 Modifying the calculation of `startAngle` and `endAngle` from the rotation control point: wrapping result into [0,TWO_PI).
+ * @modified 2025-04-09 Adding the `VEllipseSectorHelper.destroy` method.
+ * @modified 2025-05-05 `VEllipseSectorHelper` is now implementing `IShapeInteractionHelper`.
+ * @version  1.1.0
+ */
+import { VEllipseSector } from "../../VEllipseSector";
+import { Vertex } from "../../Vertex";
+import { DrawLib, IShapeInteractionHelper } from "../../interfaces";
+export declare class VEllipseSectorHelper implements IShapeInteractionHelper {
+    private sector;
+    private startAngleControlPoint;
+    private endAngleControlPoint;
+    private rotationControlPoint;
+    private _rotationControlLine;
+    private _startAngleControlLine;
+    private _endAngleControlLine;
+    private _centerHandler;
+    private _rotationHandler;
+    private _startAngleHandler;
+    private _endAngleHandler;
+    constructor(sector: VEllipseSector, startAngleControlPoint: Vertex, endAngleControlPoint: Vertex, rotationControlPoint: Vertex);
+    /**
+     * Creates a new drag handler for the circle sector's start control point.
+     *
+     * @private
+     * @method _handleDragStartControlPoint
+     * @instance
+     * @memberof CircleSectorHelper
+     * @returns A new event handler.
+     */
+    private _handleDragCenterPoint;
+    private _handleDragRotationControlPoint;
+    private _handleDragStartAngleControlPoint;
+    private _handleDragEndAngleControlPoint;
+    /**
+     * Draw grey handle lines.
+     *
+     * @param {DrawLib<any>} draw - The draw library instance to use.
+     * @param {DrawLib<any>} fill - The fill library instance to use.
+     */
+    drawHandleLines(draw: DrawLib<any>, fill: DrawLib<any>): void;
+    /**
+     * Destroy this VEllipseHandler which means: all listeners are being removed.
+     */
+    destroy(): void;
+}

package/src/_esm/src/ts/utils/helpers/VEllipseSectorHelper.js

@@ -0,0 +1,130 @@
+/**
+ * A helper for VEllipseSectors.
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-03-24
+ * @modified 2025-04-02 Adding `VEllipseSectorHelper.drawHandleLines`.
+ * @modified 2025-04-07 Modifying the calculation of `startAngle` and `endAngle` from the rotation control point: wrapping result into [0,TWO_PI).
+ * @modified 2025-04-09 Adding the `VEllipseSectorHelper.destroy` method.
+ * @modified 2025-05-05 `VEllipseSectorHelper` is now implementing `IShapeInteractionHelper`.
+ * @version  1.1.0
+ */
+import { Line } from "../../Line";
+import { geomutils } from "../../geomutils";
+export class VEllipseSectorHelper {
+    constructor(sector, startAngleControlPoint, endAngleControlPoint, rotationControlPoint) {
+        this.sector = sector;
+        this.startAngleControlPoint = startAngleControlPoint;
+        this.endAngleControlPoint = endAngleControlPoint;
+        this.rotationControlPoint = rotationControlPoint;
+        // const rotationControlLine: Line = new Line(sector.ellipse.center, rotationControlPoint);
+        this._rotationControlLine = new Line(sector.ellipse.center, rotationControlPoint);
+        // const startAngleControlLine: Line = new Line(sector.ellipse.center, startAngleControlPoint);
+        this._startAngleControlLine = new Line(sector.ellipse.center, startAngleControlPoint);
+        // const endAngleControlLine: Line = new Line(sector.ellipse.center, endAngleControlPoint);
+        this._endAngleControlLine = new Line(sector.ellipse.center, endAngleControlPoint);
+        // +---------------------------------------------------------------------
+        // | Listen for the center to be moved.
+        // +-------------------------------------------
+        sector.ellipse.center.listeners.addDragListener((this._centerHandler = this._handleDragCenterPoint()));
+        // +---------------------------------------------------------------------
+        // | Listen for rotation changes.
+        // +-------------------------------------------
+        rotationControlPoint.listeners.addDragListener((this._rotationHandler = this._handleDragRotationControlPoint()));
+        // +---------------------------------------------------------------------
+        // | Listen for start angle changes.
+        // +-------------------------------------------
+        startAngleControlPoint.listeners.addDragListener((this._startAngleHandler = this._handleDragStartAngleControlPoint()));
+        // +---------------------------------------------------------------------
+        // | Listen for end angle changes.
+        // +-------------------------------------------
+        endAngleControlPoint.listeners.addDragListener((this._endAngleHandler = this._handleDragEndAngleControlPoint()));
+    }
+    /**
+     * Creates a new drag handler for the circle sector's start control point.
+     *
+     * @private
+     * @method _handleDragStartControlPoint
+     * @instance
+     * @memberof CircleSectorHelper
+     * @returns A new event handler.
+     */
+    _handleDragCenterPoint() {
+        const _self = this;
+        return (event) => {
+            _self.startAngleControlPoint.add(event.params.dragAmount);
+            _self.endAngleControlPoint.add(event.params.dragAmount);
+            _self.rotationControlPoint.add(event.params.dragAmount);
+        };
+    }
+    _handleDragRotationControlPoint() {
+        const _self = this;
+        return (event) => {
+            const newRotation = _self._rotationControlLine.angle();
+            const rDiff = newRotation - _self.sector.ellipse.rotation;
+            _self.sector.ellipse.rotation = newRotation;
+            _self.sector.ellipse.axis.rotate(rDiff, _self.sector.ellipse.center);
+            _self.startAngleControlPoint.rotate(rDiff, _self.sector.ellipse.center);
+            _self.endAngleControlPoint.rotate(rDiff, _self.sector.ellipse.center);
+        };
+    }
+    _handleDragStartAngleControlPoint() {
+        const _self = this;
+        return (_event) => {
+            // sector.startAngle = startAngleControlLine.angle() - sector.ellipse.rotation;
+            _self.sector.startAngle = geomutils.mapAngleTo2PI(_self._startAngleControlLine.angle() - _self.sector.ellipse.rotation);
+        };
+    }
+    _handleDragEndAngleControlPoint() {
+        const _self = this;
+        return (event) => {
+            _self.sector.endAngle = geomutils.mapAngleTo2PI(_self._endAngleControlLine.angle() - _self.sector.ellipse.rotation);
+        };
+    }
+    /**
+     * Draw grey handle lines.
+     *
+     * @param {DrawLib<any>} draw - The draw library instance to use.
+     * @param {DrawLib<any>} fill - The fill library instance to use.
+     */
+    drawHandleLines(draw, fill) {
+        draw.line(this.sector.ellipse.center, this.startAngleControlPoint, "rgba(64,192,128,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        draw.line(this.sector.ellipse.center, this.endAngleControlPoint, "rgba(64,192,128,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        // Draw rotation handle line
+        draw.line(this.sector.ellipse.center, this.rotationControlPoint, "rgba(192,64,128,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        // Draw helper box
+        draw.line(this.sector.ellipse.center
+            .clone()
+            .add(0, this.sector.ellipse.signedRadiusV())
+            .rotate(this.sector.ellipse.rotation, this.sector.ellipse.center), this.sector.ellipse.axis, "rgba(64,128,192,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+        draw.line(this.sector.ellipse.center
+            .clone()
+            .add(this.sector.ellipse.signedRadiusH(), 0)
+            .rotate(this.sector.ellipse.rotation, this.sector.ellipse.center), this.sector.ellipse.axis, "rgba(64,128,192,0.333)", 1.0, {
+            dashOffset: 0.0,
+            dashArray: [4, 2]
+        });
+    } // END drawHandleLines
+    /**
+     * Destroy this VEllipseHandler which means: all listeners are being removed.
+     */
+    destroy() {
+        this.sector.ellipse.center.listeners.removeDragListener(this._centerHandler);
+        this.rotationControlPoint.listeners.removeDragListener(this._rotationHandler);
+        this.startAngleControlPoint.listeners.removeDragListener(this._startAngleHandler);
+        this.endAngleControlPoint.listeners.removeDragListener(this._endAngleHandler);
+    }
+}
+//# sourceMappingURL=VEllipseSectorHelper.js.map

package/src/_esm/src/ts/utils/helpers/VEllipseSectorHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VEllipseSectorHelper.js","sourceRoot":"","sources":["../../../../../ts/utils/helpers/VEllipseSectorHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIlC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,MAAM,OAAO,oBAAoB;IAe/B,YACE,MAAsB,EACtB,sBAA8B,EAC9B,oBAA4B,EAC5B,oBAA4B;QAE5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACrD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAEjD,2FAA2F;QAC3F,IAAI,CAAC,oBAAoB,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QAClF,+FAA+F;QAC/F,IAAI,CAAC,sBAAsB,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;QACtF,2FAA2F;QAC3F,IAAI,CAAC,oBAAoB,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QAElF,yEAAyE;QACzE,uCAAuC;QACvC,+CAA+C;QAC/C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;QAEvG,yEAAyE;QACzE,iCAAiC;QACjC,+CAA+C;QAC/C,oBAAoB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;QAEjH,yEAAyE;QACzE,oCAAoC;QACpC,+CAA+C;QAC/C,sBAAsB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,iCAAiC,EAAE,CAAC,CAAC,CAAC;QAEvH,yEAAyE;QACzE,kCAAkC;QAClC,+CAA+C;QAC/C,oBAAoB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,OAAO,CAAC,KAAgB,EAAE,EAAE;YAC1B,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC1D,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACxD,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC;IACJ,CAAC;IAEO,+BAA+B;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,OAAO,CAAC,KAAgB,EAAE,EAAE;YAC1B,MAAM,WAAW,GAAW,KAAK,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;YAC/D,MAAM,KAAK,GAAW,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAClE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC;YAC5C,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACxE,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC;IAEO,iCAAiC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,OAAO,CAAC,MAAiB,EAAE,EAAE;YAC3B,+EAA+E;YAC/E,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1H,CAAC,CAAC;IACJ,CAAC;IAEO,+BAA+B;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC;QAEnB,OAAO,CAAC,KAAgB,EAAE,EAAE;YAC1B,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtH,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAkB,EAAE,IAAkB;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,wBAAwB,EAAE,GAAG,EAAE;YAChG,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,wBAAwB,EAAE,GAAG,EAAE;YAC9F,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CAAC,CAAC;QACH,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,wBAAwB,EAAE,GAAG,EAAE;YAC9F,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CAAC,CAAC;QACH,kBAAkB;QAClB,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM;aACvB,KAAK,EAAE;aACP,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;aAC3C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EACnE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EACxB,wBAAwB,EACxB,GAAG,EACH;YACE,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CACF,CAAC;QACF,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM;aACvB,KAAK,EAAE;aACP,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;aAC3C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EACnE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EACxB,wBAAwB,EACxB,GAAG,EACH;YACE,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAClB,CACF,CAAC;IACJ,CAAC,CAAC,sBAAsB;IAExB;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7E,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9E,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClF,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChF,CAAC;CACF"}

package/src/_esm/src/ts/utils/io/FileDrop.d.ts

@@ -0,0 +1,110 @@
+/**
+ * A basic IO handler for file drop (Drag-and-drop).
+ *
+ * Example use:
+ * ```javascript
+ *  var body = document.getElememtByTagName("body")[0];
+ *  var fileDrop = new FileDrop(body);
+ *    fileDrop.onFileJSONDropped(function (jsonObject) {
+ *    console.log("jsonObject", jsonObject);
+ *  });
+ * ```
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-10-13
+ * @modified 2022-01-31 (ported from the ngdg project, then generalized)
+ * @modified 2023-01-03 Fixing some minor type issues and adding SVG reading capabilities.
+ * @version  2.1.0
+ */
+type IDroppedCallbackJSON = (jsonData: object) => void;
+type IDroppedCallbackText = (textData: string) => void;
+type IDroppedCallbackSVG = (svgDocument: Document) => void;
+type IDroppedCallbackBinary = (binaryData: Blob, file: File) => void;
+export declare class FileDrop {
+    /**
+     * The 'dropzone' element.
+     * @private
+     * @memberof FileDrop
+     * @member {HTMLElement}
+     */
+    private element;
+    /**
+     * The JSON file drop callback.
+     * @private
+     * @memberof FileDrop
+     * @member {HTMLElement}
+     */
+    private fileDroppedCallbackJSON;
+    /**
+     * The text file drop callback.
+     * @private
+     * @memberof FileDrop
+     * @member {HTMLElement}
+     */
+    private fileDroppedCallbackText;
+    /**
+     * The binary file drop callback.
+     * @private
+     * @memberof FileDrop
+     * @member {HTMLElement}
+     */
+    private fileDroppedCallbackBinary;
+    /**
+     * The SVG file drop callback.
+     * @private
+     * @memberof FileDrop
+     * @member {HTMLElement}
+     */
+    private fileDroppedCallbackSVG;
+    /**
+     *
+     * @param {HTMLElement} element - The element you wish to operate as the drop zone (like <body/>).
+     */
+    constructor(element: HTMLElement);
+    /**
+     * Install the JSON (MIME type json*) file drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as an object (parsed JSON).
+     *
+     * @param {(data:object)=>void} callback
+     */
+    onFileJSONDropped(callback: IDroppedCallbackJSON): void;
+    /**
+     * Install the text file (MIME type text/plain) drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as a string.
+     *
+     * @param {(data:object)=>void} callback
+     */
+    onFileTextDropped(callback: IDroppedCallbackText): void;
+    onFileSVGDropped(callback: IDroppedCallbackSVG): void;
+    onFileBinaryDropped(callback: IDroppedCallbackBinary): void;
+    /**
+     * Internally handle a drop event.
+     *
+     * @param {DragEvent} event
+     * @returns {void}
+     */
+    private handleDropEvent;
+    /**
+     * Toggles the drop sensitive element's opacity to 0.5.
+     *
+     * @param {DragEvent} event - The event.
+     */
+    private handleDragOverEvent;
+    /**
+     * Restored the drop sensitive element's opacity back to 1.0.
+     *
+     * @param {DragEvent} event - The event.
+     */
+    private handleDragLeaveEvent;
+    /**
+     * Removes all listeners (drop, dragover and dragleave).
+     */
+    destroy(): void;
+}
+export {};

package/src/_esm/src/ts/utils/io/FileDrop.js

@@ -0,0 +1,171 @@
+/**
+ * A basic IO handler for file drop (Drag-and-drop).
+ *
+ * Example use:
+ * ```javascript
+ *  var body = document.getElememtByTagName("body")[0];
+ *  var fileDrop = new FileDrop(body);
+ *    fileDrop.onFileJSONDropped(function (jsonObject) {
+ *    console.log("jsonObject", jsonObject);
+ *  });
+ * ```
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-10-13
+ * @modified 2022-01-31 (ported from the ngdg project, then generalized)
+ * @modified 2023-01-03 Fixing some minor type issues and adding SVG reading capabilities.
+ * @version  2.1.0
+ */
+export class FileDrop {
+    /**
+     *
+     * @param {HTMLElement} element - The element you wish to operate as the drop zone (like <body/>).
+     */
+    constructor(element) {
+        /**
+         * Internally handle a drop event.
+         *
+         * @param {DragEvent} event
+         * @returns {void}
+         */
+        this.handleDropEvent = (event) => {
+            event.preventDefault();
+            event.stopPropagation();
+            this.element.style.opacity = "1.0";
+            if (!event.dataTransfer || !event.dataTransfer.files || event.dataTransfer.files.length === 0) {
+                // No files were dropped
+                return;
+            }
+            if (event.dataTransfer.files.length > 1) {
+                // Multiple file drop is not nupported
+                return;
+            }
+            // if (!this.fileDroppedCallbackJSON) {
+            //   // No handling callback defined.
+            //   return;
+            // }
+            if (event.dataTransfer.files[0]) {
+                const file = event.dataTransfer.files[0];
+                // console.log("file", file);
+                if (file.type.match(/json.*/) && this.fileDroppedCallbackJSON !== null) {
+                    var reader = new FileReader();
+                    reader.onload = (readEvent) => {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process JSON ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        const jsonObject = JSON.parse(readEvent.target.result);
+                        // TODO: what happens on fail?
+                        this.fileDroppedCallbackJSON && this.fileDroppedCallbackJSON(jsonObject);
+                    };
+                    reader.readAsText(file); // start reading the file data.
+                }
+                else if (file.type.match(/text\/plain.*/) && this.fileDroppedCallbackText) {
+                    var reader = new FileReader();
+                    reader.onload = (readEvent) => {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process Text ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        this.fileDroppedCallbackText && this.fileDroppedCallbackText(readEvent.target.result);
+                    };
+                    reader.readAsText(file); // start reading the file data.
+                }
+                else if (this.fileDroppedCallbackBinary) {
+                    var reader = new FileReader();
+                    reader.onload = (readEvent) => {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process Binary ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        this.fileDroppedCallbackBinary &&
+                            this.fileDroppedCallbackBinary(new Blob([readEvent.target.result]), file);
+                    };
+                    reader.readAsBinaryString(file); // start reading the file data.
+                }
+                else if (this.fileDroppedCallbackSVG) {
+                    var reader = new FileReader();
+                    reader.onload = (readEvent) => {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process SVG ProgressEvent data: target is null.");
+                            return;
+                        }
+                        const parser = new DOMParser();
+                        const doc = parser.parseFromString(readEvent.target.result, "image/svg+xml");
+                        // Finished reading file data.
+                        this.fileDroppedCallbackSVG && this.fileDroppedCallbackSVG(doc);
+                    };
+                    reader.readAsText(file); // start reading the file data.
+                }
+            }
+        };
+        /**
+         * Toggles the drop sensitive element's opacity to 0.5.
+         *
+         * @param {DragEvent} event - The event.
+         */
+        this.handleDragOverEvent = (event) => {
+            event.preventDefault();
+            event.stopPropagation();
+            this.element.style.opacity = "0.5";
+        };
+        /**
+         * Restored the drop sensitive element's opacity back to 1.0.
+         *
+         * @param {DragEvent} event - The event.
+         */
+        this.handleDragLeaveEvent = (event) => {
+            event.preventDefault();
+            event.stopPropagation();
+            this.element.style.opacity = "1.0";
+        };
+        this.element = element;
+        // Init the drop listeners
+        element.addEventListener("drop", this.handleDropEvent.bind(this));
+        element.addEventListener("dragover", this.handleDragOverEvent.bind(this));
+        element.addEventListener("dragleave", this.handleDragLeaveEvent.bind(this));
+    }
+    /**
+     * Install the JSON (MIME type json*) file drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as an object (parsed JSON).
+     *
+     * @param {(data:object)=>void} callback
+     */
+    onFileJSONDropped(callback) {
+        this.fileDroppedCallbackJSON = callback;
+    }
+    /**
+     * Install the text file (MIME type text/plain) drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as a string.
+     *
+     * @param {(data:object)=>void} callback
+     */
+    onFileTextDropped(callback) {
+        this.fileDroppedCallbackText = callback;
+    }
+    // TODO: docs
+    onFileSVGDropped(callback) {
+        this.fileDroppedCallbackSVG = callback;
+    }
+    onFileBinaryDropped(callback) {
+        this.fileDroppedCallbackBinary = callback;
+    }
+    /**
+     * Removes all listeners (drop, dragover and dragleave).
+     */
+    destroy() {
+        this.element.removeEventListener("drop", this.handleDropEvent);
+        this.element.removeEventListener("dragover", this.handleDragOverEvent);
+        this.element.removeEventListener("dragleave", this.handleDragLeaveEvent);
+    }
+}
+//# sourceMappingURL=FileDrop.js.map

package/src/_esm/src/ts/utils/io/FileDrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileDrop.js","sourceRoot":"","sources":["../../../../../ts/utils/io/FileDrop.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAOH,MAAM,OAAO,QAAQ;IAyCnB;;;OAGG;IACH,YAAY,OAAoB;QA4ChC;;;;;WAKG;QACK,oBAAe,GAAG,CAAC,KAAgB,EAAE,EAAE;YAC7C,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;YAEnC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9F,wBAAwB;gBACxB,OAAO;YACT,CAAC;YACD,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,sCAAsC;gBACtC,OAAO;YACT,CAAC;YACD,uCAAuC;YACvC,qCAAqC;YACrC,YAAY;YACZ,IAAI;YACJ,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,GAAS,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC/C,6BAA6B;gBAC7B,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,uBAAuB,KAAK,IAAI,EAAE,CAAC;oBACvE,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,CAAC,SAAoC,EAAE,EAAE;wBACvD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;4BACxE,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,MAAM,UAAU,GAAW,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;wBACzE,8BAA8B;wBAC9B,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC3E,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;oBAC5E,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,CAAC,SAAoC,EAAE,EAAE;wBACvD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;4BACxE,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;oBAClG,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;qBAAM,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;oBAC1C,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,CAAC,SAAoC,EAAE,EAAE;wBACvD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;4BAC1E,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,IAAI,CAAC,yBAAyB;4BAC5B,IAAI,CAAC,yBAAyB,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;oBAC7F,CAAC,CAAC;oBACF,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,+BAA+B;gBAClE,CAAC;qBAAM,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBACvC,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,CAAC,SAAoC,EAAE,EAAE;wBACvD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;4BACvE,OAAO;wBACT,CAAC;wBACD,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,EAAE,eAAe,CAAC,CAAC;wBAEvF,8BAA8B;wBAC9B,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;oBAClE,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF;;;;WAIG;QACK,wBAAmB,GAAG,CAAC,KAAgB,EAAE,EAAE;YACjD,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACrC,CAAC,CAAC;QAEF;;;;WAIG;QACK,yBAAoB,GAAG,CAAC,KAAgB,EAAE,EAAE;YAClD,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACrC,CAAC,CAAC;QA/IA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,0BAA0B;QAC1B,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,QAA8B;QAC9C,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,QAA8B;QAC9C,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED,aAAa;IACb,gBAAgB,CAAC,QAA6B;QAC5C,IAAI,CAAC,sBAAsB,GAAG,QAAQ,CAAC;IACzC,CAAC;IAED,mBAAmB,CAAC,QAAgC;QAClD,IAAI,CAAC,yBAAyB,GAAG,QAAQ,CAAC;IAC5C,CAAC;IAwGD;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/src/_esm/src/ts/utils/parsers/LinearColorGradientParser.d.ts

@@ -0,0 +1,78 @@
+/**
+ * A CSS gradient string parser.
+ *
+ * Source:
+ *  https://stackoverflow.com/questions/20215440/parse-css-gradient-rule-with-javascript-regex
+ * Thanks to Dean Taylor
+ *
+ * @date           2025-09-04
+ * @OriginalAuthor Dean Taylor
+ * @RefactoredBy   Ikaros Kappler, ported to Typescript.
+ * @version        1.0.0
+ */
+import { ColorGradient } from "../datastructures/ColorGradient";
+/**
+ * A wrapper type for the regular expressions used to parsed gradient strings.
+ */
+export type ColorGradientParserRegExpLib = {
+    gradientSearch: RegExp;
+    colorStopSearch: RegExp;
+};
+/**
+ * The raw parse result.
+ */
+export type ColorGradientParseResult = {
+    original: string;
+    line: string;
+    angle: string;
+    colorStopList: ColorGradientStopResult[];
+    sideCorner: string;
+    gradientType?: string;
+    parseWarning?: boolean;
+};
+/**
+ * The position string can have two formats: as percent or as pixels.
+ * For conversion to LinearColorGradient only relative (percent) is supported.
+ */
+type PositionString = `${number}px` | `${number}%`;
+/**
+ * A sub type of the result representing pairs of (color,position) elements.
+ */
+type ColorGradientStopResult = {
+    color: string;
+    position: PositionString;
+};
+/**
+ * This must convert positioning strings to ratio numbers (in [0..1]).
+ * Must throw error if not parsable.
+ */
+export type PositionToRatioConverter = (positionString: PositionString) => number;
+/**
+ * The default implementation of `PositionToRatioConverter`.
+ * @param positionString
+ * @returns
+ */
+export declare const DefaultPositionConverter: PositionToRatioConverter;
+/**
+ * Actually parse the input gradient parameters string into an object for reusability.
+ *
+ *
+ * @note Really this only supports the standard syntax not historical versions, see MDN for details
+ *       https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient
+ *
+ * @param {ColorGradientParserRegExpLib} regExpLib
+ * @param {string} input Input string in the form "to right bottom, #FF0 0%, red 20px, rgb(0, 0, 255) 100%"
+ * @returns {object|undefined} Object containing break down of input string including array of stop points.
+ */
+export declare var __parseGradient: (regExpLib: ColorGradientParserRegExpLib, input: string) => ColorGradientParseResult;
+/**
+ * The actual parser class.
+ */
+export declare class LinearColorGradientParser {
+    private readonly regExpLib;
+    constructor(regExpLib?: ColorGradientParserRegExpLib);
+    parse(input: string, positionConverter?: PositionToRatioConverter): ColorGradient;
+    parseRaw(input: string): ColorGradientParseResult;
+    static parseResultToColorGradient(result: ColorGradientParseResult, positionConverter?: PositionToRatioConverter): ColorGradient;
+}
+export {};