@inweb/viewer-visualize 25.3.21 → 25.3.22

package/lib/Viewer/Draggers/Common/OdBaseDragger.d.ts

@@ -1,20 +1,6 @@
 import { Viewer } from "../../Viewer";
 import { Point2d } from "./Geometry";
 import { OdaGeAction } from "./OdaGeAction";
-/**
- * A [Viewer]{@link Viewer} event that fires when the viewer needs to be updated.
- *
- * @property {string} type - `update`
- * @event update
- */
-/**
- * A [Viewer]{@link Viewer} event that fires when the user selects an entity with the mouse.
- *
- * @property {string} type - `select`
- * @property {OdTvSelectionSet} data - The set of selected entities. For more information, see
- *   [OdTvSelectionSet](https://cloud.opendesign.com/docs/index.html#/vis/OdTvSelectionSet?id=odtvselectionset).
- * @event select
- */
 export declare class OdBaseDragger extends OdaGeAction {
     protected subject: Viewer;
     protected needInputText: boolean;

package/lib/Viewer/Viewer.d.ts

@@ -17,7 +17,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
     private _renderTime;
     protected _options: Options;
     protected _visualizeJsUrl: string;
-    protected _abortControllerForReferences: AbortController | undefined;
+    protected _visualizeJs: any;
     private canvaseventlistener;
     draggerFactory: Map<string, typeof OdBaseDragger>;
     canvasEvents: string[];
@@ -25,9 +25,9 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
     private _resizeObserver;
     canvas: HTMLCanvasElement | undefined;
     markup: IMarkup;
-    visualizeJs: any;
     _abortController: AbortController | undefined;
     _abortControllerForRequestMap: Map<string, AbortController> | undefined;
+    _abortControllerForReferences: AbortController | undefined;
     client: Client | undefined;
     /**
      * @param client - The `Client` instance that provides access to a server. Do not specify
@@ -122,6 +122,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      */
     private scheduleUpdateAsync;
     updateAsync(maxScheduleUpdateTimeInMs?: number, maxScheduleUpdateCount?: number): Promise<void>;
+    /**
+     * Returns `VisualizeJS`
+     * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
+     */
+    get visualizeJs(): any;
     /**
      * Returns `VisualizeJS`
      * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
@@ -171,7 +176,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      *
      * Fires:
      *
-     * - {@link ChangeActiveDragger | changeactivedragger}
+     * - {@link ChangeActiveDraggerEvent | changeactivedragger}
      *
      * @param name - Dragger name. Can be one of the {@link Viewer#draggers | draggers} list.
      * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
@@ -311,22 +316,17 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      * @param b - `Blue` part of color.
      */
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    /**
-     * Add an empty markup entity to the overlay.
-     */
     addMarkupEntity(entityName: string): any;
     /**
      * Draw a viewpoint. To get a list of available model viewpoints, use the
-     * {@link Model#getViewpoints | Model.getViewpoints()} or
-     * {@link File#getViewpoints | File.getViewpoints()}.
+     * {@link Model.getViewpoints()} or {@link File.getViewpoints()}.
      *
-     * @param viewpoint - Viewpoint.
+     * @param viewpoint - Viewpoint data.
      */
     drawViewpoint(viewpoint: IViewpoint): void;
     /**
      * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
-     * {@link Model#saveViewpoint | Model.saveViewpoint()} or
-     * {@link File#saveViewpoint | File.saveViewpoint()}.
+     * {@link Model.saveViewpoint()} or {@link File.saveViewpoint()}.
      */
     createViewpoint(): IViewpoint;
     private getPoint3dFromArray;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "25.3.21",
+  "version": "25.3.22",
   "description": "3D CAD and BIM data Viewer powered by Visualize",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -25,7 +25,8 @@
   ],
   "scripts": {
     "build": "rollup -c rollup.config.js",
-    "test": "karma start karma.conf.js"
+    "test": "karma start karma.conf.js",
+    "ts-docs": "typedoc"
   },
   "dependencies": {
     "@inweb/client": "^25.3.19",

package/src/Viewer/Draggers/Common/OdBaseDragger.ts

@@ -31,22 +31,6 @@ const CLICK_DELTA = 5;
 
 const INTERACTIVITY_FPS = 24;
 
-/**
- * A [Viewer]{@link Viewer} event that fires when the viewer needs to be updated.
- *
- * @property {string} type - `update`
- * @event update
- */
-
-/**
- * A [Viewer]{@link Viewer} event that fires when the user selects an entity with the mouse.
- *
- * @property {string} type - `select`
- * @property {OdTvSelectionSet} data - The set of selected entities. For more information, see
- *   [OdTvSelectionSet](https://cloud.opendesign.com/docs/index.html#/vis/OdTvSelectionSet?id=odtvselectionset).
- * @event select
- */
-
 export class OdBaseDragger extends OdaGeAction {
   protected subject: Viewer;
   protected needInputText: boolean;

package/src/Viewer/Viewer.ts

@@ -75,7 +75,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
 
   protected _options: Options;
   protected _visualizeJsUrl = "";
-  protected _abortControllerForReferences: AbortController | undefined;
+  protected _visualizeJs: any;
 
   private canvaseventlistener: (event: Event) => void;
 
@@ -86,9 +86,9 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
   public canvas: HTMLCanvasElement | undefined;
   public markup: IMarkup;
 
-  public visualizeJs: any;
   public _abortController: AbortController | undefined;
   public _abortControllerForRequestMap: Map<string, AbortController> | undefined;
+  public _abortControllerForReferences: AbortController | undefined;
   public client: Client | undefined;
 
   /**
@@ -219,7 +219,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
       onProgress?.(event);
     });
 
-    this.visualizeJs = visualizeJs;
+    this._visualizeJs = visualizeJs;
     this.visualizeJs.canvas = canvas;
     this.visualizeJs.Viewer.create();
 
@@ -260,22 +260,26 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this.frameId = 0;
 
     this.setActiveDragger("");
+    this.removeAllListeners();
 
-    this._zoomWheelDragger?.dispose();
-    this._gestureManager?.dispose();
+    if (this._gestureManager) this._gestureManager.dispose();
+    this._gestureManager = undefined;
 
-    this.removeAllListeners();
+    if (this._zoomWheelDragger) this._zoomWheelDragger.dispose();
+    this._zoomWheelDragger = undefined;
 
-    this._resizeObserver?.disconnect();
+    if (this._resizeObserver) this._resizeObserver.disconnect();
     this._resizeObserver = undefined;
 
     this.markup.dispose();
 
-    this.canvasEvents.forEach((x) => this.canvas?.removeEventListener(x, this.canvaseventlistener));
-    this.canvas = undefined;
+    if (this.canvas) {
+      this.canvasEvents.forEach((x) => this.canvas.removeEventListener(x, this.canvaseventlistener));
+      this.canvas = undefined;
+    }
 
-    this.visualizeJs?.getViewer().clear();
-    this.visualizeJs = undefined;
+    if (this._visualizeJs) this._visualizeJs.getViewer().clear();
+    this._visualizeJs = undefined;
 
     return this;
   }
@@ -386,6 +390,14 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     }
   }
 
+  /**
+   * Returns `VisualizeJS`
+   * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
+   */
+  get visualizeJs(): any {
+    return this._visualizeJs;
+  }
+
   /**
    * Returns `VisualizeJS`
    * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
@@ -627,7 +639,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
    *
    * Fires:
    *
-   * - {@link ChangeActiveDragger | changeactivedragger}
+   * - {@link ChangeActiveDraggerEvent | changeactivedragger}
    *
    * @param name - Dragger name. Can be one of the {@link Viewer#draggers | draggers} list.
    * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
@@ -1044,7 +1056,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this.markup.colorizeAllMarkup(r, g, b);
   }
 
-  /**
+  /*
    * Add an empty markup entity to the overlay.
    */
   addMarkupEntity(entityName: string) {
@@ -1069,10 +1081,9 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
 
   /**
    * Draw a viewpoint. To get a list of available model viewpoints, use the
-   * {@link Model#getViewpoints | Model.getViewpoints()} or
-   * {@link File#getViewpoints | File.getViewpoints()}.
+   * {@link Model.getViewpoints()} or {@link File.getViewpoints()}.
    *
-   * @param viewpoint - Viewpoint.
+   * @param viewpoint - Viewpoint data.
    */
   drawViewpoint(viewpoint: IViewpoint): void {
     this.setOrthogonalCameraSettings(viewpoint.orthogonal_camera);
@@ -1082,8 +1093,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
 
   /**
    * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
-   * {@link Model#saveViewpoint | Model.saveViewpoint()} or
-   * {@link File#saveViewpoint | File.saveViewpoint()}.
+   * {@link Model.saveViewpoint()} or {@link File.saveViewpoint()}.
    */
   createViewpoint(): IViewpoint {
     const vp = this.markup.getViewpoint();