@inweb/viewer-visualize 25.9.1 → 25.9.3

package/dist/viewer-visualize.js

@@ -17553,7 +17553,7 @@
             return this;
         }
         /**
-         * Loads the `VisualizeJS` module and initialize it with the specified canvas. Call
+         * Loads the `VisualizeJS` module and initializes it with the specified canvas. Call
          * {@link dispose | dispose()} to release allocated resources.
          *
          * Fires:
@@ -17608,8 +17608,8 @@
             return this;
         }
         /**
-         * Releases all resources allocated by this viewer instance. Call this method before release
-         * the `Viewer` instance.
+         * Unloads an open file, clears the canvas and markups, and releases resources allocated by
+         * this viewer instance. Call this method before release the `Viewer` instance.
          */
         dispose() {
             this.cancel();
@@ -17907,7 +17907,9 @@
             return this;
         }
         /**
-         * List of names of registered draggers. By default, the following draggers are registered:
+         * List of names of registered draggers.
+         *
+         * The following draggers are registered by default:
          *
          * - `Line`
          * - `Text`
@@ -17922,14 +17924,16 @@
          * - `CuttingPlaneZAxis`
          * - `Walk`
          *
-         * @readonly
+         * To register your own command use the {@link registerDragger | registerDragger()}.
          */
         get draggers() {
             return [...this.draggerFactory.keys()];
         }
         /**
-         * Registers a dragger for the viewer. Dragger is an object that received mouse/keyboard
-         * events and does something to the viewer.
+         * Registers a dragger for the viewer.
+         *
+         * Dragger is an object that received mouse/keyboard events and does something to the viewer.
+         * For a quick tutorial on how to create your own dragger, see {@link Dragger}.
          *
          * @param name - Dragger name.
          * @param dragger - Dragger class.
@@ -17938,7 +17942,7 @@
             this.draggerFactory.set(name, dragger);
         }
         /**
-         * Returns active dragger instance or `null` if there is no active dragger.
+         * Returns the active dragger instance, or `null` if there is no active dragger.
          */
         activeDragger() {
             return this._activeDragger;
@@ -17951,7 +17955,8 @@
          * - {@link ChangeActiveDraggerEvent | changeactivedragger}
          *
          * @param name - Dragger name. Can be one of the {@link draggers} list.
-         * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
+         * @returns Returns the new active dragger instance or `null` if there is no dragger with the
+         *   given name.
          */
         setActiveDragger(name) {
             var _a;
@@ -18041,7 +18046,7 @@
             this.update();
         }
         /**
-         * Returns `true` if current model is 3D model.
+         * Returns `true` if current opened model is 3D model.
          */
         is3D() {
             if (!this.visualizeJs)
@@ -18277,7 +18282,7 @@
             return this;
         }
         /**
-         * Cancels asynchronous model loading started by {@link open | open()}.
+         * Cancels asynchronous file loading started by {@link open | open()}.
          */
         cancel() {
             var _a, _b, _c;
@@ -18291,7 +18296,7 @@
             return this;
         }
         /**
-         * Unloads the model and clears the viewer and markups.
+         * Unloads an open file and clears the canvas and markups.
          */
         clear() {
             if (!this.visualizeJs)
@@ -18446,11 +18451,42 @@
             }
         }
         /**
-         * Executes the command denoted by the given command identifier.
+         * Executes the command denoted by the given command. If the command is not found, tries to
+         * set active dragger with the specified name.
+         *
+         * The following commands are registered by default:
+         *
+         * - `applyModelTransform`
+         * - `autoTransformAllModelsToCentralPoint`
+         * - `clearMarkup`
+         * - `clearSlices`
+         * - `createPreview`
+         * - `explode`
+         * - `getDefaultViewPositions`
+         * - `getModels`
+         * - `getSelected`
+         * - `hideSelected`
+         * - `isolateSelected`
+         * - `regenerateAll`
+         * - `resetView`
+         * - `selectModel`
+         * - `setActiveDragger`
+         * - `setDefaultViewPosition`
+         * - `setMarkupColor`
+         * - `setSelected`
+         * - `showAll`
+         * - `unselect`
+         * - `zoomToExtents`
+         * - `zoomToObjects`
+         * - `zoomToSelected`
+         *
+         * To register your own command use the {@link ICommands.registerCommand | registerCommand()}
+         * method of the {@link commands} manager.
          *
-         * @param id - Identifier of the command to execute.
-         * @param args - Parameters passed to the command function.
-         * @returns A returned value of the given command. Returns `undefined` when the command doesn't exists.
+         * @param id - Command ID or dragger name.
+         * @param args - Parameters passed to the command handler function.
+         * @returns Returns the result of the command handler function or new active dragger
+         *   instance. Returns `undefined` if neither the command nor the dragger exists.
          */
         executeCommand(id, ...args) {
             return commands("VisualizeJS").executeCommand(id, this, ...args);