Class VirtualTourPlugin

Creates virtual tours by linking multiple panoramas

Hierarchy (View Summary)

AbstractConfigurablePlugin<
    VirtualTourPluginConfig,
    VirtualTourPluginConfig,
    never,
    VirtualTourEvents,
>
- VirtualTourPlugin

Index

Constructors

constructor

new VirtualTourPlugin(
viewer: Viewer,
config: VirtualTourPluginConfig,
): VirtualTourPlugin
Parameters
- viewer: Viewer
- config: VirtualTourPluginConfig
Returns VirtualTourPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:134

Properties

`Readonly`config

config: VirtualTourPluginConfig

`Protected`viewer

viewer: Viewer

`Static` `Readonly`configParser

configParser: ConfigParser<VirtualTourPluginConfig, VirtualTourPluginConfig> = getConfig

`Static` `Readonly`id

id: "virtual-tour" = 'virtual-tour'

Unique identifier of the plugin

`Static` `Readonly`readonlyOptions

readonlyOptions: string[] = ...

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Accessors

is3D

get is3D(): boolean
Returns boolean
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:122

isGps

get isGps(): boolean
Returns boolean
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:130

isServerSide

get isServerSide(): boolean
Returns boolean
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:126

Methods

addEventListener

addEventListener<
    T extends "node-changed"
    | "enter-arrow"
    | "leave-arrow",
    E extends VirtualTourEvents & { type: T },
>(
    type: T,
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | AddEventListenerOptions,
): void
Type Parameters
- T extends "node-changed" | "enter-arrow" | "leave-arrow"
  the name of event
- E extends VirtualTourEvents & { type: T }
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

dispatchEvent

dispatchEvent(e: VirtualTourEvents): 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: VirtualTourEvents
Returns boolean
Inherited from AbstractConfigurablePlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

getCurrentNode

getCurrentNode(): VirtualTourNode
Returns the current node

Returns VirtualTourNode
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:234

getLinkPosition

getLinkPosition(nodeId: string): Position
Returns the position of a link in the viewer
Parameters
- nodeId: string
Returns Position
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:453

gotoLink

gotoLink(nodeId: string, speed?: string | number): Promise<void>
Rotate the view to face the link
Parameters
- nodeId: string
- speed: string | number = '8rpm'
Returns Promise<void>
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:437

removeEventListener

removeEventListener<
    T extends "node-changed"
    | "enter-arrow"
    | "leave-arrow",
    E extends VirtualTourEvents & { type: T },
>(
    type: "node-changed" | "enter-arrow" | "leave-arrow",
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | EventListenerOptions,
): void
Type Parameters
- T extends "node-changed" | "enter-arrow" | "leave-arrow"
  the name of event
- E extends VirtualTourEvents & { type: T }
  the class of the event
Parameters
- type: "node-changed" | "enter-arrow" | "leave-arrow"
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

setCurrentNode

setCurrentNode(
    nodeId: string,
    options?: VirtualTourTransitionOptions & { forceUpdate?: boolean },
    fromLink?: VirtualTourLink,
): Promise<boolean>
Changes the current node
Parameters
- nodeId: string
- Optionaloptions: VirtualTourTransitionOptions & { forceUpdate?: boolean }
  - OptionalforceUpdate?: boolean
    reload the node even if already loaded
- OptionalfromLink: VirtualTourLink
Returns Promise<boolean>
resolves false if the loading was aborted by another call
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:269

setNodes

setNodes(nodes: VirtualTourNode[], startNodeId?: string): void
Sets the nodes (client mode only)
Parameters
- nodes: VirtualTourNode[]
- OptionalstartNodeId: string
Returns void
Throws
PSVError if not in client mode
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:242

setOption

setOption<T extends string | number | symbol>(option: T, value: never[T]): void
Update options
Type Parameters
- T extends string | number | symbol
Parameters
- option: T
- value: never[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in packages/core/src/plugins/AbstractPlugin.ts:68

setOptions

setOptions(options: never): void
Update options
Parameters
- options: never
Returns void
Inherited from AbstractConfigurablePlugin.setOptions
- Defined in packages/core/src/plugins/AbstractPlugin.ts:76

updateNode

updateNode(newNode: Partial<VirtualTourNode> & { id: string }): void
Updates a node (client mode only) All properties but "id" are optional, the new config will be merged with the previous
Parameters
- newNode: Partial<VirtualTourNode> & { id: string }
Returns void
Throws
PSVError if not in client mode
- Defined in packages/virtual-tour-plugin/src/VirtualTourPlugin.ts:468

Class VirtualTourPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VirtualTourPlugin

Properties

Readonlyconfig

Protectedviewer

Static ReadonlyconfigParser

Static Readonlyid

Static ReadonlyreadonlyOptions

Static ReadonlyVERSION

Accessors

is3D

Returns boolean

isGps

Returns boolean

isServerSide

Returns boolean

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getCurrentNode

Returns VirtualTourNode

getLinkPosition

Parameters

Returns Position

gotoLink

Parameters

Returns Promise<void>

removeEventListener

Type Parameters

Parameters

Returns void

setCurrentNode

Parameters

OptionalforceUpdate?: boolean

Returns Promise<boolean>

setNodes

Parameters

Returns void

Throws

setOption

Type Parameters

Parameters

Returns void

setOptions

Parameters

Returns void

updateNode

Parameters

Returns void

Throws

Settings

On This Page

`Readonly`config

`Protected`viewer

`Static` `Readonly`configParser

`Static` `Readonly`id

`Static` `Readonly`readonlyOptions

`Static` `Readonly`VERSION

`Optional`forceUpdate?: boolean