@inweb/viewer-visualize
    Preparing search index...

    Class Viewer

    3D viewer powered by VisualizeJS.

    Hierarchy

    Implements

    Index

    Constructors

    • Parameters

      • Optionalclient: Client

        The Client instance that is used to load model reference files from the Open Cloud Server. Do not specify Client if you need a standalone viewer instance to view VSFX files from the web or from local computer.

      • params: {
            crossOrigin?: string;
            enableAutoUpdate?: boolean;
            markupType?: MarkupType;
            visualizeJsUrl?: string;
        } = {}

        An object containing viewer configuration parameters.

        • OptionalcrossOrigin?: string

          The crossorigin content attribute on Visalize.js script element. One of the following values: "", anonymous, or use-credentials.

        • OptionalenableAutoUpdate?: boolean

          Enable auto-update of the viewer after any changes. If the auto-update is disabled, you need to register an update event handler and update the VisualizeJS viewer and active dragger manually. Default is true.

        • OptionalmarkupType?: MarkupType

          The type of the markup core: Visualize or Konva. Default is Konva.

        • OptionalvisualizeJsUrl?: string

          VisualizeJS library URL. Set this URL to use your own library instance, or specify undefined or blank to use the default URL defined by Viewer.visualize library you are using.

      Returns Viewer

    Properties

    canvas: HTMLCanvasElement

    HTMLCanvasElement that the viewer operates on. Defined only when the viewer is initialized.

    canvasEvents: string[]

    List of canvas events, such as mouse events or pointer events or touch events that the viewer should listen to and redirect to the draggers and components.

    By default, the following events are redirected:

    • click
    • contextmenu
    • dblclick
    • mousedown
    • mouseleave
    • mousemove
    • mouseup
    • pointercancel
    • pointerdown
    • pointerleave
    • pointermove
    • pointerup
    • touchcancel
    • touchend
    • touchmove
    • touchstart
    • wheel
    client: Client

    The Client instance that is used to load model reference files from the Open Cloud Server.

    info: IInfo

    Statistical information about the GPU memory and the rendering process.

    loaders: ILoader[]

    List of active loaders used to load models into the viewer.

    models: IModelImpl[]

    List of models loaded into the viewer.

    options: IOptions

    Viewer options.

    Accessors

    • get components(): string[]

      List of names of available components.

      Returns string[]

    • get draggers(): string[]

      List of names of available draggers.

      The following draggers are available by default:

      • Pan
      • Orbit
      • Zoom
      • MeasureLine
      • CuttingPlaneXAxis
      • CuttingPlaneYAxis
      • CuttingPlaneZAxis
      • Walk

      For a quick reference on how to implement your own dragger, see IDragger.

      Returns string[]

    • get markup(): IMarkup

      2D markup core instance used to create markups.

      Returns IMarkup

    • get visualizeJs(): any

      Returns VisualizeJS module instance.

      Returns any

    • get visualizeJsUrl(): string

      VisualizeJS library URL. Use configure() to change library URL.

      Returns string

    Methods

    • Registers a new listener for the event type.

      Type Parameters

      • T extends (keyof ViewerEventMap) | (keyof CanvasEventMap) | "optionschange"

      Parameters

      Returns this

    • Adds an empty Visualize markup entity to the VisualizeJS overlay.

      Parameters

      • entityName: string

      Returns any

    • Cancels asynchronous file loading started with open().

      Fires:

      Returns this

    • Unloads an open file, clears the canvas and markups, and deactivates the active dragger.

      Fires:

      Returns this

    • Changes the viewer parameters.

      Parameters

      • params: { crossOrigin?: string; visualizeJsUrl?: string }

        An object containing new parameters.

        • OptionalcrossOrigin?: string

          The crossorigin content attribute on Visalize.js script element. One of the following values: "", anonymous, or use-credentials.

        • OptionalvisualizeJsUrl?: string

          VisualizeJS library URL. Set this URL to use your own library instance or specify undefined or blank to use the default URL defined by Viewer.visualize library you are using.

      Returns this

    • Deselects the specified objects by handles.

      Fires:

      Parameters

      • handles: string | string[]

        The object handle or list of handles. To avoid collisions across models in multi-model scenes, use composite handles in the form "model:handle". All handles in the list must be in the same format.

      Returns void

    • Unloads an open file, clears the canvas and markups, and releases resources allocated by this viewer instance. Call this method before releasing the Viewer instance.

      Returns this

    • Sets the viewer state to the specified viewpoint.

      To get a list of available viewpoints from the Open Cloud Server for a specific file, use the File.getViewpoints().

      Fires:

      Parameters

      Returns void

    • Fires the event. Alias to emitEvent().

      Parameters

      • type: string | object

        The type of event that gets fired.

      • ...args: any[]

        The event properties.

      Returns boolean

    • Fires the event. Calls each of the listeners registered for the event type event.type, in the order they were registered.

      Type Parameters

      • T extends (keyof ViewerEventMap) | (keyof CanvasEventMap) | "optionschange"

      Parameters

      Returns boolean

    • 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 available by default:

      • applyModelTransform
      • autoTransformAllModelsToCentralPoint
      • clearMarkup
      • clearSelected
      • clearSlices
      • createPreview
      • explode
      • getDefaultViewPositions
      • getModels
      • getSelected
      • hideSelected
      • isolateSelected
      • regenerateAll
      • resetView
      • selectModel
      • setActiveDragger
      • setDefaultViewPosition
      • setMarkupColor
      • setSelected
      • showAll
      • zoomToExtents
      • zoomToObjects
      • zoomToSelected

      To register custom command use the commands.registerCommand.

      Parameters

      • id: string

        Command ID or dragger name.

      • ...args: any[]

        Parameters passed to the command handler function.

      Returns any

      Returns the result of the command handler function or new active dragger instance. Returns undefined if neither the command nor the dragger exists.

    • Breaks the model into its component objects. To collect it back, use index 0.

      Fires:

      Parameters

      • index: number = 0

        Explode index. Range is 0 to 100.

      Returns void

    • Returns the component reference, or null if there is no component with the specified name.

      Parameters

      • name: string

        Component name. Can be one of the components list.

      Returns IComponent

    • Returns a list of handles for the hidden objects.

      Special cases:

      • Returns an empty array if there are isolated objects in the scene.
      • Returns an array containing the single synthetic handle "$all" if all objects in the scene are hidden.

      Parameters

      • Optionalmultimodel: boolean

        Specifies if the returned handles should be formatted for a multi-model scene:

        • false (default): Returns raw handles as stored in the file. Useful for single-model scenes.
        • true: Returns composite handles in the form model:handle. Useful for multi-model scenes.

      Returns string[]

    • Returns a list of handles for the isolated objects.

      Parameters

      • Optionalmultimodel: boolean

        Specifies if the returned handles should be formatted for a multi-model scene:

        • false (default): Returns raw handles as stored in the file. Useful for single-model scenes.
        • true: Returns composite handles in the form model:handle. Useful for multi-model scenes.

      Returns string[]

    • Returns the scaling factors for each axis in world space.

      Returns { x: number; y: number; z: number }

    • Returns a list of handles for the selected objects.

      Parameters

      • Optionalmultimodel: boolean

        Specifies if the returned handles should be formatted for a multi-model scene:

        • false (default): Returns raw handles as stored in the file. Useful for single-model scenes.
        • true: Returns composite handles in the form model:handle. Useful for multi-model scenes.

      Returns string[]

    • Creates a snapshot image of the current viewer state.

      If the viewer has an active markup, combines the viewer canvas with the markup overlay. Otherwise, captures only the viewer canvas.

      Parameters

      • Optionaltype: string

        The MIME type of the image format. Can be one of:

        • image/png - PNG format with lossless compression (recommended for quality)
        • image/jpeg - JPEG format with lossy compression (smaller file size)
        • image/webp - WebP format (modern browsers only)

        If not specified, uses snapshotMimeType option.

      • Optionalquality: number

        A number between 0 and 1 indicating the image quality for lossy formats. If not specified, uses snapshotQuality option.

      Returns string

      A Data URL string containing the snapshot image.

    • Hides the specified objects. The hidden objects become unselected.

      Fires:

      Parameters

      • handle: string | string[]

      Returns void

    • Loads the VisualizeJS module and initializes it with the specified canvas. Call dispose() to release allocated resources.

      Fires:

      Parameters

      • canvas: HTMLCanvasElement

        HTMLCanvasElement for VisualizeJS. The canvas element must have an id attribute, otherwise an exception will be thrown.

      • OptionalonProgress: (event: ProgressEvent) => void

        A callback function that handles events measuring progress of loading of the VisualizeJS library.

      Returns Promise<Viewer>

    • Returns true if the currently opened model is a 3D model.

      Returns boolean

    • Returns true if VisualizeJS module has been loaded and initialized.

      Returns boolean

    • Isolates the specified objects. If selected objects are hidden during isolation, they become unselected.

      If no objects specified then all objects became hidden.

      Fires:

      Parameters

      • handle: string | string[]

      Returns void

    • Removes the listener from an event type. Alias to removeEventListener().

      Parameters

      • type: string

        The type of the event that gets removed.

      • listener: (event: any) => void

        The listener function that gets removed.

      Returns this

    • Registers a new listener for the event type. Alias to addEventListener()

      Parameters

      • type: string

        The type of event to listen to.

      • listener: (event: any) => void

        The function that gets called when the event is fired.

      Returns this

    • Loads a file into the viewer.

      The viewer must be initialized before opening the file. Otherwise, open() does nothing.

      This method requires a Client instance to be specified to load file from the Open Cloud Server. The file geometry data on the Open Cloud Server must be converted into a vsfx format, otherwise an exception will be thrown.

      For files from Open Cloud Server, the default model will be loaded. If there is no default model, first availiable model will be loaded. If no models are found in the file, an exception will be thrown.

      For URLs, the file extension is used to determine the file format. For a ArrayBuffer and Data URL, a file format must be specified using params.format parameter. If no appropriate loader is found for the specified format, an exception will be thrown.

      If there was an active dragger before opening the file, it will be deactivated. After opening the file, you must manually activate the required dragger.

      To open a large files, enable partial streaming before opening. Partial streaming is only supported when opening files from an Open Cloud Server, but not local files and URLs. Example:

      viewer.options.enableStreamingMode = true;
      viewer.options.enablePartialMode = true;
      await viewer.open(file);

      Fires:

      Parameters

      • file: FileSource

        File to load. Can be:

      • params: {
            format?: string;
            mode?: string;
            modelId?: string;
            requestHeader?: HeadersInit;
            withCredentials?: boolean;
        } = {}

        Loading parameters.

        • Optionalformat?: string

          File format. Can be one of vsf or vsfx. Required when loading a file as ArrayBuffer or Data URL.

        • Optionalmode?: string

          Reserved for future use.

        • OptionalmodelId?: string

          Reserved for future use.

        • OptionalrequestHeader?: HeadersInit

          The request header used in HTTP request.

        • OptionalwithCredentials?: boolean

          Whether the HTTP request uses credentials such as cookies, authorization headers or TLS client certificates. See XMLHttpRequest.withCredentials for more details.

      Returns Promise<Viewer>

    • If type is specified, removes all registered listeners for type, otherwise removes all registered listeners.

      Type Parameters

      • T extends (keyof ViewerEventMap) | (keyof CanvasEventMap) | "optionschange"

      Parameters

      • Optionaltype: T

        The type of the listener that gets removed.

      Returns this

    • Removes the listener for the event type.

      Type Parameters

      • T extends (keyof ViewerEventMap) | (keyof CanvasEventMap) | "optionschange"

      Parameters

      Returns this

    • Transforms position from screen space into world space.

      Parameters

      • position: { x: number; y: number }

        Screen position in pixels.

      Returns { x: number; y: number; z: number }

    • Selects the specified objects by handles. The selected objects become visible.

      Fires:

      Parameters

      • handles: string | string[]

        The object handle or list of handles. To avoid collisions across models in multi-model scenes, use composite handles in the form "model:handle". All handles in the list must be in the same format.

      Returns void

    • Changes the active dragger. The viewer must be initialized before activating the dragger, otherwise an exception will be thrown.

      Fires:

      Parameters

      • name: string = ""

        Dragger name. Can be one of the draggers list or an empty string to deactivate the current dragger.

      Returns IDragger

      Returns the new active dragger reference or null if there is no dragger with the given name.

    • Selects the objects by handles. The selected objects become visible.

      Fires:

      Parameters

      • Optionalhandles: string[]

        The object handle or list of handles. To avoid collisions across models in multi-model scenes, use composite handles in the form "model:handle". All handles in the list must be in the same format.

      Returns void

    • Deprecated since 27.11. Use setSelected instead.

      Parameters

      • Optionalhandles: string[]

      Returns void

    • Resizes the output canvas to (width, height) with device pixel ratio taken into account.

      Fires:

      Parameters

      • width: number

        The width of the canvas.

      • height: number

        The height of the canvas.

      • updateStyle: boolean = true

        Setting updateStyle to false prevents any style changes to the output canvas.

      Returns void

    • Makes the specified objects visible.

      Fires:

      Parameters

      • handle: string | string[]

      Returns void

    • Creates an overlay view. Overlay view is used to draw cutting planes and markups.

      Returns void

    • Toggles the selection of the specified objects by handles:

      • If an object is not selected, it will be selected and made visible.
      • If it is already selected, it will be deselected.

      Fires:

      Parameters

      • handles: string | string[]

        The object handle or list of handles. To avoid collisions across models in multi-model scenes, use composite handles in the form "model:handle". All handles in the list must be in the same format.

      Returns void

    • Updates the viewer.

      Do nothing if the auto-update mode is disabled in the constructor. In this case, register an update event handler and update the Visualize viewer and active dragger manually.

      Fires:

      Parameters

      • force: number | boolean = false

        If true updates the viewer immidietly. If a number is specified and more than the given amount of milliseconds has elapsed since the last rendering, the update is performed immediately as well. Otherwise updates on next animation frame. Default is false.

      Returns void

    • Updates the viewer asynchronously without locking the user interface. Used to update the viewer after changes that require a long rendering time.

      Do nothing if the auto-update mode is disabled in the constructor. In this case, register an update event handler and update the VisualizeJS viewer and active dragger manually.

      Fires:

      Parameters

      • maxScheduleUpdateTimeInMs: number = 50

        Maximum time for one update, default 30 ms.

      • maxScheduleUpdateCount: number = 50

        Maximum count of scheduled updates.

      Returns Promise<void>

    • Returns VisualizeJS module instance.

      Returns any

    • Returns VisualizeJS Viewer instance.

      Returns any

    • Transforms position from world space into screen space.

      Parameters

      • position: { x: number; y: number; z: number }

        Position in world space coordinates.

      Returns { x: number; y: number }

    • Fits the camera to the extents (bounding box) of the entire scene.

      Fires:

      Returns void

    • Fits the camera to the specified objects by handles.

      Fires:

      Parameters

      • handles: string | string[]

        The object handle or list of handles. To avoid collisions across models in multi-model scenes, use composite handles in the form "model:handle". All handles in the list must be in the same format.

      Returns void

    • Fits the camera to the selected objects.

      Fires:

      Returns void