Class Viewer

constructor

• new Viewer(config): Viewer

• Parameters

  • config: ViewerConfig

  Returns Viewer

Readonly config

Readonly container

Readonly dataHelper

Readonly loader

Readonly navbar

Readonly notification

Readonly overlay

Readonly panel

Readonly parent

Readonly renderer

Readonly state

Readonly textureLoader

animate

• animate(options): Animation<any>

• Rotates and zooms the view with a smooth animation

  Parameters

  • options: AnimateOptions

  Returns Animation<any>

autoSize

• autoSize(): void

• Resizes the scene if the viewer is resized

  Returns void

createTooltip

• createTooltip(config): Tooltip

• Creates a new tooltip

  Parameters

  • config: TooltipConfig

  Returns Tooltip

  Description

  Use Tooltip.move to update the tooltip without re-create

  Throws

  PSVError if the configuration is invalid

destroy

• destroy(): void

• Destroys the viewer

  Returns void

enterFullscreen

• enterFullscreen(): void

• Enters the fullscreen mode

  Returns void

exitFullscreen

• exitFullscreen(): void

• Exits the fullscreen mode

  Returns void

getPlugin

• getPlugin<T>(pluginId): T

• Returns the instance of a plugin if it exists

  Type Parameters

  • T extends AbstractPlugin<any>

  Parameters

  • pluginId: string | PluginConstructor

  Returns T

  Example

  By plugin identifier

  viewer.getPlugin('markers')
  Copy

  Example

  By plugin class with TypeScript support

  viewer.getPlugin<MarkersPlugin>(MarkersPlugin)
  Copy

getPosition

• getPosition(): Position

• Returns the current position of the camera

  Returns Position

getSize

• getSize(): Size

• Returns the current viewer size

  Returns Size

getZoomLevel

• getZoomLevel(): number

• Returns the current zoom level

  Returns number

hideError

• hideError(): void

• Hides the error message

  Returns void

isFullscreenEnabled

• isFullscreenEnabled(): boolean

• Checks if the viewer is in fullscreen

  Returns boolean

needsContinuousUpdate

• needsContinuousUpdate(enabled): void

• Request the scene to be continuously renderer (when using videos)

  Parameters

  • enabled: boolean

  Returns void

needsUpdate

• needsUpdate(): void

• Request a new render of the scene

  Returns void

observeObjects

• observeObjects(userDataKey): void

• Subscribes to events on objects in the three.js scene

  Parameters

  • userDataKey: string

    only objects with the following userData will be observed

  Returns void

resize

• resize(size): void

• Resizes the viewer

  Parameters

  • size: CssSize

  Returns void

rotate

• rotate(position): void

• Rotates the view to specific position

  Parameters

  • position: ExtendedPosition

  Returns void

setCursor

• setCursor(cursor): void

• Changes the global mouse cursor

  Parameters

  • cursor: string

  Returns void

setOption

• setOption<T>(option, value): void

• Update options

  Type Parameters

  • T extends "description" | "caption" | "mousemove" | "defaultYaw" | "defaultPitch" | "fisheye" | "requestHeaders" | "navbar" | "keyboard" | "downloadUrl" | "downloadName" | "loadingImg" | "loadingTxt" | "size" | "minFov" | "maxFov" | "defaultZoomLvl" | "sphereCorrection" | "moveSpeed" | "zoomSpeed" | "moveInertia" | "mousewheel" | "mousewheelCtrlKey" | "touchmoveTwoFingers" | "rendererParameters" | "withCredentials" | "lang" | "keyboardActions"

  Parameters

  • option: T

  • value: UpdatableViewerConfig[T]

  Returns void

  Throws

  PSVError if the configuration is invalid

setOptions

• setOptions(options): void

• Update options

  Parameters

  • options: Partial<UpdatableViewerConfig>

  Returns void

  Throws

  PSVError if the configuration is invalid

setPanorama

• setPanorama(path, options?): Promise<boolean>

• Loads a new panorama file

  Parameters

  • path: any

  • options: PanoramaOptions = {}

  Returns Promise<boolean>

  promise resolved with false if the loading was aborted by another call

  Description

  Loads a new panorama file, optionally changing the camera position/zoom and activating the transition animation.
  If the "options" parameter is not defined, the camera will not move and the ongoing animation will continue.
  If another loading is already in progress it will be aborted.

showError

• showError(message): void

• Displays an error message over the viewer

  Parameters

  • message: string

  Returns void

startKeyboardControl

• startKeyboardControl(): void

• Enables the keyboard controls

  Returns void

stopAnimation

• stopAnimation(): PromiseLike<any>

• Stops the ongoing animation

  Returns PromiseLike<any>

  Description

  The return value is a Promise because the is no guaranty the animation can be stopped synchronously.

stopKeyboardControl

• stopKeyboardControl(): void

• Disables the keyboard controls

  Returns void

toggleFullscreen

• toggleFullscreen(): void

• Enters or exits the fullscreen mode

  Returns void

unobserveObjects

• unobserveObjects(userDataKey): void

• Unsubscribes to events on objects

  Parameters

  • userDataKey: string

  Returns void

zoom

• zoom(level): void

• Zooms to a specific level between maxFov and minFov

  Parameters

  • level: number

  Returns void

zoomIn

• zoomIn(step?): void

• Increases the zoom level

  Parameters

  • step: number = 1

  Returns void

zoomOut

• zoomOut(step?): void

• Decreases the zoom level

  Parameters

  • step: number = 1

  Returns void