Class GalleryPlugin

Adds a gallery of multiple panoramas

Hierarchy (View Summary)

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

Index

Constructors

constructor

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

Properties

`Readonly`config

config: GalleryPluginConfig

`Protected`viewer

viewer: Viewer

`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)[] = ...

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

addEventListener<
    T extends "show-gallery"
    | "hide-gallery",
    E extends GalleryPluginEvents & { type: T },
>(
    type: T,
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | AddEventListenerOptions,
): void
Type Parameters
- T extends "show-gallery" | "hide-gallery"
  the name of event
- E extends GalleryPluginEvents & { 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: GalleryPluginEvents): 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: 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:130

isVisible

isVisible(): boolean
Returns boolean
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:146

removeEventListener

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

setItems

setItems(items: GalleryItem[], handler?: (id: string | number) => void): void
Sets the list of items
Parameters
- items: GalleryItem[]
- Optionalhandler: (id: string | number) => void
  function that will be called when an item is clicked instead of the default behavior
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:156

setOption

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

show

show(): void
Shows the gallery

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

toggle

toggle(): void
Hides or shows the gallery

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

`Static`withConfig

withConfig(config: GalleryPluginConfig): [PluginConstructor, any]
Parameters
- config: GalleryPluginConfig
Returns [PluginConstructor, any]
- Defined in packages/gallery-plugin/src/GalleryPlugin.ts:44

Class GalleryPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GalleryPlugin

Properties

Readonlyconfig

Protectedviewer

Static ReadonlyconfigParser

Static Readonlyid

Static ReadonlyreadonlyOptions

Static ReadonlyVERSION

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

hide

Returns void

isVisible

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

setItems

Parameters

Returns void

Throws

setOption

Type Parameters

Parameters

Returns void

setOptions

Parameters

Returns void

show

Returns void

toggle

Returns void

StaticwithConfig

Parameters

Returns [PluginConstructor, any]

Settings

On This Page

`Readonly`config

`Protected`viewer

`Static` `Readonly`configParser

`Static` `Readonly`id

`Static` `Readonly`readonlyOptions

`Static` `Readonly`VERSION

`Static`withConfig