Class GalleryPlugin

Adds a gallery of multiple panoramas

Hierarchy

AbstractConfigurablePlugin<GalleryPluginConfig, GalleryPluginConfig, UpdatableGalleryPluginConfig, GalleryPluginEvents>
- GalleryPlugin

Index

Constructors

Properties

config viewer VERSION configParser id readonlyOptions

Methods

addEventListener dispatchEvent hide removeEventListener setItems setOption setOptions show toggle

Constructors

constructor

new GalleryPlugin(viewer, config): GalleryPlugin
Parameters
- viewer: Viewer
- config: GalleryPluginConfig
Returns GalleryPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:38

Properties

`Readonly` config

config: GalleryPluginConfig

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

`Static` `Readonly` id

id: "gallery" = 'gallery'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

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

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "show-gallery" | "hide-gallery"
  
  the name of event
- E extends Object
  
  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: GalleryPluginEvents
Returns boolean
Inherited from AbstractConfigurablePlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

hide

hide(): void
Hides the carousem

Returns void
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:112

removeEventListener

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

setItems

setItems(items, handler?): void
Sets the list of items
Parameters
- items: GalleryItem[]
- Optional handler: ((id) => void)
  
  function that will be called when an item is clicked instead of the default behavior
  
  Optional
  - - (id): void
    - Parameters
      
      id: string | number
      
      Returns void
Returns void

Throws
PSVError if the configuration is invalid
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:134

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "hideOnClick" | "thumbnailSize"
Parameters
- option: T
- value: UpdatableGalleryPluginConfig[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<UpdatableGalleryPluginConfig>
Returns void
Overrides AbstractConfigurablePlugin.setOptions
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:80

show

show(): void
Shows the gallery

Returns void
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:104

toggle

toggle(): void
Hides or shows the gallery

Returns void
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:120

Generated using TypeDoc