plotboilerplate 1.12.8 → 1.14.0

package/src/cjs/entry.js

@@ -18,6 +18,7 @@ globalThis.VEllipse = require("./VEllipse.js").VEllipse;
 globalThis.Circle = require("./Circle.js").Circle;
 globalThis.CircleSector = require("./CircleSector.js").CircleSector;
 globalThis.PBImage = require("./PBImage.js").PBImage;
+globalThis.PBText = require("./PBText.js").PBText;
 globalThis.MouseHandler = require("./MouseHandler.js").MouseHandler;
 globalThis.KeyHandler = require("./KeyHandler.js").KeyHandler;
 globalThis.drawutils = require("./draw.js").drawutils;

package/src/cjs/index.d.ts

@@ -13,6 +13,7 @@ export * from "./KeyHandler";
 export * from "./Line";
 export * from "./MouseHandler";
 export * from "./PBImage";
+export * from "./PBText";
 export * from "./PlotBoilerplate";
 export * from "./Polygon";
 export * from "./SVGBuilder";

package/src/cjs/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./KeyHandler"), exports);
 __exportStar(require("./Line"), exports);
 __exportStar(require("./MouseHandler"), exports);
 __exportStar(require("./PBImage"), exports);
+__exportStar(require("./PBText"), exports);
 __exportStar(require("./PlotBoilerplate"), exports);
 __exportStar(require("./Polygon"), exports);
 __exportStar(require("./SVGBuilder"), exports);

package/src/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B;AAC7B,2CAAyB;AACzB,2CAAyB;AACzB,iDAA+B;AAC/B,qDAAmC;AACnC,yCAAuB;AACvB,2CAAyB;AACzB,iDAA+B;AAC/B,8CAA4B;AAC5B,yCAAuB;AACvB,+CAA6B;AAC7B,+CAA6B;AAC7B,yCAAuB;AACvB,iDAA+B;AAC/B,4CAA0B;AAC1B,oDAAkC;AAClC,4CAA0B;AAC1B,+CAA6B;AAC7B,6CAA2B;AAC3B,iDAA+B;AAC/B,2CAAyB;AACzB,6CAA2B;AAC3B,mDAAiC;AACjC,2CAAyB;AACzB,+CAA6B;AAC7B,oDAAkC;AAClC,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B;AAC7B,2CAAyB;AACzB,2CAAyB;AACzB,iDAA+B;AAC/B,qDAAmC;AACnC,yCAAuB;AACvB,2CAAyB;AACzB,iDAA+B;AAC/B,8CAA4B;AAC5B,yCAAuB;AACvB,+CAA6B;AAC7B,+CAA6B;AAC7B,yCAAuB;AACvB,iDAA+B;AAC/B,4CAA0B;AAC1B,2CAAyB;AACzB,oDAAkC;AAClC,4CAA0B;AAC1B,+CAA6B;AAC7B,6CAA2B;AAC3B,iDAA+B;AAC/B,2CAAyB;AACzB,6CAA2B;AAC3B,mDAAiC;AACjC,2CAAyB;AACzB,+CAA6B;AAC7B,oDAAkC;AAClC,8CAA4B"}

package/src/cjs/interfaces/DrawLib.d.ts

@@ -12,6 +12,9 @@
  * @modified 2021-03-30 Added the `endDrawCycle` function to `DrawLib`.
  * @modified 2021-05-31 Added the `drawLib.setConfiguration` function.
  * @modified 2021-05-31 Splitted the large interfaces.ts file into this one and others.
+ * @modified 2021-11-12 Added `text()` params fontSize, fontFamily, rotation, textAlign.
+ * @modified 2021-11-16 Added `text()` params fontWeight and fontStyle.
+ * @modified 2021-11-19 Added the `color` param to the `label(...)` function.
  **/
 import { Polygon } from "../Polygon";
 import { Vertex } from "../Vertex";
@@ -19,6 +22,18 @@ import { SVGPathParams, UID, XYCoords } from "./core";
 export interface DrawLibConfiguration {
     blendMode?: 'source-over' | 'source-in' | 'source-out' | 'source-atop' | 'destination-over' | 'destination-in' | 'destination-out' | 'destination-atop' | 'lighter' | 'copy' | 'xor' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'color-dodge' | 'color-burn' | 'hard-light' | 'soft-light' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity' | null;
 }
+export declare type FontWeight = "normal" | "bold" | "bolder" | "lighter" | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900;
+export declare type FontStyle = "normal" | "italic" | "oblique";
+export interface FontOptions {
+    color?: string;
+    fontFamily?: string;
+    fontSize?: number;
+    fontStyle?: FontStyle;
+    fontWeight?: FontWeight;
+    lineHeight?: number;
+    textAlign?: CanvasRenderingContext2D["textAlign"];
+    rotation?: number;
+}
 /**
  * An interface all drawing libraries must implement to be used with PlotBoilerplate.
  *
@@ -389,20 +404,25 @@ export interface DrawLib<R> {
      */
     polyline: (vertices: Array<Vertex>, isOpen: boolean, color: string, lineWidth?: number) => R;
     /**
-     * Draw a text label at the given relative position.
+     * Draw a text at the given relative position.
      *
      * @method text
      * @param {string} text - The text to draw.
      * @param {number} x - The x-position to draw the text at.
      * @param {number} y - The y-position to draw the text at.
-     * @param {number=} rotation - The (optional) rotation in radians.
+     * @param {string=} options.color - The Color to use.
+     * @param {string=} options.fontFamily - The font family to use.
+     * @param {number=} options.fontSize - The font size (in pixels) to use.
+     * @param {FontStyle=} options.fontStyle - The font style to use.
+     * @param {FontWeight=} options.fontWeight - The font weight to use.
+     * @param {number=} options.lineHeight - The line height (in pixels) to use.
+     * @param {number=} options.rotation - The (optional) rotation in radians.
+     * @param {string=} options.textAlign - The text align to use. According to the specifiactions (https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign) valid values are `"left" || "right" || "center" || "start" || "end"`.
      * @return {void}
      * @instance
      * @memberof drawutils
      */
-    text: (text: string, x: number, y: number, options?: {
-        color?: string;
-    }) => R;
+    text: (text: string, x: number, y: number, options?: FontOptions) => R;
     /**
      * Draw a non-scaling text label at the given absolute position.
      *
@@ -411,11 +431,12 @@ export interface DrawLib<R> {
      * @param {number} x - The x-position to draw the text at.
      * @param {number} y - The y-position to draw the text at.
      * @param {number=} rotation - The (aoptional) rotation in radians.
+     * @param {string="black"} color - The color to use (default is black).
      * @return {void}
      * @instance
      * @memberof drawutils
      */
-    label: (text: string, x: number, y: number, rotation: number) => R;
+    label: (text: string, x: number, y: number, rotation?: number, color?: string) => R;
     /**
      * Draw an SVG-like path given by the specified path data.
      *

package/src/cjs/interfaces/DrawLib.js

@@ -13,6 +13,9 @@
  * @modified 2021-03-30 Added the `endDrawCycle` function to `DrawLib`.
  * @modified 2021-05-31 Added the `drawLib.setConfiguration` function.
  * @modified 2021-05-31 Splitted the large interfaces.ts file into this one and others.
+ * @modified 2021-11-12 Added `text()` params fontSize, fontFamily, rotation, textAlign.
+ * @modified 2021-11-16 Added `text()` params fontWeight and fontStyle.
+ * @modified 2021-11-19 Added the `color` param to the `label(...)` function.
  **/
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=DrawLib.js.map

package/src/cjs/interfaces/DrawLib.js.map

@@ -1 +1 @@
-{"version":3,"file":"DrawLib.js","sourceRoot":"","sources":["../../ts/interfaces/DrawLib.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;IAcI"}
+{"version":3,"file":"DrawLib.js","sourceRoot":"","sources":["../../ts/interfaces/DrawLib.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;IAiBI"}

package/src/cjs/interfaces/core.d.ts

@@ -13,6 +13,7 @@
  * @modified 2021-05-31 Added the `drawLib.setConfiguration` function.
  * @modified 2021-05-31 Splitted the large interfaces.ts file into this one and others.
  * @modified 2021-06-21 Added `IBounds.getCenter()`.
+ * @modified 2021-11-16 Added `text` options to the `DrawConfig`.
  **/
 import { Vertex } from "../Vertex";
 import { Vector } from "../Vector";
@@ -27,6 +28,7 @@ import { BezierPath } from "../BezierPath";
 import { Line } from "../Line";
 import { PlotBoilerplate } from "../PlotBoilerplate";
 import { DrawLib } from "./DrawLib";
+import { PBText } from "../PBText";
 /**
  * @classdesc Coordinates (x,y) on the plane.
  *
@@ -61,7 +63,7 @@ export interface IBounds {
 /**
  * The types that can be drawn and thus added to the draw queue.
  */
-export declare type Drawable = Vertex | Vector | Triangle | Circle | CircleSector | PBImage | VEllipse | VEllipseSector | Polygon | BezierPath | Line;
+export declare type Drawable = Vertex | Vector | Triangle | Circle | CircleSector | PBImage | PBText | VEllipse | VEllipseSector | Polygon | BezierPath | Line;
 /**
  * A unique identifier (UID) to tell drawables apart in a performant manner.
  */
@@ -149,6 +151,12 @@ export interface DrawConfig {
     line: DrawSettings;
     vector: DrawSettings;
     image: DrawSettings;
+    text: {
+        color: string;
+        lineWidth: number;
+        fill?: boolean;
+        anchor?: boolean;
+    };
 }
 /** This is a fix for the problem, that the constructor's "name" attribute is not
  * visible in ES6:

package/src/cjs/interfaces/core.js

@@ -14,6 +14,7 @@
  * @modified 2021-05-31 Added the `drawLib.setConfiguration` function.
  * @modified 2021-05-31 Splitted the large interfaces.ts file into this one and others.
  * @modified 2021-06-21 Added `IBounds.getCenter()`.
+ * @modified 2021-11-16 Added `text` options to the `DrawConfig`.
  **/
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=core.js.map

package/src/cjs/interfaces/core.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../../ts/interfaces/core.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;IAeI"}
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../ts/interfaces/core.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;IAgBI"}

package/src/cjs/utils/datastructures/Color.d.ts

@@ -8,7 +8,13 @@
  * @modified 2020-10-23 Ported to Typescript.
  * @modified 2021-02-08 Fixed a lot of es2015 compatibility issues.
  * @modified 2021-02-08 Added basic tsdoc/jsdoc comments.
- * @version 0.0.9
+ * @modified 2021-11-05 Fixing the regex to parse rgba-strings.
+ * @modified 2021-11-05 Added return value `this` to all modifier functions (for chaining).
+ * @modified 2021-11-07 Changed the behavior of `darken` and `lighten`: the passed value is handled relative now which makes values much easier predictable and makes the change feel more 'natural'.
+ * @modified 2021-11-07 Did the same with `saturate` and `desaturate`.
+ * @modified 2021-11-07 Did the same with the `fadein` and `fadeout` functions.
+ * @modified 2021-11-07 Added setRed, setGreen, setBlue, setHue, setSaturation, setLiminance functions.
+ * @version 0.0.10
  **/
 /**
  * @classdesc A color class, inspired by neolitec's Javascript class.
@@ -101,13 +107,13 @@ export declare class Color {
      */
     red(): number;
     /**
-    * Get the green component of this RGB(A) color. This method just returns the `g` color attribute.
-    *
-    * @method green
-    * @instance
-    * @memberof Color
-    * @return {number} A value between 0.0 and 1.0.
-    */
+     * Get the green component of this RGB(A) color. This method just returns the `g` color attribute.
+     *
+     * @method green
+     * @instance
+     * @memberof Color
+     * @return {number} A value between 0.0 and 1.0.
+     */
     green(): number;
     /**
      * Get the blue component of this RGB(A) color. This method just returns the `b` color attribute.
@@ -118,6 +124,13 @@ export declare class Color {
      * @return {number} A value between 0.0 and 1.0.
      */
     blue(): number;
+    setRed(r: number): this;
+    setBlue(b: number): this;
+    setAlpha(a: number): this;
+    setGreen(g: number): this;
+    setHue(h: number): this;
+    setSaturation(s: number): this;
+    setLuminance(l: number): this;
     /**
      * Get this color as a CSS `hsl` string.
      *
@@ -181,13 +194,13 @@ export declare class Color {
      * @return {number} A value between 0.0 and 1.0.
      */
     alpha(): number;
-    saturate(v: string | number): void;
-    desaturate(v: string | number): void;
-    lighten(v: string | number): void;
-    darken(v: string | number): void;
-    fadein(v: string | number): void;
-    fadeout(v: string | number): void;
-    spin(v: string | number): void;
+    saturate(v: string | number): Color;
+    desaturate(v: string | number): Color;
+    lighten(v: string | number): Color;
+    darken(v: string | number): Color;
+    fadein(v: string | number): Color;
+    fadeout(v: string | number): Color;
+    spin(v: string | number): Color;
     static makeRGB(...args: any[]): Color;
     static makeHSL(...args: Array<number | string>): Color;
     static makeHEX(value: string): Color;