Class ResolutionPlugin

Adds a setting to choose between multiple resolutions of the panorama.

Hierarchy (View Summary)

AbstractPlugin<ResolutionPluginEvents>
- ResolutionPlugin

Index

Constructors

constructor

new ResolutionPlugin(
viewer: Viewer,
config: ResolutionPluginConfig,
): ResolutionPlugin
Parameters
- viewer: Viewer
- config: ResolutionPluginConfig
Returns ResolutionPlugin
Overrides AbstractPlugin.constructor
- Defined in packages/resolution-plugin/src/ResolutionPlugin.ts:35

Properties

`Readonly`config

config: ResolutionPluginConfig

`Protected`viewer

viewer: Viewer

`Static` `Readonly`id

id: "resolution" = 'resolution'

Unique identifier of the plugin

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

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

dispatchEvent

dispatchEvent(e: ResolutionChangedEvent): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

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

getResolution

getResolution(): string
Returns the current resolution

Returns string
- Defined in packages/resolution-plugin/src/ResolutionPlugin.ts:172

removeEventListener

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

setResolution

setResolution(id: string): Promise<unknown>
Changes the current resolution
Parameters
- id: string
Returns Promise<unknown>
Throws
PSVError if the resolution does not exist
- Defined in packages/resolution-plugin/src/ResolutionPlugin.ts:149

setResolutions

setResolutions(resolutions: Resolution[], defaultResolution?: string): void
Changes the available resolutions
Parameters
- resolutions: Resolution[]
- OptionaldefaultResolution: string
  if not provided, the current panorama is kept
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/resolution-plugin/src/ResolutionPlugin.ts:109

`Static`withConfig

withConfig(config: ResolutionPluginConfig): [PluginConstructor, any]
Parameters
- config: ResolutionPluginConfig
Returns [PluginConstructor, any]
- Defined in packages/resolution-plugin/src/ResolutionPlugin.ts:31

Class ResolutionPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ResolutionPlugin

Properties

Readonlyconfig

Protectedviewer

Static Readonlyid

Static ReadonlyVERSION

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getResolution

Returns string

removeEventListener

Type Parameters

Parameters

Returns void

setResolution

Parameters

Returns Promise<unknown>

Throws

setResolutions

Parameters

Returns void

Throws

StaticwithConfig

Parameters

Returns [PluginConstructor, any]

Settings

On This Page

`Readonly`config

`Protected`viewer

`Static` `Readonly`id

`Static` `Readonly`VERSION

`Static`withConfig