Class AutorotatePlugin

Adds an automatic rotation of the panorama

Hierarchy

AbstractConfigurablePlugin<AutorotatePluginConfig, ParsedAutorotatePluginConfig, UpdatableAutorotatePluginConfig, AutorotatePluginEvents>
- AutorotatePlugin

Index

Constructors

Properties

config viewer VERSION configParser id readonlyOptions

Methods

addEventListener dispatchEvent isEnabled removeEventListener setKeypoints setOption setOptions start stop toggle

Constructors

constructor

new AutorotatePlugin(viewer, config): AutorotatePlugin
Parameters
- viewer: Viewer
- config: AutorotatePluginConfig
Returns AutorotatePlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:108

Properties

`Readonly` config

config: ParsedAutorotatePluginConfig

`Protected` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

`Static` `Readonly` configParser

configParser: ConfigParser<AutorotatePluginConfig, ParsedAutorotatePluginConfig> = getConfig

`Static` `Readonly` id

id: "autorotate" = 'autorotate'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

readonlyOptions: (keyof AutorotatePluginConfig)[] = ...

Methods

addEventListener

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

dispatchEvent

dispatchEvent(e): boolean
Parameters
- e: AutorotateEvent
Returns boolean
Inherited from AbstractConfigurablePlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

isEnabled

isEnabled(): boolean
Checks if the automatic rotation is enabled

Returns boolean
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:241

removeEventListener

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

setKeypoints

setKeypoints(keypoints): void
Changes the keypoints
Parameters
- keypoints: AutorotateKeypoint[]
Returns void

Throws
PSVError if the configuration is invalid
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:182

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "autorotateSpeed" | "autorotatePitch" | "autostartDelay" | "autostartOnIdle" | "autorotateZoomLvl" | "startFromClosest"
Parameters
- option: T
- value: UpdatableAutorotatePluginConfig[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in packages/core/src/plugins/AbstractPlugin.ts:68

setOptions

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

start

start(): void
Starts the automatic rotation

Returns void
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:248

stop

stop(): void
Stops the automatic rotation

Returns void
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:270

toggle

toggle(): void
Starts or stops the automatic rotation

Returns void
- Defined in packages/autorotate-plugin/src/AutorotatePlugin.ts:290

Generated using TypeDoc