@inweb/markup 25.9.1 → 25.9.3

package/lib/index.d.ts

@@ -1,12 +1,12 @@
 export { IMarkup, MarkupMode } from "./markup/IMarkup";
-export { IMarkupArrow } from "./markup/IMarkupArrow";
-export { IMarkupCloud } from "./markup/IMarkupCloud";
+export { IMarkupArrow, IMarkupArrowParams } from "./markup/IMarkupArrow";
+export { IMarkupCloud, IMarkupCloudParams } from "./markup/IMarkupCloud";
 export { IMarkupColorable } from "./markup/IMarkupColorable";
-export { IMarkupEllipse } from "./markup/IMarkupEllipse";
-export { IMarkupImage } from "./markup/IMarkupImage";
+export { IMarkupEllipse, IMarkupEllipseParams } from "./markup/IMarkupEllipse";
+export { IMarkupImage, IMarkupImageParams } from "./markup/IMarkupImage";
 export { IMarkupLine, IMarkupLineParams, MarkupLineType } from "./markup/IMarkupLine";
 export { IMarkupObject } from "./markup/IMarkupObject";
-export { IMarkupRectangle } from "./markup/IMarkupRectangle";
-export { IMarkupText } from "./markup/IMarkupText";
+export { IMarkupRectangle, IMarkupRectangleParams } from "./markup/IMarkupRectangle";
+export { IMarkupText, IMarkupTextParams } from "./markup/IMarkupText";
 export { IWorldTransform } from "./markup/IWorldTransform";
 export { KonvaMarkup as Markup } from "./markup/Konva/KonvaMarkup";

package/lib/markup/IMarkup.d.ts

@@ -46,7 +46,7 @@ export interface IMarkup {
      */
     initialize(container: HTMLElement, containerEvents?: string[], viewer?: IEventEmitter, worldTransformer?: IWorldTransform): void;
     /**
-     * Releases all resources allocated by this markup instance.
+     * Releases resources allocated in the {@link initialize | initialize()}.
      */
     dispose(): void;
     /**

package/lib/markup/IMarkupArrow.d.ts

@@ -19,7 +19,7 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
     setPoints(points: {
         x: number;
         y: number;
-    }[]): any;
+    }[]): void;
     /**
      * Returns the coordinales of the start point of arrow.
      */
@@ -30,7 +30,7 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinales of the start point of the arrow.
      */
-    setStartPoint(x: number, y: number): any;
+    setStartPoint(x: number, y: number): void;
     /**
      * Returns the coordinales of the end point of arrow.
      */
@@ -41,5 +41,35 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinales of the end point of the arrow.
      */
-    setEndPoint(x: number, y: number): any;
+    setEndPoint(x: number, y: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupArrow | markup arrow}.
+ */
+export interface IMarkupArrowParams {
+    /**
+     * Coordinales of the start point of arrow.
+     */
+    start?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Coordinales of the end point of arrow.
+     */
+    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.
+     *
+     * @default "#ff0000"
+     */
+    color?: string;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

package/lib/markup/IMarkupCloud.d.ts

@@ -14,7 +14,7 @@ export interface IMarkupCloud extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinates of the top-left point (position) of the cloud.
      */
-    setPosition(x: number, y: number): any;
+    setPosition(x: number, y: number): void;
     /**
      * Returns the width of the cloud.
      */
@@ -22,7 +22,7 @@ export interface IMarkupCloud extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the width of the cloud.
      */
-    setWidth(w: number): any;
+    setWidth(w: number): void;
     /**
      * Returns the height of the cloud.
      */
@@ -30,7 +30,7 @@ export interface IMarkupCloud extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the height of the cloud.
      */
-    setHeight(h: number): any;
+    setHeight(h: number): void;
     /**
      * Returns the line width of the cloud.
      */
@@ -38,5 +38,46 @@ export interface IMarkupCloud extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the line width of the cloud.
      */
-    setLineWidth(size: number): any;
+    setLineWidth(size: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupCloudParams | markup cloud}.
+ */
+export interface IMarkupCloudParams {
+    /**
+     * Coordinates of the top-left point (position) of the cloud.
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Width of the cloud.
+     *
+     * @default 200
+     */
+    width?: number;
+    /**
+     * Height of the cloud.
+     *
+     * @default 200
+     */
+    height?: number;
+    /**
+     * Line width.
+     *
+     * @default 4
+     */
+    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.
+     *
+     * @default "#ff0000"
+     */
+    color?: string;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

package/lib/markup/IMarkupEllipse.d.ts

@@ -14,7 +14,7 @@ export interface IMarkupEllipse extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinates of the top-left point (position) of the ellipse.
      */
-    setPosition(x: number, y: number): any;
+    setPosition(x: number, y: number): void;
     /**
      * Returns the X radius of the ellipse.
      */
@@ -22,7 +22,7 @@ export interface IMarkupEllipse extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the X radius of the ellipse.
      */
-    setRadiusX(r: number): any;
+    setRadiusX(r: number): void;
     /**
      * Returns the Y radius of the ellipse.
      */
@@ -30,7 +30,7 @@ export interface IMarkupEllipse extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the X radius of the ellipse.
      */
-    setRadiusY(r: number): any;
+    setRadiusY(r: number): void;
     /**
      * Returns the line width of the ellipse.
      */
@@ -38,5 +38,43 @@ export interface IMarkupEllipse extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the line width of the ellipse.
      */
-    setLineWidth(size: number): any;
+    setLineWidth(size: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupEllipse | markup ellipse}.
+ */
+export interface IMarkupEllipseParams {
+    /**
+     * Coordinates of the center point (position) of the ellipse.
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Radius of the ellipse along the X and Y axes.
+     *
+     * @default 25
+     */
+    radius?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Line width.
+     *
+     * @default 4
+     */
+    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.
+     *
+     * @default "#ff0000"
+     */
+    color?: string;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

package/lib/markup/IMarkupImage.d.ts

@@ -13,7 +13,7 @@ export interface IMarkupImage extends IMarkupObject {
     /**
      * Sets the coordinates of the top-left point (position) of the image.
      */
-    setPosition(x: number, y: number): any;
+    setPosition(x: number, y: number): void;
     /**
      * Returns the image source as a base64-encoded
      * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
@@ -25,7 +25,7 @@ export interface IMarkupImage extends IMarkupObject {
      *
      * @param src - Image source as base64-encoded string.
      */
-    setSrc(src: string): any;
+    setSrc(src: string): void;
     /**
      * Returns the width of the image. The original image is scaled to this width.
      */
@@ -34,7 +34,7 @@ export interface IMarkupImage extends IMarkupObject {
      * Sets the width of the image. The image height will be automatically updated to match its
      * aspect ratio.
      */
-    setWidth(w: number): any;
+    setWidth(w: number): void;
     /**
      * Returns the height of the image. The original image is scaled to this height.
      */
@@ -43,5 +43,50 @@ export interface IMarkupImage extends IMarkupObject {
      * Sets the height of the image. The image width will be automatically updated to match its
      * aspect ratio.
      */
-    setHeight(h: number): any;
+    setHeight(h: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupImage | markup image}.
+ */
+export interface IMarkupImageParams {
+    /**
+     * Coordinates of the top-left point (position) of the image.
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Image source as a base64-encoded
+     * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
+     */
+    src?: string;
+    /**
+     * 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.
+     *
+     * @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.
+     */
+    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.
+     */
+    maxHeight?: number;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

package/lib/markup/IMarkupRectangle.d.ts

@@ -14,7 +14,7 @@ export interface IMarkupRectangle extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinates of the top-left point (position) of the rectangle.
      */
-    setPosition(x: number, y: number): any;
+    setPosition(x: number, y: number): void;
     /**
      * Returns the width of the rectangle.
      */
@@ -22,7 +22,7 @@ export interface IMarkupRectangle extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the width of the rectangle.
      */
-    setWidth(w: number): any;
+    setWidth(w: number): void;
     /**
      * Returns the height of the rectangle.
      */
@@ -30,7 +30,7 @@ export interface IMarkupRectangle extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the height of the rectangle.
      */
-    setHeight(h: number): any;
+    setHeight(h: number): void;
     /**
      * Returns the line width of the rectangle.
      */
@@ -38,5 +38,46 @@ export interface IMarkupRectangle extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the line width of the rectangle.
      */
-    setLineWidth(size: number): any;
+    setLineWidth(size: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupRectangle | markup rectangle}.
+ */
+export interface IMarkupRectangleParams {
+    /**
+     * Coordinates of the top-left point (position) of the rectangle.
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Width of the rectangle.
+     *
+     * @default 200
+     */
+    width?: number;
+    /**
+     * Height of the rectangle.
+     *
+     * @default 200
+     */
+    height?: number;
+    /**
+     * Line width.
+     *
+     * @default 4
+     */
+    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.
+     *
+     * @default "#ff0000"
+     */
+    color?: string;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

package/lib/markup/IMarkupText.d.ts

@@ -22,13 +22,52 @@ export interface IMarkupText extends IMarkupObject, IMarkupColorable {
     /**
      * Sets the coordinates of the top-left point (position) of the text.
      */
-    setPosition(x: number, y: number): any;
+    setPosition(x: number, y: number): void;
     /**
      * Returns the font size of the text.
      */
-    getFontSize(): any;
+    getFontSize(): number;
     /**
      * Sets the font size of the text.
      */
-    setFontSize(size: number): any;
+    setFontSize(size: number): void;
+}
+/**
+ * Defines the parameters for creating a {@link IMarkupText | markup text}.
+ */
+export interface IMarkupTextParams {
+    /**
+     * Coordinates of the top-left point (position) of the text.
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Text string.
+     */
+    text?: string;
+    /**
+     * Rotation angle of the text, in degress.
+     *
+     * @default 0
+     */
+    rotation?: number;
+    /**
+     * Font size of the text.
+     *
+     * @default 34
+     */
+    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.
+     *
+     * @default "#ff0000"
+     */
+    color?: string;
+    /**
+     * Internal markup object identifier.
+     */
+    id?: string;
 }

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

@@ -1,18 +1,7 @@
-import { IMarkupArrow } from "../IMarkupArrow";
+import { IMarkupArrow, IMarkupArrowParams } from "../IMarkupArrow";
 export declare class KonvaArrow implements IMarkupArrow {
     private _ref;
-    constructor(params: {
-        start?: {
-            x: number;
-            y: number;
-        };
-        end?: {
-            x: number;
-            y: number;
-        };
-        color?: string;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupArrowParams, ref?: any);
     ref(): import("konva/lib/shapes/Arrow").Arrow;
     id(): string;
     enableMouseEditing(value: boolean): void;

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

@@ -1,17 +1,7 @@
-import { IMarkupCloud } from "../IMarkupCloud";
+import { IMarkupCloud, IMarkupCloudParams } from "../IMarkupCloud";
 export declare class KonvaCloud implements IMarkupCloud {
     private _ref;
-    constructor(params: {
-        position?: {
-            x: number;
-            y: number;
-        };
-        width?: number;
-        height?: number;
-        lineWidth?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupCloudParams, ref?: any);
     ref(): import("konva/lib/Shape").Shape<import("konva/lib/Shape").ShapeConfig>;
     id(): string;
     enableMouseEditing(value: boolean): void;

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

@@ -1,19 +1,7 @@
-import { IMarkupEllipse } from "../IMarkupEllipse";
+import { IMarkupEllipse, IMarkupEllipseParams } from "../IMarkupEllipse";
 export declare class KonvaEllipse implements IMarkupEllipse {
     private _ref;
-    constructor(params: {
-        position?: {
-            x: number;
-            y: number;
-        };
-        radius?: {
-            x: number;
-            y: number;
-        };
-        lineWidth?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupEllipseParams, ref?: any);
     getPosition(): {
         x: number;
         y: number;

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

@@ -1,4 +1,4 @@
-import { IMarkupImage } from "../IMarkupImage";
+import { IMarkupImage, IMarkupImageParams } from "../IMarkupImage";
 export declare class KonvaImage implements IMarkupImage {
     private _ref;
     private _canvasImage;
@@ -6,18 +6,7 @@ export declare class KonvaImage implements IMarkupImage {
     private readonly EPSILON;
     private readonly BASE64_HEADER_START;
     private readonly BASE64_NOT_FOUND;
-    constructor(params: {
-        position?: {
-            x: number;
-            y: number;
-        };
-        src?: string;
-        width?: number;
-        height?: number;
-        maxWidth?: number;
-        maxHeight?: number;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupImageParams, ref?: any);
     getSrc(): string;
     setSrc(src: any): void;
     getWidth(): number;

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

@@ -1,17 +1,7 @@
-import { IMarkupRectangle } from "../IMarkupRectangle";
+import { IMarkupRectangle, IMarkupRectangleParams } from "../IMarkupRectangle";
 export declare class KonvaRectangle implements IMarkupRectangle {
     private _ref;
-    constructor(params: {
-        position?: {
-            x: number;
-            y: number;
-        };
-        width?: number;
-        height?: number;
-        lineWidth?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupRectangleParams, ref?: any);
     getPosition(): {
         x: number;
         y: number;

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

@@ -1,18 +1,8 @@
-import { IMarkupText } from "../IMarkupText";
+import { IMarkupText, IMarkupTextParams } from "../IMarkupText";
 export declare class KonvaText implements IMarkupText {
     private _ref;
     private readonly TEXT_FONT_FAMILY;
-    constructor(params: {
-        position?: {
-            x: number;
-            y: number;
-        };
-        text?: string;
-        rotation?: number;
-        fontSize?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
+    constructor(params: IMarkupTextParams, ref?: any);
     ref(): import("konva/lib/shapes/Text").Text;
     id(): string;
     enableMouseEditing(value: boolean): void;

package/package.json

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

package/src/index.ts

@@ -22,14 +22,14 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 export { IMarkup, MarkupMode } from "./markup/IMarkup";
-export { IMarkupArrow } from "./markup/IMarkupArrow";
-export { IMarkupCloud } from "./markup/IMarkupCloud";
+export { IMarkupArrow, IMarkupArrowParams } from "./markup/IMarkupArrow";
+export { IMarkupCloud, IMarkupCloudParams } from "./markup/IMarkupCloud";
 export { IMarkupColorable } from "./markup/IMarkupColorable";
-export { IMarkupEllipse } from "./markup/IMarkupEllipse";
-export { IMarkupImage } from "./markup/IMarkupImage";
+export { IMarkupEllipse, IMarkupEllipseParams } from "./markup/IMarkupEllipse";
+export { IMarkupImage, IMarkupImageParams } from "./markup/IMarkupImage";
 export { IMarkupLine, IMarkupLineParams, MarkupLineType } from "./markup/IMarkupLine";
 export { IMarkupObject } from "./markup/IMarkupObject";
-export { IMarkupRectangle } from "./markup/IMarkupRectangle";
-export { IMarkupText } from "./markup/IMarkupText";
+export { IMarkupRectangle, IMarkupRectangleParams } from "./markup/IMarkupRectangle";
+export { IMarkupText, IMarkupTextParams } from "./markup/IMarkupText";
 export { IWorldTransform } from "./markup/IWorldTransform";
 export { KonvaMarkup as Markup } from "./markup/Konva/KonvaMarkup";

package/src/markup/IMarkup.ts

@@ -80,7 +80,7 @@ export interface IMarkup {
   ): void;
 
   /**
-   * Releases all resources allocated by this markup instance.
+   * Releases resources allocated in the {@link initialize | initialize()}.
    */
   dispose(): void;
 

package/src/markup/IMarkupArrow.ts

@@ -38,7 +38,7 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
    *
    * @param {{ x: number; y: number }} points - Array of points.
    */
-  setPoints(points: { x: number; y: number }[]);
+  setPoints(points: { x: number; y: number }[]): void;
 
   /**
    * Returns the coordinales of the start point of arrow.
@@ -48,7 +48,7 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
   /**
    * Sets the coordinales of the start point of the arrow.
    */
-  setStartPoint(x: number, y: number);
+  setStartPoint(x: number, y: number): void;
 
   /**
    * Returns the coordinales of the end point of arrow.
@@ -58,5 +58,33 @@ export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
   /**
    * Sets the coordinales of the end point of the arrow.
    */
-  setEndPoint(x: number, y: number);
+  setEndPoint(x: number, y: number): void;
+}
+
+/**
+ * Defines the parameters for creating a {@link IMarkupArrow | markup arrow}.
+ */
+export interface IMarkupArrowParams {
+  /**
+   * Coordinales of the start point of arrow.
+   */
+  start?: { x: number; y: number };
+
+  /**
+   * Coordinales of the end point of arrow.
+   */
+  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.
+   *
+   * @default "#ff0000"
+   */
+  color?: string;
+
+  /**
+   * Internal markup object identifier.
+   */
+  id?: string;
 }