@inweb/viewer-visualize 25.4.4 → 25.4.6

package/lib/Viewer/Markup/Api/IMarkupArrow.d.ts

@@ -1,21 +1,52 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Arrow Markup object
+ */
 export interface IMarkupArrow extends IMarkupObject {
+    /**
+     * Get points of current Arrow
+     *
+     * @returns {{ x: number; y: number }} array of points
+     */
     getPoints(): {
         x: number;
         y: number;
     }[];
+    /**
+     * Set points of the Arrow
+     *
+     * @param {{ x: number; y: number }} points - array of points
+     */
     setPoints(points: {
         x: number;
         y: number;
     }[]): any;
+    /**
+     * Get Start Point of the Arrow
+     */
     getStartPoint(): {
         x: number;
         y: number;
     };
+    /**
+     * Set Start point of the Arrow
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setStartPoint(x: number, y: number): any;
+    /**
+     * Get End point of the Arrow
+     */
     getEndPoint(): {
         x: number;
         y: number;
     };
+    /**
+     * Set End point of the Arrow
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setEndPoint(x: number, y: number): any;
 }

package/lib/Viewer/Markup/Api/IMarkupCloud.d.ts

@@ -1,14 +1,50 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Cloud Markup object
+ */
 export interface IMarkupCloud extends IMarkupObject {
+    /**
+     * Get position of the Cloud
+     */
     getPosition(): {
         x: number;
         y: number;
     };
+    /**
+     * Set position of the Cloud
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setPosition(x: number, y: number): any;
+    /**
+     * Get width of the Cloud. Default value is 200
+     */
     getWidth(): number;
+    /**
+     * Set width of the Cloud
+     *
+     * @param w - value of width. Default value is 200
+     */
     setWidth(w: number): any;
+    /**
+     * Get height of the Cloud. Default value is 200
+     */
     getHeigth(): number;
+    /**
+     * Set height of the Cloud
+     *
+     * @param h - value of height. Default value is 200
+     */
     setHeight(h: number): any;
+    /**
+     * Get line width of the Cloud. Defailt value is 4
+     */
     getLineWidth(): number;
+    /**
+     * Set line width of the Cloud
+     *
+     * @param size - value of width. Defailt value is 4
+     */
     setLineWidth(size: number): any;
 }

package/lib/Viewer/Markup/Api/IMarkupColorable.d.ts

@@ -1,4 +1,15 @@
+/**
+ * Markup Colorable
+ */
 export interface IMarkupColorable {
+    /**
+     * Get color of the Markup instance
+     */
     getColor(): string;
+    /**
+     * Set color of the Markup instance
+     *
+     * @param hex - color in #hex format. Default: `#ff0000`
+     */
     setColor(hex: string): void;
 }

package/lib/Viewer/Markup/Api/IMarkupEllipse.d.ts

@@ -1,14 +1,50 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Ellipse Markup object
+ */
 export interface IMarkupEllipse extends IMarkupObject {
+    /**
+     * Get position of the Ellipse
+     */
     getPosition(): {
         x: number;
         y: number;
     };
+    /**
+     * Set position of the Ellipse
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setPosition(x: number, y: number): any;
+    /**
+     * Get X radius of the Ellipse
+     */
     getRadiusX(): number;
+    /**
+     * Set X radius of the Ellipse
+     *
+     * @param r - value of X radius of the Ellipse
+     */
     setRadiusX(r: number): any;
+    /**
+     * Get Y radius of the Ellipse
+     */
     getRadiusY(): number;
+    /**
+     * Set Y radius of the Ellipse
+     *
+     * @param r - value of Y radius of the Ellipse
+     */
     setRadiusY(r: number): any;
+    /**
+     * Get line width of the Ellipse. Defailt is 4
+     */
     getLineWidth(): number;
+    /**
+     * Set line width of the Ellipse. Default is 4
+     *
+     * @param size - value of width
+     */
     setLineWidth(size: number): any;
 }

package/lib/Viewer/Markup/Api/IMarkupImage.d.ts

@@ -1,14 +1,50 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Image Markup object
+ */
 export interface IMarkupImage extends IMarkupObject {
+    /**
+     * Get position of the Image
+     */
     getPosition(): {
         x: number;
         y: number;
     };
+    /**
+     * Set position of the Image
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setPosition(x: number, y: number): any;
+    /**
+     * Get source of the Image. Provides base64 string
+     */
     getSrc(): string;
+    /**
+     * Set source of the Image
+     *
+     * @param src - string in base64 format
+     */
     setSrc(src: string): any;
+    /**
+     * Get width of the Image
+     */
     getWidth(): number;
+    /**
+     * Set width of the Image
+     *
+     * @param w - value of width. Height will be automatically updated according to ratio of the Image
+     */
     setWidth(w: number): any;
+    /**
+     * Get height of the Image
+     */
     getHeight(): number;
+    /**
+     * Set height of the Image
+     *
+     * @param h - value of height. Width will be automatically updated according to ratio of the Image
+     */
     setHeight(h: number): any;
 }

package/lib/Viewer/Markup/Api/IMarkupLine.d.ts

@@ -1,10 +1,37 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Line Markup object
+ */
 export interface IMarkupLine extends IMarkupObject {
+    /**
+     * Get points of the Line
+     */
     getPoints(): number[];
+    /**
+     * Get Line width. Default value is 4
+     */
     getLineWidth(): number;
+    /**
+     * Set Line width. Default value is 4
+     *
+     * @param size - value of width
+     */
     setLineWidth(size: number): any;
+    /**
+     * Get Type of the Line. Available values: `solid`, `dot`, `dash`. Default is `solid`
+     */
     getLineType(): string;
+    /**
+     * Set Type of the Line. Available values: `solid`, `dot`, `dash`. Default is `solid`
+     *
+     * @param type
+     */
     setLineType(type: string): any;
+    /**
+     * Add points to the Line
+     *
+     * @param {{ x: number; y: number }} points array of points
+     */
     addPoints(points: [{
         x: number;
         y: number;

package/lib/Viewer/Markup/Api/IMarkupObject.d.ts

@@ -1,11 +1,47 @@
+/**
+ * Markup object
+ */
 export interface IMarkupObject {
+    /**
+     * Link to Library object (Konva, VisualizeJS)
+     */
     ref(): any;
+    /**
+     * Get an internal identificator of the object. Not unique
+     */
     id(): string;
+    /**
+     * Set Mouse editing feature
+     *
+     * @param value true / false
+     */
     enableMouseEditing(value: boolean): any;
+    /**
+     * Get type of the Markup object
+     */
     type(): string;
+    /**
+     * Get rotation of the Markup object
+     */
     getRotation(): number;
+    /**
+     * Set rotation of the Markup object
+     *
+     * @param degrees number of degress to rotate
+     */
     setRotation(degrees: number): void;
+    /**
+     * Get Z-Index of the Markup object
+     */
     getZIndex(): number;
+    /**
+     * Set Z-Index of the Markup object
+     *
+     * @param zIndex integer value of Z-Index
+     */
     setZIndex(zIndex: number): void;
-    delete(): any;
+    /**
+     * Delete current Markup object
+     */
+    delete(): void;
 }

package/lib/Viewer/Markup/Api/IMarkupRectangle.d.ts

@@ -1,14 +1,50 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Rectangle Markup object
+ */
 export interface IMarkupRectangle extends IMarkupObject {
+    /**
+     * Get position of the Rectangle
+     */
     getPosition(): {
         x: number;
         y: number;
     };
+    /**
+     * Set position of the Rectangle
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setPosition(x: number, y: number): any;
+    /**
+     * Get width of the Rectangle. Default value is 200
+     */
     getWidth(): number;
+    /**
+     * Set width of the Rectangle
+     *
+     * @param w - value of width. Default value is 200
+     */
     setWidth(w: number): any;
+    /**
+     * Get height of the Rectangle. Default value is 200
+     */
     getHeigth(): number;
+    /**
+     * Set height of the Rectangle
+     *
+     * @param h - value of height. Default value is 200
+     */
     setHeight(h: number): any;
+    /**
+     * Get line width of the Rectangle. Defailt value is 4
+     */
     getLineWidth(): number;
+    /**
+     * Set line width of the Rectangle
+     *
+     * @param size - value of width. Defailt value is 4
+     */
     setLineWidth(size: number): any;
 }

package/lib/Viewer/Markup/Api/IMarkupText.d.ts

@@ -1,12 +1,40 @@
 import { IMarkupObject } from "./IMarkupObject";
+/**
+ * Text Markup object
+ */
 export interface IMarkupText extends IMarkupObject {
+    /**
+     * Get Text value
+     */
     getText(): string;
+    /**
+     * Set Text value
+     *
+     * @param text - string value
+     */
     setText(text: string): void;
+    /**
+     * Get position of the Text
+     */
     getPosition(): {
         x: number;
         y: number;
     };
+    /**
+     * Set position of the Text
+     *
+     * @param x - value of X coordinate
+     * @param y - value of Y coordinate
+     */
     setPosition(x: number, y: number): any;
+    /**
+     * Get font size. Default value is 34
+     */
     getFontSize(): any;
+    /**
+     * Set font size. Default value is 34
+     *
+     * @param size
+     */
     setFontSize(size: number): any;
 }

package/lib/Viewer/Markup/IMarkup.d.ts

@@ -2,11 +2,18 @@ import { IViewpoint } from "@inweb/viewer-core";
 import { OdBaseDragger } from "../Draggers/Common/OdBaseDragger";
 import { Viewer } from "../Viewer";
 import { IMarkupObject } from "./Api/IMarkupObject";
+/**
+ * Version of the markup support. Old = "Visualize", New = "Konva"
+ */
 export declare enum MarkupType {
     Unknown = 0,
     Konva = "Konva",
     Visualize = "Visualize"
 }
+/**
+ * Defines type of markup object. For old Visualize markup ({@link MarkupType}) only "Line" and
+ * "Text" markup objects are supported.
+ */
 export declare enum MarkupMode {
     Line = "Line",
     Text = "Text",
@@ -16,25 +23,103 @@ export declare enum MarkupMode {
     Image = "Image",
     Cloud = "Cloud"
 }
+/**
+ * Specifies parameters and methods of the Markup object
+ */
 export interface IMarkup {
+    /**
+     * Width of the markup object line
+     */
     lineWidth: number;
+    /**
+     * Start method to init Markup support for the Viewer instance.
+     *
+     * @param {Viewer} viewer - current {@link Viewer} object
+     * @param canvas - {@link HTMLCanvasElement} of the Viewer
+     * @param canvasEvents - list of used events of the Viewer
+     */
     initialize(viewer: Viewer, canvas: HTMLCanvasElement, canvasEvents: string[]): void;
+    /**
+     * Releases all resources allocated by this `Markup` instance. Call this method before
+     * release the `Markup` instance.
+     */
     dispose(): void;
+    /**
+     * Provide Javascript Map with all {@link OdBaseDragger} draggers used by Markup. We need this
+     * map to register in {@link Viewer.registerDragger}
+     */
     getDraggers(): Map<string, typeof OdBaseDragger>;
+    /**
+     * Remove markup overlay.
+     */
     clearOverlay(): void;
+    /**
+     * Set markup color.
+     *
+     * @param r - `Red` part of color.
+     * @param g - `Green` part of color.
+     * @param b - `Blue` part of color.
+     */
     setMarkupColor(r: number, g: number, b: number): void;
+    /**
+     * Get markup color.
+     *
+     * @returns Color with `RGB` values.
+     */
     getMarkupColor(): {
         r: number;
         g: number;
         b: number;
     };
+    /**
+     * Colorize all markup entities with the specified color.
+     *
+     * @param r - `Red` part of color.
+     * @param g - `Green` part of color.
+     * @param b - `Blue` part of color.
+     */
     colorizeAllMarkup(r: number, g: number, b: number): void;
+    /**
+     * Colorize all selected markup entities with the specified color.
+     *
+     * @param r - `Red` part of color.
+     * @param g - `Green` part of color.
+     * @param b - `Blue` part of color.
+     */
     colorizeSelectedMarkups(r: number, g: number, b: number): void;
+    /**
+     * Draw a viewpoint. To get a list of available model viewpoints, use the
+     *
+     * @param viewpoint - Viewpoint data.
+     */
     setViewpoint(viewpoint: IViewpoint): void;
+    /**
+     * Create a {@link IViewpoint} viewpoint
+     */
     getViewpoint(): IViewpoint;
+    /**
+     * Create a Markup object
+     *
+     * @param type - string identificator of Markup type
+     * @param params - object with parameters of Markup
+     */
     createObject(type: string, params: any): IMarkupObject;
+    /**
+     * Get array of all existed Markup objects
+     */
     getObjects(): IMarkupObject[];
+    /**
+     * Get array of currently selected Markup objects
+     */
     getSelectedObjects(): IMarkupObject[];
+    /**
+     * Select list of Markup objects
+     *
+     * @param objects
+     */
     selectObjects(objects: IMarkupObject[]): void;
+    /**
+     * Clear list of currently selected Markup objects
+     */
     clearSelected(): void;
 }

package/lib/Viewer/Markup/Impl/Konva/MarkupColor.d.ts

@@ -7,12 +7,29 @@ export declare class MarkupColor {
      * Color in #000000 format
      */
     get HexColor(): string;
+    /**
+     * Color as object with r,g,b properties
+     */
     get RGB(): {
         r: number;
         g: number;
         b: number;
     };
+    /**
+     * Create an instance of Color
+     *
+     * @param r - Red color in [0,255] range
+     * @param g - Green color in [0,255] range
+     * @param b - Blue color in [0,255] range
+     */
     constructor(r: number, g: number, b: number);
+    /**
+     * Set Color for current instance
+     *
+     * @param r - Red color in [0,255] range
+     * @param g - Green color in [0,255] range
+     * @param b - Blue color in [0,255] range
+     */
     setColor(r: number, g: number, b: number): void;
     private rgbToHex;
 }

package/lib/Viewer/Markup/Impl/Visualize/VisualizeMarkup.d.ts

@@ -25,7 +25,6 @@ export declare class VisualizeMarkup implements IMarkup {
     colorizeSelectedMarkups(r?: number, g?: number, b?: number): void;
     setViewpoint(viewpoint: IViewpoint): void;
     getViewpoint(): IViewpoint;
-    getLayer(): any;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];

package/lib/Viewer/Markup/MarkupFactory.d.ts

@@ -1,5 +1,11 @@
 import { IMarkup, MarkupType } from "./IMarkup";
 export declare class MarkupFactory {
+    /**
+     * Initialize {@link IMarkup} instance
+     *
+     * @param markupType - Specifies version of the markup support. Two variants of markup
+     *   support are implemented: old "Visualize" and new "Konva". Default is "Konva". {@link MarkupType}
+     */
     static createMarkup(markupType: MarkupType): IMarkup;
     private static createKonva;
     private static createVisualize;

package/lib/Viewer/Viewer.d.ts

@@ -42,6 +42,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      * @param params.enableAutoUpdate - Enable auto-update of the viewer after any changes. If
      *   the auto-update is disabled, you need to update the `VisualizeJS` viewer and the active
      *   dragger manually using the `update` event. Default is `true`.
+     * @param params.markupType - Specifies version of the markup support. Two variants of markup
+     *   support are implemented: old "Visualize" and new "Konva". Default is "Konva". {@link MarkupType}
      */
     constructor(client?: Client, params?: {
         visualizeJsUrl?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "25.4.4",
+  "version": "25.4.6",
   "description": "3D CAD and BIM data Viewer powered by Visualize",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -29,9 +29,9 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~25.4.4",
-    "@inweb/eventemitter2": "~25.4.4",
-    "@inweb/viewer-core": "~25.4.4"
+    "@inweb/client": "~25.4.6",
+    "@inweb/eventemitter2": "~25.4.6",
+    "@inweb/viewer-core": "~25.4.6"
   },
   "devDependencies": {
     "canvas": "^2.11.2",

package/src/Viewer/Markup/Api/IMarkupArrow.ts

@@ -1,12 +1,69 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
+// All rights reserved.
+//
+// This software and its documentation and related materials are owned by
+// the Alliance. The software may only be incorporated into application
+// programs owned by members of the Alliance, subject to a signed
+// Membership Agreement and Supplemental Software License Agreement with the
+// Alliance. The structure and organization of this software are the valuable
+// trade secrets of the Alliance and its suppliers. The software is also
+// protected by copyright law and international treaty provisions. Application
+// programs incorporating this software must include the following statement
+// with their copyright notices:
+//
+//   This application incorporates Open Design Alliance software pursuant to a
+//   license agreement with Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
 import { IMarkupObject } from "./IMarkupObject";
 
+/**
+ * Arrow Markup object
+ */
 export interface IMarkupArrow extends IMarkupObject {
+  /**
+   * Get points of current Arrow
+   *
+   * @returns {{ x: number; y: number }} array of points
+   */
   getPoints(): { x: number; y: number }[];
+
+  /**
+   * Set points of the Arrow
+   *
+   * @param {{ x: number; y: number }} points - array of points
+   */
   setPoints(points: { x: number; y: number }[]);
 
+  /**
+   * Get Start Point of the Arrow
+   */
   getStartPoint(): { x: number; y: number };
+
+  /**
+   * Set Start point of the Arrow
+   *
+   * @param x - value of X coordinate
+   * @param y - value of Y coordinate
+   */
   setStartPoint(x: number, y: number);
 
+  /**
+   * Get End point of the Arrow
+   */
   getEndPoint(): { x: number; y: number };
+
+  /**
+   * Set End point of the Arrow
+   *
+   * @param x - value of X coordinate
+   * @param y - value of Y coordinate
+   */
   setEndPoint(x: number, y: number);
 }