Class VisibleRangePlugin

Locks the visible angles

Hierarchy

AbstractConfigurablePlugin<VisibleRangePluginConfig, VisibleRangePluginConfig, UpdatableVisibleRangePluginConfig>
- VisibleRangePlugin

Index

Constructors

Properties

config viewer VERSION configParser id readonlyOptions

Methods

addEventListener dispatchEvent removeEventListener setHorizontalRange setOption setOptions setRangesFromPanoData setVerticalRange

Constructors

constructor

new VisibleRangePlugin(viewer, config): VisibleRangePlugin
Parameters
- viewer: Viewer
- config: VisibleRangePluginConfig
Returns VisibleRangePlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in visible-range-plugin/src/VisibleRangePlugin.ts:38

Properties

`Readonly` config

config: VisibleRangePluginConfig

`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<VisibleRangePluginConfig, VisibleRangePluginConfig> = getConfig

`Static` `Readonly` id

id: "visible-range" = 'visible-range'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

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

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends never
  
  the name of event
- E extends never
  
  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 core/src/lib/TypedEventTarget.ts:29

dispatchEvent

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

removeEventListener

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

setHorizontalRange

setHorizontalRange(range): void
Changes the horizontal range
Parameters
- range: Range
Returns void
- Defined in visible-range-plugin/src/VisibleRangePlugin.ts:157

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "usePanoData"
Parameters
- option: T
- value: UpdatableVisibleRangePluginConfig[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in core/src/plugins/AbstractPlugin.ts:68

setOptions

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

setRangesFromPanoData

setRangesFromPanoData(): void
Changes the ranges according the current panorama cropping data

Returns void
- Defined in visible-range-plugin/src/VisibleRangePlugin.ts:179

setVerticalRange

setVerticalRange(range): void
Changes the vertical range
Parameters
- range: Range
Returns void
- Defined in visible-range-plugin/src/VisibleRangePlugin.ts:130

Generated using TypeDoc