plotboilerplate 1.27.0 → 1.28.0

package/src/ts/drawgl.ts

@@ -17,12 +17,23 @@
  * @modified 2023-09-29 Added the `cubicBezierArrow(...)` function to the 'DrawLib.arrow()` interface.
  * @modified 2023-09-29 Added the `lineDashes` attribute.
  * @modified 2026-03-18 Adding `isOpen` parameter to `cubicBezierPath` draw method.
- * @version  0.0.10
+ * @modified 2026-04-04 Added the method `bounds`.
+ * @version  0.0.11
  **/
 
 import { Polygon } from "./Polygon";
 import { Vertex } from "./Vertex";
-import { DrawLib, XYCoords, SVGPathParams, UID, DrawLibConfiguration, FontStyle, FontWeight, StrokeOptions } from "./interfaces";
+import {
+  DrawLib,
+  XYCoords,
+  SVGPathParams,
+  UID,
+  DrawLibConfiguration,
+  FontStyle,
+  FontWeight,
+  StrokeOptions,
+  IBounds
+} from "./interfaces";
 import { Bounds } from "./Bounds";
 
 /**
@@ -569,10 +580,34 @@ export class drawutilsgl implements DrawLib<void> {
    * @param {string} color - The color to use.
    * @param {number=1} lineWidth - (optional) The line with to use (default is 1).
    **/
-  rect(position: XYCoords, width: number, height: number, color: string, lineWidth?: number): void {
+  rect(
+    position: XYCoords,
+    width: number,
+    height: number,
+    color: string,
+    lineWidth?: number,
+    strokeOptions?: StrokeOptions
+  ): void {
     // NOT YET IMPLEMENTED
   }
 
+  /**
+   * Draw a rectangle at the given bounds; and with the specified line width and (CSS-) color.<br>
+   *
+   * @method bounds
+   * @param {IBounds} bounds - The bounds rectangle to be drawn.
+   * @param {string} color - The CSS color to draw the rectangle with.
+   * @param {number=} lineWidth - (optional) The line width to use; default is 1.
+   * @param {StrokeOptions=} strokeOptions - (optional) Stroke settings to use.
+   *
+   * @return {R}
+   * @instance
+   * @memberof DrawLib
+   */
+  bounds(bounds: IBounds, color: string, lineWidth?: number, strokeOptions?: StrokeOptions): void {
+    this.rect(bounds.min, bounds.max.x - bounds.min.x, bounds.max.y - bounds.min.y, color, lineWidth, strokeOptions);
+  }
+
   /**
    * Draw a grid of horizontal and vertical lines with the given (CSS-) color.
    *

package/src/ts/drawutilssvg.ts

@@ -51,6 +51,9 @@
  * @modified 2026-01-04 Adding `lineJoin` attribute to the methods' `StrokeOptions` param.
  * @modified 2026-01-04 Fixing missing `strokeOptions` param in the `drawutilssvg.polygon` method.
  * @modified 2026-03-18 Adding `isOpen` parameter to `cubicBezierPath` draw method.
+ * @modified 2026-04-04 Added the method `bounds`.
+ * @modified 2026-04-04 Handling the `stroke-linecap` option now from the `StrokeOptions` interface.
+ * @modified 2026-04-04 Chaning the `copyPathData` method by usind `Array.slice()`.
  * @version  1.7.0
  **/
 
@@ -69,7 +72,8 @@ import {
   DrawLibConfiguration,
   FontStyle,
   FontWeight,
-  StrokeOptions
+  StrokeOptions,
+  IBounds
 } from "./interfaces";
 import { Bounds } from "./Bounds";
 import { UIDGenerator } from "./UIDGenerator";
@@ -681,6 +685,11 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
     if (strokeOptions && strokeOptions.lineJoin && drawutilssvg.nodeSupportsLineJoin(node.tagName)) {
       node.setAttribute("stroke-linejoin", strokeOptions.lineJoin);
     }
+
+    // Set lineCap option?
+    if (strokeOptions && strokeOptions.lineCap && drawutilssvg.nodeSupportsLineCap(node.tagName)) {
+      node.setAttribute("stroke-linecap", strokeOptions.lineCap);
+    }
   }
 
   private _x(x: number): number {
@@ -1295,6 +1304,23 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
     return this._bindFillDraw(node, "rect", color, lineWidth || 1);
   }
 
+  /**
+   * Draw a rectangle at the given bounds; and with the specified line width and (CSS-) color.<br>
+   *
+   * @method bounds
+   * @param {IBounds} bounds - The bounds rectangle to be drawn.
+   * @param {string} color - The CSS color to draw the rectangle with.
+   * @param {number=} lineWidth - (optional) The line width to use; default is 1.
+   * @param {StrokeOptions=} strokeOptions - (optional) Stroke settings to use.
+   *
+   * @return {R}
+   * @instance
+   * @memberof DrawLib
+   */
+  bounds(bounds: IBounds, color: string, lineWidth?: number, strokeOptions?: StrokeOptions): void {
+    this.rect(bounds.min, bounds.max.x - bounds.min.x, bounds.max.y - bounds.min.y, color, lineWidth, strokeOptions);
+  }
+
   /**
    * Draw a grid of horizontal and vertical lines with the given (CSS-) color.
    *
@@ -1801,11 +1827,8 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
    * @memberof drawutilssvg
    */
   static copyPathData(data: SVGPathParams): SVGPathParams {
-    const copy: SVGPathParams = new Array(data.length);
-    for (var i = 0, n = data.length; i < n; i++) {
-      copy[i] = data[i];
-    }
-    return copy;
+    // To create a shallow copy we can just use the `slice` method.
+    return data.slice();
   }
 
   /**
@@ -1983,6 +2006,10 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
     return ["line", "path", "circle", "ellipse", "rectangle", "rect"].includes(nodeName);
   }
 
+  private static nodeSupportsLineCap(nodeName: string) {
+    return ["line", "path", "circle", "ellipse", "rectangle", "rect"].includes(nodeName);
+  }
+
   /**
    * Creates a basic <line> node with start and end coordinates. The created node will not
    * be bound to any root node.

package/src/ts/index.ts

@@ -25,3 +25,97 @@ export * from "./Vertex";
 export * from "./VertexAttr";
 export * from "./VertexListeners";
 export * from "./VertTuple";
+
+// Additional exports: utils
+export * from "./utils/cloneVertexArray";
+export * from "./utils/createRandomizedPolygon";
+export * from "./utils/detectDarkMode";
+export * from "./utils/findInVertexArray";
+export * from "./utils/gup";
+export * from "./utils/InitializationObserver";
+export * from "./utils/LissajousFigure";
+export * from "./utils/NGons";
+export * from "./utils/Params";
+export * from "./utils/PerlinNoise";
+export * from "./utils/SVGPathUtils";
+export * from "./utils/WebColors";
+export * from "./utils/WebColorsContrast";
+export * from "./utils/WebColorsMalachite";
+
+// Additional exports: utils/algorithms
+export * from "./utils/algorithms/arrayFill";
+export * from "./utils/algorithms/arrayResize";
+export * from "./utils/algorithms/arrayShuffle";
+export * from "./utils/algorithms/CatmullRomPath";
+export * from "./utils/algorithms/CircleIntersections";
+export * from "./utils/algorithms/clearDuplicateVertices";
+export * from "./utils/algorithms/clearPolygonDuplicateVertices";
+export * from "./utils/algorithms/ContourLineDetection";
+export * from "./utils/algorithms/convexHull";
+export * from "./utils/algorithms/convexPolygonIncircle";
+export * from "./utils/algorithms/CubicSplinePath";
+export * from "./utils/algorithms/delaunay";
+export * from "./utils/algorithms/delaunay2voronoi";
+export * from "./utils/algorithms/detectPaths";
+export * from "./utils/algorithms/findPolygonSelfIntersections";
+export * from "./utils/algorithms/getContrastColor";
+export * from "./utils/algorithms/HobbyPath";
+export * from "./utils/algorithms/matrixFill";
+export * from "./utils/algorithms/Metaballs";
+export * from "./utils/algorithms/pixelCornersToRoundPaths";
+export * from "./utils/algorithms/PolygonInset";
+export * from "./utils/algorithms/PolygonTesselationOutlines";
+export * from "./utils/algorithms/splitPolygonToNonIntersecting";
+export * from "./utils/algorithms/sutherlandHodgman";
+
+// Additional exports: utils/datastructures
+export * from "./utils/datastructures/CircularIntervalSet";
+export * from "./utils/datastructures/Color";
+export * from "./utils/datastructures/ColorGradient";
+export * from "./utils/datastructures/DataGrid2d";
+export * from "./utils/datastructures/DataGrid2dArrayMatrix";
+export * from "./utils/datastructures/DataGrid2dListAdapter";
+export * from "./utils/datastructures/GenericPath";
+export * from "./utils/datastructures/GeometryMesh";
+export * from "./utils/datastructures/Girih";
+export * from "./utils/datastructures/GirihBowtie";
+export * from "./utils/datastructures/GirihDecagon";
+export * from "./utils/datastructures/GirihHexagon";
+export * from "./utils/datastructures/GirihPenroseRhombus";
+export * from "./utils/datastructures/GirihPentagon";
+export * from "./utils/datastructures/GirihRhombus";
+export * from "./utils/datastructures/GirihTile";
+export * from "./utils/datastructures/interfaces";
+export * from "./utils/datastructures/Matrix4x4";
+export * from "./utils/datastructures/VoronoiCell";
+
+// Additional exports: utils/dom/components
+export * from "./utils/dom/components/ColorGradientPicker";
+export * from "./utils/dom/components/ColorGradientSelector";
+
+// Additional exports: utils/dom
+
+export * from "./utils/dom/getAvailableContainerSpace";
+export * from "./utils/dom/getFProp";
+export * from "./utils/dom/guiSizeToggler";
+
+// Additional exports: utils/helpers
+export * from "./utils/helpers/BezierPathInteractionHelper";
+export * from "./utils/helpers/CircleHelper";
+export * from "./utils/helpers/CircleSectorHelper";
+export * from "./utils/helpers/TriangleHelper";
+export * from "./utils/helpers/VEllipseHelper";
+export * from "./utils/helpers/VEllipseSectorHelper";
+
+// Additional exports: utils/io
+export * from "./utils/io/FileDrop";
+
+// Additional exports: utils/parsers/svg
+export * from "./utils/parsers/svg/parseSVGPathData";
+export * from "./utils/parsers/svg/splitSVGPathData";
+export * from "./utils/parsers/svg/types";
+
+// Additional exports: utils/parsers
+export * from "./utils/parsers/LinearColorGradientParser";
+export * from "./utils/parsers/OBJParser";
+export * from "./utils/parsers/STLParser";

package/src/ts/interfaces/DrawLib.ts

@@ -26,12 +26,14 @@
  * @modified 2023-09-29 Added the `lineDashes` attribute.
  * @modified 2023-09-30 Adding `strokeOptions` param to these draw function: line, arrow, cubicBezierArrow, cubicBezier, cubicBezierPath, circle, circleArc, ellipse, square, rect, polygon, polyline.
  * @modified 2026-01-04 Adding optional `lineJoin` attribute to the `StrokeOptions` interface.
+ * @modified 2026-04-04 Added the method `bounds`.
+ * @modified 2026-04-04 Added the `lineCap` attribute to the `StrokeOptions`.
  **/
 
 import { Bounds } from "../Bounds";
 import { Polygon } from "../Polygon";
 import { Vertex } from "../Vertex";
-import { SVGPathParams, UID, XYCoords } from "./core";
+import { IBounds, SVGPathParams, UID, XYCoords } from "./core";
 
 export interface DrawLibConfiguration {
   // https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation#types
@@ -71,6 +73,7 @@ export interface StrokeOptions {
   dashArray?: Array<number>;
   // SVG has more options for this: arcs | bevel | miter | miter-clip | round
   lineJoin?: "round" | "bevel" | "miter";
+  lineCap?: "butt" | "round" | "square";
 }
 
 /**
@@ -468,6 +471,21 @@ export interface DrawLib<R> {
     strokeOptions?: StrokeOptions
   ) => R;
 
+  /**
+   * Draw a rectangle at the given bounds; and with the specified line width and (CSS-) color.<br>
+   *
+   * @method bounds
+   * @param {IBounds} bounds - The bounds rectangle to be drawn.
+   * @param {string} color - The CSS color to draw the rectangle with.
+   * @param {number=} lineWidth - (optional) The line width to use; default is 1.
+   * @param {StrokeOptions=} strokeOptions - (optional) Stroke settings to use.
+   *
+   * @return {R}
+   * @instance
+   * @memberof DrawLib
+   */
+  bounds: (bounds: IBounds, color: string, lineWidth?: number, strokeOptions?: StrokeOptions) => R;
+
   /**
    * Draw a grid of horizontal and vertical lines with the given (CSS-) color.
    *

package/src/ts/utils/Params.ts

@@ -6,6 +6,7 @@
  * @version  1.0.0
  * @date     2023-03-13
  * @modified 2024-08-26 Added the `hasParam` method.
+ * @modified 2026-05-22 Added the `isValueAllowed` function param to the getter methods.
  */
 
 export class Params {
@@ -19,20 +20,27 @@ export class Params {
     return this.baseParams.hasOwnProperty(name);
   }
 
-  getString(name: string, fallback: string): string {
+  getString(name: string, fallback: string, isValueAllowed?: (value: string) => boolean): string {
     let value = this.baseParams[name];
     if (typeof value === "undefined" || !value || (value = value.trim()).length === 0) {
       return fallback;
     }
+    if (isValueAllowed && !isValueAllowed(value)) {
+      return fallback;
+    }
     return value;
   }
 
-  getNumber(name: string, fallback: number): number {
+  getNumber(name: string, fallback: number, isValueAllowed?: (value: number) => boolean): number {
     let value = this.baseParams[name];
     if (typeof value === "undefined" || !value || (value = value.trim()).length === 0) {
       return fallback;
     }
-    return Number(value);
+    var numericValue = Number(value);
+    if (isValueAllowed && !isValueAllowed(numericValue)) {
+      return fallback;
+    }
+    return numericValue;
   }
 
   getBoolean(name: string, fallback: boolean): boolean {

package/src/ts/utils/WebColors.ts

@@ -4,7 +4,8 @@
  * @modified 2020-10-23 Ported to Typescript.
  * @modified 2020-10-30 Exporting each color under its name globally.
  * @modified 2025-12-08 Replaying self defined colors by official web colors.
- * @version  1.0.2
+ * @modified 2026-03-18 Fixing global `WebColors` array.
+ * @version  1.0.3
  **/
 
 import { Color } from "./datastructures/Color";
@@ -30,7 +31,19 @@ export const LightGreen: Color = Color.LightGreen; // Color.makeRGB(141,195,67);
  * @requires Color
  *
  */
-export const WebColors: Array<Color> = [Red, Pink, Purple, DeepPurple, Indigo, Blue, LightBlue, Cyan, Teal, Green, LightGreen];
+export const WebColors: Array<Color> = [
+  Color.Red,
+  Color.Pink,
+  Color.Purple,
+  Color.DeepPink,
+  Color.Indigo,
+  Color.Blue,
+  Color.LightBlue,
+  Color.Cyan,
+  Color.Teal,
+  Color.Green,
+  Color.LightGreen
+];
 
 /**
  * A helper function to shuffle the colors into a new order.