@inweb/markup 26.1.0 → 26.1.2

package/lib/markup/IMarkup.d.ts

@@ -31,18 +31,17 @@ export interface IMarkup {
     /**
      * Initializes the markup instance. Call {@link dispose | dispose()} to release allocated resources.
      *
-     * @param container - Container element used to operate on. This is usually a `<canvas>` or
-     *   `<div>` on top of which the markup is drawn. If the `container` is a `<canvas>` element,
-     *   its content will be combined with the markup in the viewpoint snapshot.
+     * @param container - Container element used to operate on. This is usually a `<canvas>` or `<div>` on
+     *   top of which the markup is drawn. If the `container` is a `<canvas>` element, its content will be
+     *   combined with the markup in the viewpoint snapshot.
      * @param containerEvents - List of container events, such as mouse events or
      *   {@link https://developer.mozilla.org/docs/Web/API/Pointer_events#event_types_and_global_event_handlers | pointer events}
-     *   or
-     *   {@link https://developer.mozilla.org/docs/Web/API/TouchEvent#touch_event_types | touch events}
+     *   or {@link https://developer.mozilla.org/docs/Web/API/TouchEvent#touch_event_types | touch events}
      *   that the markup should redirect to the `viewer`.
      * @param viewer - `Viewer` instance that receives pointing device events.
-     * @param worldTransformer - Transformer of screen space into the `viewer` world space and
-     *   vice versa. If a transformer is defined, markup objects will be stored at the viewpoint
-     *   in world coordinates, otherwise in screen coordinates.
+     * @param worldTransformer - Transformer of screen space into the `viewer` world space and vice versa.
+     *   If a transformer is defined, markup objects will be stored at the viewpoint in world coordinates,
+     *   otherwise in screen coordinates.
      */
     initialize(container: HTMLElement, containerEvents?: string[], viewer?: IEventEmitter, worldTransformer?: IWorldTransform): void;
     /**
@@ -102,15 +101,15 @@ export interface IMarkup {
     /**
      * Enables mouse interactions to select or draw markups.
      *
-     * @param mode - Edit mode. Matches the type of markup object being created. Specify `false`
-     *   to exit edit mode.
+     * @param mode - Edit mode. Matches the type of markup object being created. Specify `false` to exit
+     *   edit mode.
      */
     enableEditMode(mode: MarkupMode | false): this;
     /**
      * Creates a markup object.
      *
-     * @param type - Markup object type. Can be `Line`, `Text`, `Rectangle`, `Ellipse`, `Arrow`,
-     *   `Image` or `Cloud`.
+     * @param type - Markup object type. Can be `Line`, `Text`, `Rectangle`, `Ellipse`, `Arrow`, `Image` or
+     *   `Cloud`.
      * @param params - Parameters for creating a markup object. Must match the object type:
      *
      *   - `Line` - {@link IMarkupLineParams}

package/lib/markup/IMarkupArrow.d.ts

@@ -62,8 +62,8 @@ export interface IMarkupArrowParams {
         y: number;
     };
     /**
-     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/IMarkupCloud.d.ts

@@ -70,8 +70,8 @@ export interface IMarkupCloudParams {
      */
     lineWidth?: number;
     /**
-     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/IMarkupColorable.d.ts

@@ -3,8 +3,8 @@
  */
 export interface IMarkupColorable {
     /**
-     * Returns the foreground color of an object's line or text as a string in hexadecimal color
-     * syntax `#RGB` using its primary color components (red, green, blue) written as hexadecimal numbers.
+     * Returns the foreground color of an object's line or text as a string in hexadecimal color syntax
+     * `#RGB` using its primary color components (red, green, blue) written as hexadecimal numbers.
      */
     getColor(): string;
     /**

package/lib/markup/IMarkupEllipse.d.ts

@@ -67,8 +67,8 @@ export interface IMarkupEllipseParams {
      */
     lineWidth?: number;
     /**
-     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/IMarkupImage.d.ts

@@ -31,8 +31,8 @@ export interface IMarkupImage extends IMarkupObject {
      */
     getWidth(): number;
     /**
-     * Sets the width of the image. The image height will be automatically updated to match its
-     * aspect ratio.
+     * Sets the width of the image. The image height will be automatically updated to match its aspect
+     * ratio.
      */
     setWidth(w: number): void;
     /**
@@ -40,8 +40,8 @@ export interface IMarkupImage extends IMarkupObject {
      */
     getHeight(): number;
     /**
-     * Sets the height of the image. The image width will be automatically updated to match its
-     * aspect ratio.
+     * Sets the height of the image. The image width will be automatically updated to match its aspect
+     * ratio.
      */
     setHeight(h: number): void;
 }
@@ -62,27 +62,27 @@ export interface IMarkupImageParams {
      */
     src?: string;
     /**
-     * Width of the image. The original image is scaled to this width. Specify 0 to set width of
-     * the source image.
+     * Width of the image. The original image is scaled to this width. Specify 0 to set width of the source
+     * image.
      *
      * @default 0
      */
     width?: number;
     /**
-     * Height of the image. The original image is scaled to this height. Specify 0 to set height
-     * of the source image.
+     * Height of the image. The original image is scaled to this height. Specify 0 to set height of the
+     * source image.
      *
      * @default 0
      */
     height?: number;
     /**
-     * Maximum width of the image. Specify a max width if you want to set the width to the
-     * original image but not more than the max.
+     * Maximum width of the image. Specify a max width if you want to set the width to the original image
+     * but not more than the max.
      */
     maxWidth?: number;
     /**
-     * Maximum height of the image. Specify a max height if you want to set the height to the
-     * original image but not more than the max.
+     * Maximum height of the image. Specify a max height if you want to set the height to the original
+     * image but not more than the max.
      */
     maxHeight?: number;
     /**

package/lib/markup/IMarkupLine.d.ts

@@ -64,8 +64,8 @@ export interface IMarkupLineParams {
      */
     width?: number;
     /**
-     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/IMarkupRectangle.d.ts

@@ -70,8 +70,8 @@ export interface IMarkupRectangleParams {
      */
     lineWidth?: number;
     /**
-     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/IMarkupText.d.ts

@@ -60,8 +60,8 @@ export interface IMarkupTextParams {
      */
     fontSize?: number;
     /**
-     * Text color as a string in hexadecimal color syntax `#RGB` color using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Text color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      *
      * @default "#ff0000"
      */

package/lib/markup/Konva/MarkupColor.d.ts

@@ -15,8 +15,8 @@ export declare class MarkupColor {
      */
     constructor(r: number, g: number, b: number);
     /**
-     * Returns the color as a string in hexadecimal color syntax `#RGB` using its primary color
-     * components (red, green, blue) written as hexadecimal numbers.
+     * Returns the color as a string in hexadecimal color syntax `#RGB` using its primary color components
+     * (red, green, blue) written as hexadecimal numbers.
      */
     asHex(): string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/markup",
-  "version": "26.1.0",
+  "version": "26.1.2",
   "description": "JavaScript 2D markups",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,11 +26,11 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~26.1.0",
-    "@inweb/viewer-core": "~26.1.0"
+    "@inweb/eventemitter2": "~26.1.2",
+    "@inweb/viewer-core": "~26.1.2"
   },
   "devDependencies": {
-    "konva": "^9.3.16"
+    "konva": "^9.3.18"
   },
   "peerDependencies": {
     "konva": "^9.3.14"

package/src/markup/IMarkup.ts

@@ -59,18 +59,17 @@ export interface IMarkup {
   /**
    * Initializes the markup instance. Call {@link dispose | dispose()} to release allocated resources.
    *
-   * @param container - Container element used to operate on. This is usually a `<canvas>` or
-   *   `<div>` on top of which the markup is drawn. If the `container` is a `<canvas>` element,
-   *   its content will be combined with the markup in the viewpoint snapshot.
+   * @param container - Container element used to operate on. This is usually a `<canvas>` or `<div>` on
+   *   top of which the markup is drawn. If the `container` is a `<canvas>` element, its content will be
+   *   combined with the markup in the viewpoint snapshot.
    * @param containerEvents - List of container events, such as mouse events or
    *   {@link https://developer.mozilla.org/docs/Web/API/Pointer_events#event_types_and_global_event_handlers | pointer events}
-   *   or
-   *   {@link https://developer.mozilla.org/docs/Web/API/TouchEvent#touch_event_types | touch events}
+   *   or {@link https://developer.mozilla.org/docs/Web/API/TouchEvent#touch_event_types | touch events}
    *   that the markup should redirect to the `viewer`.
    * @param viewer - `Viewer` instance that receives pointing device events.
-   * @param worldTransformer - Transformer of screen space into the `viewer` world space and
-   *   vice versa. If a transformer is defined, markup objects will be stored at the viewpoint
-   *   in world coordinates, otherwise in screen coordinates.
+   * @param worldTransformer - Transformer of screen space into the `viewer` world space and vice versa.
+   *   If a transformer is defined, markup objects will be stored at the viewpoint in world coordinates,
+   *   otherwise in screen coordinates.
    */
   initialize(
     container: HTMLElement,
@@ -141,16 +140,16 @@ export interface IMarkup {
   /**
    * Enables mouse interactions to select or draw markups.
    *
-   * @param mode - Edit mode. Matches the type of markup object being created. Specify `false`
-   *   to exit edit mode.
+   * @param mode - Edit mode. Matches the type of markup object being created. Specify `false` to exit
+   *   edit mode.
    */
   enableEditMode(mode: MarkupMode | false): this;
 
   /**
    * Creates a markup object.
    *
-   * @param type - Markup object type. Can be `Line`, `Text`, `Rectangle`, `Ellipse`, `Arrow`,
-   *   `Image` or `Cloud`.
+   * @param type - Markup object type. Can be `Line`, `Text`, `Rectangle`, `Ellipse`, `Arrow`, `Image` or
+   *   `Cloud`.
    * @param params - Parameters for creating a markup object. Must match the object type:
    *
    *   - `Line` - {@link IMarkupLineParams}

package/src/markup/IMarkupArrow.ts

@@ -76,8 +76,8 @@ export interface IMarkupArrowParams {
   end?: { x: number; y: number };
 
   /**
-   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/IMarkupCloud.ts

@@ -100,8 +100,8 @@ export interface IMarkupCloudParams {
   lineWidth?: number;
 
   /**
-   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/IMarkupColorable.ts

@@ -26,8 +26,8 @@
  */
 export interface IMarkupColorable {
   /**
-   * Returns the foreground color of an object's line or text as a string in hexadecimal color
-   * syntax `#RGB` using its primary color components (red, green, blue) written as hexadecimal numbers.
+   * Returns the foreground color of an object's line or text as a string in hexadecimal color syntax
+   * `#RGB` using its primary color components (red, green, blue) written as hexadecimal numbers.
    */
   getColor(): string;
 

package/src/markup/IMarkupEllipse.ts

@@ -93,8 +93,8 @@ export interface IMarkupEllipseParams {
   lineWidth?: number;
 
   /**
-   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/IMarkupImage.ts

@@ -57,8 +57,8 @@ export interface IMarkupImage extends IMarkupObject {
   getWidth(): number;
 
   /**
-   * Sets the width of the image. The image height will be automatically updated to match its
-   * aspect ratio.
+   * Sets the width of the image. The image height will be automatically updated to match its aspect
+   * ratio.
    */
   setWidth(w: number): void;
 
@@ -68,8 +68,8 @@ export interface IMarkupImage extends IMarkupObject {
   getHeight(): number;
 
   /**
-   * Sets the height of the image. The image width will be automatically updated to match its
-   * aspect ratio.
+   * Sets the height of the image. The image width will be automatically updated to match its aspect
+   * ratio.
    */
   setHeight(h: number): void;
 }
@@ -90,30 +90,30 @@ export interface IMarkupImageParams {
   src?: string;
 
   /**
-   * Width of the image. The original image is scaled to this width. Specify 0 to set width of
-   * the source image.
+   * Width of the image. The original image is scaled to this width. Specify 0 to set width of the source
+   * image.
    *
    * @default 0
    */
   width?: number;
 
   /**
-   * Height of the image. The original image is scaled to this height. Specify 0 to set height
-   * of the source image.
+   * Height of the image. The original image is scaled to this height. Specify 0 to set height of the
+   * source image.
    *
    * @default 0
    */
   height?: number;
 
   /**
-   * Maximum width of the image. Specify a max width if you want to set the width to the
-   * original image but not more than the max.
+   * Maximum width of the image. Specify a max width if you want to set the width to the original image
+   * but not more than the max.
    */
   maxWidth?: number;
 
   /**
-   * Maximum height of the image. Specify a max height if you want to set the height to the
-   * original image but not more than the max.
+   * Maximum height of the image. Specify a max height if you want to set the height to the original
+   * image but not more than the max.
    */
   maxHeight?: number;
 

package/src/markup/IMarkupLine.ts

@@ -92,8 +92,8 @@ export interface IMarkupLineParams {
   width?: number;
 
   /**
-   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/IMarkupRectangle.ts

@@ -100,8 +100,8 @@ export interface IMarkupRectangleParams {
   lineWidth?: number;
 
   /**
-   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/IMarkupText.ts

@@ -88,8 +88,8 @@ export interface IMarkupTextParams {
   fontSize?: number;
 
   /**
-   * Text color as a string in hexadecimal color syntax `#RGB` color using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Text color as a string in hexadecimal color syntax `#RGB` color using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    *
    * @default "#ff0000"
    */

package/src/markup/Konva/MarkupColor.ts

@@ -42,8 +42,8 @@ export class MarkupColor {
   }
 
   /**
-   * Returns the color as a string in hexadecimal color syntax `#RGB` using its primary color
-   * components (red, green, blue) written as hexadecimal numbers.
+   * Returns the color as a string in hexadecimal color syntax `#RGB` using its primary color components
+   * (red, green, blue) written as hexadecimal numbers.
    */
   public asHex(): string {
     return "#" + this.HEX;