ViewerBackgroundAPI

Interface ViewerBackgroundAPI

The ViewerBackgroundAPI provides a method to clear the background of a viewer. This can be useful when restoring a snapshot that had a background image set (e.g. from an XR environment) and you want to remove it to have a transparent background again.

Example

// Get the current viewer
const viewer = webvis.getViewer();

// Clear the background and make it fully transparent
viewer.clearBackground();
interface ViewerBackgroundAPI {
    clearBackground(): void;
}

Hierarchy (View Summary)

Index

Methods

clearBackground

Methods

  • Clears the viewer's background.

    Returns void



Was this page helpful? Please leave a thumbs up or down.