plotboilerplate 1.27.1 → 1.28.0

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.