plotboilerplate 1.12.10 → 1.16.0

package/src/ts/PBImage.ts

@@ -4,20 +4,20 @@
  * @modified 2019-03-23 Added JSDoc tags.
  * @modified 2020-03-25 Ported this class from vanilla-JS to Typescript.
  * @modified 2021-01-20 Added UID.
- * @version 1.1.0
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @modified 2022-02-02 Cleared the `PBImage.toSVGString` function (deprecated). Use `drawutilssvg` instead.
+ * @version 1.2.0
  *
  * @file PBImage
- * @fileoverview As native Image objects have only a position and with 
+ * @fileoverview As native Image objects have only a position and with
  *               and height thei are not suitable for UI dragging interfaces.
  * @public
  **/
 
-
 import { Vertex } from "./Vertex";
 import { UIDGenerator } from "./UIDGenerator";
 import { SVGSerializable, UID } from "./interfaces";
 
-
 /**
  * @classdesc A wrapper for image objects. Has an upper left and a lower right corner point.
  *
@@ -27,76 +27,89 @@ import { SVGSerializable, UID } from "./interfaces";
  * @requires UIDGenerator
  */
 export class PBImage implements SVGSerializable {
+  /**
+   * Required to generate proper CSS classes and other class related IDs.
+   **/
+  readonly className: string = "PBImage";
 
+  /**
+   * The UID of this drawable object.
+   *
+   * @member {UID}
+   * @memberof PBImage
+   * @instance
+   * @readonly
+   */
+  readonly uid: UID;
 
-    /**
-     * Required to generate proper CSS classes and other class related IDs.
-     **/
-    readonly className : string = "PBImage";
+  /**
+   * @member {Vertex}
+   * @memberof PBImage
+   * @instance
+   */
+  image: HTMLImageElement;
 
+  /**
+   * @member {Vertex}
+   * @memberof PBImage
+   * @instance
+   */
+  upperLeft: Vertex;
 
-    /**
-     * The UID of this drawable object.
-     *
-     * @member {UID}
-     * @memberof PBImage
-     * @instance
-     * @readonly 
-     */
-    readonly uid : UID;
-    
+  /**
+   * @member {Vertex}
+   * @memberof PBImage
+   * @instance
+   */
+  lowerRight: Vertex;
 
-    /** 
-     * @member {Vertex} 
-     * @memberof PBImage
-     * @instance
-     */
-    image:HTMLImageElement;
+  /**
+   * @member isDestroyed
+   * @memberof PBImage
+   * @type {boolean}
+   * @instance
+   */
+  isDestroyed: boolean;
 
-    /** 
-     * @member {Vertex} 
-     * @memberof PBImage
-     * @instance
-     */
-    upperLeft:Vertex;
+  /**
+   * The constructor.
+   *
+   * @constructor
+   * @name PBImage
+   * @param {Image} image - The actual image.
+   * @param {Vertex} upperLeft - The upper left corner.
+   * @param {Vertex} lowerRight - The lower right corner.
+   **/
+  constructor(image: HTMLImageElement, upperLeft: Vertex, lowerRight: Vertex) {
+    this.uid = UIDGenerator.next();
+    this.image = image;
+    this.upperLeft = upperLeft;
+    this.lowerRight = lowerRight;
+  }
 
-    /** 
-     * @member {Vertex} 
-     * @memberof PBImage
-     * @instance
-     */
-    lowerRight:Vertex;
-    
-    
-    /**
-     * The constructor.
-     * 
-     * @constructor
-     * @name PBImage
-     * @param {Image} image - The actual image.
-     * @param {Vertex} upperLeft - The upper left corner.
-     * @param {Vertex} lowerRight - The lower right corner.
-     **/
-    constructor( image:HTMLImageElement, upperLeft:Vertex, lowerRight:Vertex ) {
-	this.uid = UIDGenerator.next();
-	this.image = image;
-	this.upperLeft = upperLeft;
-	this.lowerRight = lowerRight;
-    };
+  /**
+   * Convert this vertex to SVG code.
+   *
+   * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
+   * @method toSVGString
+   * @param {object=} options - An optional set of options, like 'className'.
+   * @return {string} A string representing the SVG code for this vertex.
+   * @instance
+   * @memberof PBImage
+   **/
+  toSVGString(options: { className?: string }): string {
+    console.warn("PBImage is not yet SVG serializable. Returning empty SVG string.");
+    return "";
+  }
 
-    
-    /**
-     * Convert this vertex to SVG code.
-     *
-     * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
-     * @method toSVGString
-     * @param {object=} options - An optional set of options, like 'className'.
-     * @return {string} A string representing the SVG code for this vertex.
-     * @instance
-     * @memberof PBImage
-     **/
-    toSVGString( options:{ className?:string } ) : string {
-	console.warn( "PBImage is not yet SVG serializable. Returning empty SVG string." );
-	return "";
-    };
+  /**
+   * This function should invalidate any installed listeners and invalidate this object.
+   * After calling this function the object might not hold valid data any more and
+   * should not be used.
+   */
+  destroy() {
+    this.upperLeft.destroy();
+    this.lowerRight.destroy();
+    this.isDestroyed = true;
+  }
 }

package/src/ts/PBText.ts

@@ -0,0 +1,166 @@
+/**
+ * @author   Ikaros Kappler
+ * @date     2021-11-16
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @version  1.1.0
+ **/
+
+import { UIDGenerator } from "./UIDGenerator";
+import { Vertex } from "./Vertex";
+import { FontOptions, FontStyle, FontWeight, SVGSerializable, UID } from "./interfaces";
+
+/**
+ * @classdesc A simple text element: position, fontSize, fontFamily, color, textAlign, lineHeight and rotation.
+ *
+ * @requires FontOptions
+ * @requires FontSize
+ * @requires FontStyle
+ * @requires FontWeight
+ * @requires Vertex
+ * @requires SVGSerializale
+ * @requires UID
+ * @requires UIDGenerator
+ **/
+export class PBText implements SVGSerializable, FontOptions {
+  /**
+   * Required to generate proper CSS classes and other class related IDs.
+   **/
+  readonly className: string = "PBText";
+
+  /**
+   * The UID of this drawable object.
+   *
+   * @member {UID}
+   * @memberof PBText
+   * @instance
+   * @readonly
+   */
+  readonly uid: UID;
+
+  /**
+   * @member {string}
+   * @memberof PBText
+   * @instance
+   */
+  text: string;
+
+  /**
+   * @member {Vertex}
+   * @memberof PBText
+   * @instance
+   */
+  anchor: Vertex;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  fontSize: number | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  lineHeight: number | undefined;
+
+  /**
+   * @member {FontWeight}
+   * @memberof PBText
+   * @instance
+   */
+  fontWeight: FontWeight | undefined;
+
+  /**
+   * @member {FontStyle}
+   * @memberof PBText
+   * @instance
+   */
+  fontStyle: FontStyle | undefined;
+
+  /**
+   * @member {CanvasRenderingContext2D["textAlign"]}
+   * @memberof PBText
+   * @instance
+   */
+  textAlign: CanvasRenderingContext2D["textAlign"] | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  rotation: number | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  fontFamily: string | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  color: string | undefined;
+
+  /**
+   * @member isDestroyed
+   * @memberof PBText
+   * @type {boolean}
+   * @instance
+   */
+  isDestroyed: boolean;
+
+  /**
+   * Create a new circle with given center point and radius.
+   *
+   * @constructor
+   * @name Circle
+   * @param {Vertex} center - The center point of the circle.
+   * @param {number} radius - The radius of the circle.
+   */
+  constructor(text: string, anchor?: Vertex, options?: FontOptions) {
+    this.uid = UIDGenerator.next();
+    this.text = text;
+    this.anchor = anchor ?? new Vertex();
+    this.color = options.color;
+    this.fontFamily = options.fontFamily;
+    this.fontSize = options.fontSize;
+    this.fontStyle = options.fontStyle;
+    this.fontWeight = options.fontWeight;
+    this.lineHeight = options.lineHeight;
+    this.textAlign = options.textAlign;
+    this.rotation = options.rotation;
+  }
+
+  /**
+   * Create an SVG representation of this circle.
+   *
+   * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
+   * @method toSVGString
+   * @param {object=} options - An optional set of options, like 'className'.
+   * @return {string} A string representing the SVG code for this vertex.
+   * @instance
+   * @memberof Circle
+   */
+  toSVGString(options: { className?: string }) {
+    console.warn(
+      "[PBText.toSVGString()] This function is not implemented as it defines a deprecated method. Use the 'drawutilssvg.text()' method instead."
+    );
+    return "";
+  }
+
+  /**
+   * This function should invalidate any installed listeners and invalidate this object.
+   * After calling this function the object might not hold valid data any more and
+   * should not be used.
+   */
+  destroy() {
+    this.anchor.destroy();
+    this.isDestroyed = true;
+  }
+} // END class

package/src/ts/PlotBoilerplate.ts

@@ -73,7 +73,8 @@
  * @modified 2021-03-03 Added the `VEllipseSector` drawable.
  * @modified 2021-03-29 Clearing `currentClassName` and `currentId` after drawing each drawable.
  * @modified 2021-04-25 Extending `remove` to accept arrays of drawables.
- * @version  1.14.0
+ * @modified 2021-11-16 Adding the `PBText` drawable.
+ * @version  1.15.0
  *
  * @file PlotBoilerplate
  * @fileoverview The main class.
@@ -118,6 +119,8 @@ import {
   XYDimension,
   DatGuiProps
 } from "./interfaces";
+import { PBText } from "./PBText";
+import { AlloyFingerOptions } from "alloyfinger-typescript/src/cjs/alloy_finger";
 
 /**
  * @classdesc The main class of the PlotBoilerplate.
@@ -521,6 +524,12 @@ export class PlotBoilerplate {
       image: {
         color: "#a8a8a8",
         lineWidth: 1
+      },
+      text: {
+        color: "rgba(192,0,128,0.5)",
+        lineWidth: 1,
+        fill: true,
+        anchor: true
       }
     }; // END drawConfig
 
@@ -656,7 +665,7 @@ export class PlotBoilerplate {
     var blob = new Blob([svgCode], { type: "image/svg;charset=utf-8" });
     // See documentation for FileSaver.js for usage.
     //    https://github.com/eligrey/FileSaver.js
-    if (typeof globalThis["saveAs"] != "function")
+    if (typeof globalThis["saveAs"] !== "function")
       throw "Cannot save file; did you load the ./utils/savefile helper function and the eligrey/SaveFile library?";
     var _saveAs = globalThis["saveAs"];
     _saveAs(blob, "plotboilerplate.svg");
@@ -768,7 +777,6 @@ export class PlotBoilerplate {
   add(drawable: Drawable | Array<Drawable>, redraw?: boolean) {
     if (Array.isArray(drawable)) {
       const arr: Array<Drawable> = drawable as Array<Drawable>;
-      // for( var i in arr )
       for (var i = 0; i < arr.length; i++) {
         this.add(arr[i], false);
       }
@@ -806,8 +814,9 @@ export class PlotBoilerplate {
       this.drawables.push(drawable);
     } else if (drawable instanceof Polygon) {
       this.drawables.push(drawable);
-      // for( var i in drawable.vertices )
-      for (var i = 0; i < drawable.vertices.length; i++) this.vertices.push(drawable.vertices[i]);
+      for (var i = 0; i < drawable.vertices.length; i++) {
+        this.vertices.push(drawable.vertices[i]);
+      }
     } else if (drawable instanceof Triangle) {
       this.drawables.push(drawable);
       this.vertices.push(drawable.a);
@@ -817,7 +826,9 @@ export class PlotBoilerplate {
       this.drawables.push(drawable);
       const bezierPath: BezierPath = drawable as BezierPath;
       for (var i = 0; i < bezierPath.bezierCurves.length; i++) {
-        if (!drawable.adjustCircular && i == 0) this.vertices.push(bezierPath.bezierCurves[i].startPoint);
+        if (!drawable.adjustCircular && i == 0) {
+          this.vertices.push(bezierPath.bezierCurves[i].startPoint);
+        }
         this.vertices.push(bezierPath.bezierCurves[i].endPoint);
         this.vertices.push(bezierPath.bezierCurves[i].startControlPoint);
         this.vertices.push(bezierPath.bezierCurves[i].endControlPoint);
@@ -834,6 +845,10 @@ export class PlotBoilerplate {
         drawable.lowerRight.add(e.params.dragAmount);
       });
       drawable.lowerRight.attr.selectable = false;
+    } else if (drawable instanceof PBText) {
+      this.vertices.push(drawable.anchor);
+      this.drawables.push(drawable);
+      drawable.anchor.attr.selectable = false;
     } else {
       throw "Cannot add drawable of unrecognized type: " + typeof drawable + ".";
     }
@@ -882,7 +897,7 @@ export class PlotBoilerplate {
       }
     }
     for (var i = 0; i < this.drawables.length; i++) {
-      if (this.drawables[i] === drawable) {
+      if (this.drawables[i] === drawable || this.drawables[i].uid === drawable.uid) {
         this.drawables.splice(i, 1);
 
         if (removeWithVertices) {
@@ -923,6 +938,8 @@ export class PlotBoilerplate {
           } else if (drawable instanceof PBImage) {
             this.removeVertex(drawable.upperLeft, false);
             this.removeVertex(drawable.lowerRight, false);
+          } else if (drawable instanceof PBText) {
+            this.removeVertex(drawable.anchor, false);
           }
         } // END removeWithVertices
 
@@ -947,7 +964,9 @@ export class PlotBoilerplate {
     for (var i = 0; i < this.vertices.length; i++) {
       if (this.vertices[i] === vert) {
         this.vertices.splice(i, 1);
-        if (redraw) this.redraw();
+        if (redraw) {
+          this.redraw();
+        }
         return;
       }
     }
@@ -987,7 +1006,9 @@ export class PlotBoilerplate {
       this.transformMousePosition(pixelPosition.x, pixelPosition.y),
       pixelTolerance / Math.min(this.config.cssScaleX, this.config.cssScaleY)
     );
-    if (p && p.typeName == "vertex") return this.vertices[p.vindex];
+    if (p && p.typeName == "vertex") {
+      return this.vertices[p.vindex];
+    }
     return undefined;
   }
 
@@ -1320,6 +1341,15 @@ export class PlotBoilerplate {
         draw.circleHandle(d.lowerRight, 3, this.drawConfig.image.color);
         d.lowerRight.attr.renderTime = renderTime;
       }
+    } else if (d instanceof PBText) {
+      fill.setCurrentId(d.uid);
+      fill.text(d.text, d.anchor.x, d.anchor.y, d);
+      if (this.drawConfig.text.anchor) {
+        draw.setCurrentId(`${d.uid}_a0`);
+        draw.setCurrentClassName(`${d.className}-anchor`);
+        (this.drawConfig.text.fill ? fill : draw).point(d.anchor, this.drawConfig.text.color);
+      }
+      d.anchor.attr.renderTime = renderTime;
     } else {
       console.error("Cannot draw object. Unknown class.");
     }
@@ -1617,7 +1647,6 @@ export class PlotBoilerplate {
     // Apply the zoom (the tolerant area should not shrink or grow when zooming)
     tolerance /= _self.draw.scale.x;
     // Search in vertices
-    // for( var vindex in _self.vertices ) {
     for (var vindex = 0; vindex < _self.vertices.length; vindex++) {
       var vert: Vertex = _self.vertices[vindex];
       if ((vert.attr.draggable || vert.attr.selectable) && vert.distance(point) < tolerance) {
@@ -1638,10 +1667,7 @@ export class PlotBoilerplate {
    * @return {void}
    **/
   private handleClick(e: XMouseEvent) {
-    // x:number,y:number) {
     const _self: PlotBoilerplate = this;
-    // const x:number = e.params.pos.x;
-    //const y:number = e.params.pos.y;
     var p: IDraggable = this.locatePointNear(
       _self.transformMousePosition(e.params.pos.x, e.params.pos.y),
       PlotBoilerplate.DEFAULT_CLICK_TOLERANCE / Math.min(_self.config.cssScaleX, _self.config.cssScaleY)
@@ -1657,9 +1683,7 @@ export class PlotBoilerplate {
           if (vert.attr.selectable) vert.attr.isSelected = !vert.attr.isSelected;
         }
         _self.redraw();
-      } else if (
-        this.keyHandler.isDown("y") /* && p.type=='bpath' && (p.pid==BezierPath.START_POINT || p.pid==BezierPath.END_POINT) */
-      ) {
+      } else if (this.keyHandler.isDown("y")) {
         _self.vertices[p.vindex].attr.bezierAutoAdjust = !_self.vertices[p.vindex].attr.bezierAutoAdjust;
         _self.redraw();
       }
@@ -1961,7 +1985,8 @@ export class PlotBoilerplate {
             multiTouchStartScale = null;
             _self.draggedElements = [];
           };
-          const afProps = {
+          const afProps: AlloyFingerOptions = {
+            // touchStart: (evt: TouchEvent) => {
             touchStart: (evt: TouchEvent) => {
               if (evt.touches.length == 1) {
                 touchMovePos = new Vertex(relPos({ x: evt.touches[0].clientX, y: evt.touches[0].clientY }));
@@ -2065,10 +2090,13 @@ export class PlotBoilerplate {
               _self.setZoom(multiTouchStartScale.x * evt.zoom, multiTouchStartScale.y * evt.zoom, center);
               _self.redraw();
             }
-          }; // END afProps
-          if (window["createAlloyFinger"])
+          } as unknown as AlloyFingerOptions; // END afProps
+          if (window["createAlloyFinger"]) {
             window["createAlloyFinger"](this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
-          else new AlloyFinger(this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
+          } else {
+            /* tslint:disable-next-line */
+            new AlloyFinger(this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
+          }
         } catch (e) {
           console.error("Failed to initialize AlloyFinger!");
           console.error(e);