Class Viewer

Photo Sphere Viewer controller

Hierarchy (View Summary)

TypedEventTarget<ViewerEvents>
- Viewer

Constructors

constructor

new Viewer(config: ViewerConfig): Viewer
Parameters
- config: ViewerConfig
Returns Viewer
Overrides TypedEventTarget.constructor
- Defined in packages/core/src/Viewer.ts:108

Properties

`Readonly`config

config: ParsedViewerConfig

`Readonly`container

container: HTMLElement

`Readonly`dataHelper

dataHelper: DataHelper

`Readonly`loader

loader: Loader

`Readonly`navbar

navbar: Navbar

`Readonly`notification

notification: Notification

`Readonly`overlay

overlay: Overlay

`Readonly`panel

panel: Panel

`Readonly`parent

parent: HTMLElement

`Readonly`renderer

renderer: Renderer

`Readonly`state

state: ViewerState

`Readonly`textureLoader

textureLoader: TextureLoader

`Static`useNewAnglesOrder

useNewAnglesOrder: boolean = true

Change the order in which the panoData and sphereCorrection angles are applied from 'ZXY' to 'YXZ'

Deprecated

Will be removed in version 5.12

Methods

addEventListener

addEventListener<
    T extends
        | "click"
        | "dblclick"
        | "fullscreen"
        | "before-animate"
        | "before-render"
        | "before-rotate"
        | "config-changed"
        | "hide-notification"
        | "hide-overlay"
        | "hide-panel"
        | "hide-tooltip"
        | "key-press"
        | "load-progress"
        | "panorama-load"
        | "panorama-loaded"
        | "panorama-error"
        | "transition-done"
        | "position-updated"
        | "roll-updated"
        | "ready"
        | "render"
        | "show-notification"
        | "show-overlay"
        | "show-panel"
        | "show-tooltip"
        | "size-updated"
        | "stop-all"
        | "zoom-updated"
        | "enter-object"
        | "leave-object"
        | "hover-object",
    E extends ViewerEvents & { type: T },
>(
    type: T,
    callback: EventListenerObject | (e: E) => void,
    options?: boolean | AddEventListenerOptions,
): void
Type Parameters
- T extends
      | "click"
      | "dblclick"
      | "fullscreen"
      | "before-animate"
      | "before-render"
      | "before-rotate"
      | "config-changed"
      | "hide-notification"
      | "hide-overlay"
      | "hide-panel"
      | "hide-tooltip"
      | "key-press"
      | "load-progress"
      | "panorama-load"
      | "panorama-loaded"
      | "panorama-error"
      | "transition-done"
      | "position-updated"
      | "roll-updated"
      | "ready"
      | "render"
      | "show-notification"
      | "show-overlay"
      | "show-panel"
      | "show-tooltip"
      | "size-updated"
      | "stop-all"
      | "zoom-updated"
      | "enter-object"
      | "leave-object"
      | "hover-object"
  the name of event
- E extends ViewerEvents & { type: T }
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | (e: E) => void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from TypedEventTarget.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

animate

animate(options: AnimateOptions): Animation<any>
Rotates and zooms the view with a smooth animation
Parameters
- options: AnimateOptions
Returns Animation<any>
- Defined in packages/core/src/Viewer.ts:624

autoSize

autoSize(): void
Resizes the scene if the viewer is resized

Returns void
- Defined in packages/core/src/Viewer.ts:326

createTooltip

createTooltip(config: TooltipConfig): Tooltip
Creates a new tooltip Use Tooltip.move to update the tooltip without re-create
Parameters
- config: TooltipConfig
Returns Tooltip
Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/Viewer.ts:760

destroy

destroy(): void
Destroys the viewer

Returns void
- Defined in packages/core/src/Viewer.ts:197

dispatchEvent

dispatchEvent(e: ViewerEvents): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- e: ViewerEvents
Returns boolean
Inherited from TypedEventTarget.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

enterFullscreen

enterFullscreen(): void
Enters the fullscreen mode

Returns void
- Defined in packages/core/src/Viewer.ts:715

exitFullscreen

exitFullscreen(): void
Exits the fullscreen mode

Returns void
- Defined in packages/core/src/Viewer.ts:724

getPlugin

getPlugin<T extends AbstractPlugin<any>>(
pluginId: string | PluginConstructor,
): 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')
```
Example: By plugin class with TypeScript support
```
viewer.getPlugin<MarkersPlugin>(MarkersPlugin)
```
- Defined in packages/core/src/Viewer.ts:268

getPosition

getPosition(): Position
Returns the current position of the camera

Returns Position
- Defined in packages/core/src/Viewer.ts:280

getSize

getSize(): Size
Returns the current viewer size

Returns Size
- Defined in packages/core/src/Viewer.ts:294

getZoomLevel

getZoomLevel(): number
Returns the current zoom level

Returns number
- Defined in packages/core/src/Viewer.ts:287

hideError

hideError(): void
Hides the error message

Returns void
- Defined in packages/core/src/Viewer.ts:582

isFullscreenEnabled

isFullscreenEnabled(): boolean
Checks if the viewer is in fullscreen

Returns boolean
- Defined in packages/core/src/Viewer.ts:301

needsContinuousUpdate

needsContinuousUpdate(enabled: boolean): void
Request the scene to be continuously renderer (when using videos)
Parameters
- enabled: boolean
Returns void
- Defined in packages/core/src/Viewer.ts:315

needsUpdate

needsUpdate(): void
Request a new render of the scene

Returns void
- Defined in packages/core/src/Viewer.ts:308

observeObjects

observeObjects(userDataKey: string): 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
- Defined in packages/core/src/Viewer.ts:780

removeEventListener

removeEventListener<
    T extends
        | "click"
        | "dblclick"
        | "fullscreen"
        | "before-animate"
        | "before-render"
        | "before-rotate"
        | "config-changed"
        | "hide-notification"
        | "hide-overlay"
        | "hide-panel"
        | "hide-tooltip"
        | "key-press"
        | "load-progress"
        | "panorama-load"
        | "panorama-loaded"
        | "panorama-error"
        | "transition-done"
        | "position-updated"
        | "roll-updated"
        | "ready"
        | "render"
        | "show-notification"
        | "show-overlay"
        | "show-panel"
        | "show-tooltip"
        | "size-updated"
        | "stop-all"
        | "zoom-updated"
        | "enter-object"
        | "leave-object"
        | "hover-object",
    E extends ViewerEvents & { type: T },
>(
    type:
        | "click"
        | "dblclick"
        | "fullscreen"
        | "before-animate"
        | "before-render"
        | "before-rotate"
        | "config-changed"
        | "hide-notification"
        | "hide-overlay"
        | "hide-panel"
        | "hide-tooltip"
        | "key-press"
        | "load-progress"
        | "panorama-load"
        | "panorama-loaded"
        | "panorama-error"
        | "transition-done"
        | "position-updated"
        | "roll-updated"
        | "ready"
        | "render"
        | "show-notification"
        | "show-overlay"
        | "show-panel"
        | "show-tooltip"
        | "size-updated"
        | "stop-all"
        | "zoom-updated"
        | "enter-object"
        | "leave-object"
        | "hover-object",
    callback: EventListenerObject | (e: E) => void,
    options?: boolean | EventListenerOptions,
): void
Type Parameters
- T extends
      | "click"
      | "dblclick"
      | "fullscreen"
      | "before-animate"
      | "before-render"
      | "before-rotate"
      | "config-changed"
      | "hide-notification"
      | "hide-overlay"
      | "hide-panel"
      | "hide-tooltip"
      | "key-press"
      | "load-progress"
      | "panorama-load"
      | "panorama-loaded"
      | "panorama-error"
      | "transition-done"
      | "position-updated"
      | "roll-updated"
      | "ready"
      | "render"
      | "show-notification"
      | "show-overlay"
      | "show-panel"
      | "show-tooltip"
      | "size-updated"
      | "stop-all"
      | "zoom-updated"
      | "enter-object"
      | "leave-object"
      | "hover-object"
  the name of event
- E extends ViewerEvents & { type: T }
  the class of the event
Parameters
- type:
      | "click"
      | "dblclick"
      | "fullscreen"
      | "before-animate"
      | "before-render"
      | "before-rotate"
      | "config-changed"
      | "hide-notification"
      | "hide-overlay"
      | "hide-panel"
      | "hide-tooltip"
      | "key-press"
      | "load-progress"
      | "panorama-load"
      | "panorama-loaded"
      | "panorama-error"
      | "transition-done"
      | "position-updated"
      | "roll-updated"
      | "ready"
      | "render"
      | "show-notification"
      | "show-overlay"
      | "show-panel"
      | "show-tooltip"
      | "size-updated"
      | "stop-all"
      | "zoom-updated"
      | "enter-object"
      | "leave-object"
      | "hover-object"
- callback: EventListenerObject | (e: E) => void
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from TypedEventTarget.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

resize

resize(size: CssSize): void
Resizes the viewer
Parameters
- size: CssSize
Returns void
- Defined in packages/core/src/Viewer.ts:695

rotate

rotate(position: ExtendedPosition): void
Rotates the view to specific position
Parameters
- position: ExtendedPosition
Returns void
- Defined in packages/core/src/Viewer.ts:589

setCursor

setCursor(cursor: string): void
Changes the global mouse cursor
Parameters
- cursor: string
Returns void
- Defined in packages/core/src/Viewer.ts:767

setOption

setOption<
    T extends
        | "description"
        | "caption"
        | "mousemove"
        | "defaultYaw"
        | "defaultPitch"
        | "moveInertia"
        | "fisheye"
        | "requestHeaders"
        | "navbar"
        | "keyboard"
        | "downloadUrl"
        | "downloadName"
        | "loadingImg"
        | "loadingTxt"
        | "size"
        | "minFov"
        | "maxFov"
        | "defaultZoomLvl"
        | "sphereCorrection"
        | "moveSpeed"
        | "zoomSpeed"
        | "mousewheel"
        | "mousewheelCtrlKey"
        | "touchmoveTwoFingers"
        | "canvasBackground"
        | "defaultTransition"
        | "rendererParameters"
        | "withCredentials"
        | "lang"
        | "keyboardActions",
>(
    option: T,
    value: UpdatableViewerConfig[T],
): void
Update options
Type Parameters
- T extends
      | "description"
      | "caption"
      | "mousemove"
      | "defaultYaw"
      | "defaultPitch"
      | "moveInertia"
      | "fisheye"
      | "requestHeaders"
      | "navbar"
      | "keyboard"
      | "downloadUrl"
      | "downloadName"
      | "loadingImg"
      | "loadingTxt"
      | "size"
      | "minFov"
      | "maxFov"
      | "defaultZoomLvl"
      | "sphereCorrection"
      | "moveSpeed"
      | "zoomSpeed"
      | "mousewheel"
      | "mousewheelCtrlKey"
      | "touchmoveTwoFingers"
      | "canvasBackground"
      | "defaultTransition"
      | "rendererParameters"
      | "withCredentials"
      | "lang"
      | "keyboardActions"
Parameters
- option: T
- value: UpdatableViewerConfig[T]
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/Viewer.ts:563

setOptions

setOptions(options: Partial<UpdatableViewerConfig>): void
Update options
Parameters
- options: Partial<UpdatableViewerConfig>
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/Viewer.ts:478

setPanorama

setPanorama(path: any, options?: PanoramaOptions): Promise<boolean>
Loads a new panorama file 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.
Parameters
- path: any
- options: PanoramaOptions = {}
Returns Promise<boolean>
promise resolved with false if the loading was aborted by another call
- Defined in packages/core/src/Viewer.ts:348

showError

showError(message: string): void
Displays an error message over the viewer
Parameters
- message: string
Returns void
- Defined in packages/core/src/Viewer.ts:570

startKeyboardControl

startKeyboardControl(): void
Enables the keyboard controls

Returns void
- Defined in packages/core/src/Viewer.ts:744

stopAnimation

stopAnimation(): PromiseLike<any>
Stops the ongoing animation The return value is a Promise because the is no guaranty the animation can be stopped synchronously.

Returns PromiseLike<any>
- Defined in packages/core/src/Viewer.ts:683

stopKeyboardControl

stopKeyboardControl(): void
Disables the keyboard controls

Returns void
- Defined in packages/core/src/Viewer.ts:751

toggleFullscreen

toggleFullscreen(): void
Enters or exits the fullscreen mode

Returns void
- Defined in packages/core/src/Viewer.ts:733

unobserveObjects

unobserveObjects(userDataKey: string): void
Unsubscribes to events on objects
Parameters
- userDataKey: string
Returns void
- Defined in packages/core/src/Viewer.ts:789

zoom

zoom(level: number): void
Zooms to a specific level between maxFov and minFov
Parameters
- level: number
Returns void
- Defined in packages/core/src/Viewer.ts:603

zoomIn

zoomIn(step?: number): void
Increases the zoom level
Parameters
- step: number = 1
Returns void
- Defined in packages/core/src/Viewer.ts:610

zoomOut

zoomOut(step?: number): void
Decreases the zoom level
Parameters
- step: number = 1
Returns void
- Defined in packages/core/src/Viewer.ts:617

Class Viewer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Viewer

Properties

Readonlyconfig

Readonlycontainer

ReadonlydataHelper

Readonlyloader

Readonlynavbar

Readonlynotification

Readonlyoverlay

Readonlypanel

Readonlyparent

Readonlyrenderer

Readonlystate

ReadonlytextureLoader

StaticuseNewAnglesOrder

Deprecated

Methods

addEventListener

Type Parameters

Parameters

Returns void

animate

Parameters

Returns Animation<any>

autoSize

Returns void

createTooltip

Parameters

Returns Tooltip

Throws

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

enterFullscreen

Returns void

exitFullscreen

Returns void

getPlugin

Type Parameters

Parameters

Returns T

Example: By plugin identifier

Example: By plugin class with TypeScript support

getPosition

Returns Position

getSize

Returns Size

getZoomLevel

Returns number

hideError

Returns void

isFullscreenEnabled

Returns boolean

needsContinuousUpdate

Parameters

Returns void

needsUpdate

Returns void

observeObjects

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

resize

Parameters

Returns void

rotate

`Readonly`config

`Readonly`container

`Readonly`dataHelper

`Readonly`loader

`Readonly`navbar

`Readonly`notification

`Readonly`overlay

`Readonly`panel

`Readonly`parent

`Readonly`renderer

`Readonly`state

`Readonly`textureLoader

`Static`useNewAnglesOrder