plotboilerplate 1.12.8 → 1.14.0

package/src/ts/drawutilssvg.ts

@@ -26,14 +26,30 @@
  * @modified 2021-03-31 Added 'ellipseSector' the the class names.
  * @modified 2021-03-31 Implemented buffering using a buffer <g> node and the beginDrawCycle and endDrawCycle methods.
  * @modified 2021-05-31 Added the `setConfiguration` function from `DrawLib`.
- * @version  1.3.0
+ * @modified 2021-11-15 Adding more parameters tot the `text()` function: fontSize, textAlign, fontFamily, lineHeight.
+ * @modified 2021-11-19 Fixing the `label(text,x,y)` position.
+ * @modified 2021-11-19 Added the `color` param to the `label(...)` function.
+ * @version  1.4.0
  **/
 
 import { CircleSector } from "./CircleSector";
 import { CubicBezierCurve } from "./CubicBezierCurve";
 import { Polygon } from "./Polygon";
 import { Vertex } from "./Vertex";
-import { DrawConfig, DrawLib, DrawSettings, XYCoords, XYDimension, SVGPathParams, UID, DrawLibConfiguration } from "./interfaces";
+import {
+  DrawConfig,
+  DrawLib,
+  DrawSettings,
+  XYCoords,
+  XYDimension,
+  SVGPathParams,
+  UID,
+  DrawLibConfiguration,
+  FontStyle,
+  FontWeight
+} from "./interfaces";
+
+const RAD_TO_DEG = 180 / Math.PI;
 
 /**
  * @classdesc A helper class for basic SVG drawing operations. This class should
@@ -203,7 +219,8 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
       "vertex": "Vertex",
       "line": "Line",
       "vector": "Vector",
-      "image": "Image"
+      "image": "Image",
+      "text": "Text"
     };
     // Question: why isn't this working if the svgNode is created dynamically? (nodeStyle.sheet is null)
     const rules = [];
@@ -1065,29 +1082,82 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
     }
     if (!isOpen) d.push("Z");
     node.setAttribute("d", d.join(" "));
-    return this._bindFillDraw(node, "polyline", color, lineWidth || 1);
+    return this._bindFillDraw(node, "polygon", color, lineWidth || 1);
   }
 
   /**
-   * Draw a text label at the given relative position.
+   * Draw a text at the given relative position.
    *
-   * @method label
+   * @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 drawutilssvg
+   * @memberof drawutils
    */
-  text(text: string, x: number, y: number, options?: { color?: string }): SVGElement {
+  text(
+    text: string,
+    x: number,
+    y: number,
+    options?: {
+      color?: string;
+      fontFamily?: string;
+      fontSize?: number;
+      fontStyle?: FontStyle;
+      fontWeight?: FontWeight;
+      lineHeight?: number;
+      textAlign?: CanvasRenderingContext2D["textAlign"];
+      rotation?: number;
+    }
+  ): SVGElement {
     options = options || {};
     const color: string = options.color || "black";
-
-    const node: SVGElement = this.makeNode("text");
-    node.setAttribute("x", `${this._x(x)}`);
-    node.setAttribute("y", `${this._y(y)}`);
-    node.innerHTML = text;
+    const lineHeight = (options.lineHeight ?? options.fontSize ?? 0) * this.scale.x;
+    // https://www.w3.org/TR/SVG/text.html#TextAnchorProperty
+    //    start | middle | end
+    const textAlign: "start" | "middle" | "end" =
+      options.textAlign === "left" || options.textAlign === "start"
+        ? "start"
+        : options.textAlign === "center"
+        ? "middle"
+        : options.textAlign === "right" || options.textAlign === "end"
+        ? "end"
+        : "start";
+    const transformOrigin = `${this._x(x)}px ${this._y(y)}px`;
+    const translate = `translate(${this._x(x)} ${this._y(y) + lineHeight / 2})`;
+    // Safari has a transform-origin/rotation bug.
+    // It's essential to use rotate(r,x,y) here. "rotate(r)"" with transform-origin(x,y) won't do the job.
+    // And rotate and translate cannot be used is combination on a text object.
+    // So wrap the text inside a <g>, translate the <g>, and rotate the text inside.
+    const rotate = options.rotation ? `rotate(${options.rotation * RAD_TO_DEG} 0 0)` : ``;
+
+    const node: SVGElement = this.makeNode("g");
+    const curId = this.curId;
+    this.curId = curId + "_text";
+    const textNode: SVGElement = this.makeNode("text");
+    node.appendChild(textNode);
+    textNode.setAttribute("font-family", options.fontFamily); // May be undefined
+    textNode.setAttribute("font-size", options.fontSize ? `${options.fontSize * this.scale.x}` : null);
+    textNode.setAttribute("font-style", options.fontStyle ? `${options.fontStyle}` : null);
+    textNode.setAttribute("font-weight", options.fontWeight ? `${options.fontWeight}` : null);
+    textNode.setAttribute("text-anchor", textAlign);
+    textNode.setAttribute("transform-origin", "0 0");
+    textNode.setAttribute("transform", rotate);
+    node.setAttribute("transform-origin", transformOrigin);
+    node.setAttribute("transform", translate);
+
+    textNode.innerHTML = text;
+    // Restore old ID
+    this.curId = curId;
     return this._bindFillDraw(node, "text", color, 1);
   }
 
@@ -1099,16 +1169,23 @@ export class drawutilssvg implements DrawLib<void | SVGElement> {
    * @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="black"} color - The color to use (default is black).
    * @return {void}
    * @instance
    * @memberof drawutilssvg
    */
-  label(text: string, x: number, y: number, rotation: number): SVGElement {
+  label(text: string, x: number, y: number, rotation?: number, color?: string): SVGElement {
     const node: SVGElement = this.makeNode("text");
     // For some strange reason SVG rotation transforms use degrees instead of radians
-    node.setAttribute("transform", `translate(${this.offset.x},${this.offset.y}), rotate(${(rotation / Math.PI) * 180})`);
+    node.setAttribute("transform", `translate(${x},${y}), rotate(${((rotation || 0) / Math.PI) * 180})`);
+
+    node.setAttribute("font-family", "Arial");
+    node.setAttribute("font-size", "9pt");
+    node.setAttribute("font-style", "normal");
+    node.setAttribute("font-weight", "lighter");
+
     node.innerHTML = text;
-    return this._bindFillDraw(node, "label", "black", null);
+    return this._bindFillDraw(node, "label", color || "black", null);
   }
 
   /**

package/src/ts/index.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/ts/interfaces/DrawLib.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";
@@ -27,6 +30,21 @@ 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 type FontWeight = "normal" | "bold" | "bolder" | "lighter" | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900;
+
+export 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.
  *
@@ -432,18 +450,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.
@@ -453,11 +478,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/ts/interfaces/core.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";
@@ -28,6 +29,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.
@@ -73,6 +75,7 @@ export type Drawable =
   | Circle
   | CircleSector
   | PBImage
+  | PBText
   | VEllipse
   | VEllipseSector
   | Polygon
@@ -189,6 +192,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