Photo Sphere Viewer 4

Class: GalleryPlugin

PSV.plugins.GalleryPlugin

new PSV.plugins.GalleryPlugin (psv, options)

Adds a gallery of multiple panoramas

Name Type Description
psv PSV.Viewer
options PSV.plugins.GalleryPlugin.Options

Extends

Members

PSV.plugins.GalleryPlugin.EVENTS string staticconstant

Available events

id string readonly inherited overrides

Unique identifier of the plugin

psv PSV.Viewer readonly inherited overrides

Reference to main controller

Methods

__click (id) package

Name Type Description
id string

destroy () package overrides

hide ()

Hides the carousem

Fires:

init () package overrides

setItems (items, handler)

Sets the list of items

Name Type Description
items Array.<PSV.plugins.GalleryPlugin.Item>
handler function optional

function that will be called when an item is clicked instead of the default behavior

show ()

Shows the gallery

Fires:

toggle ()

Hides or shows the gallery

Type Definitions

PSV.plugins.GalleryPlugin.Item Object

Properties:
Name Type Argument Description
id number | string

Unique identifier of the item
panorama *
thumbnail string <optional>

URL of the thumbnail
name string <optional>

Text visible over the thumbnail
options PSV.PanoramaOptions <optional>

Any option supported by the setPanorama() method

PSV.plugins.GalleryPlugin.Options Object

Properties:
Name Type Argument Default Description
items Array.<PSV.plugins.GalleryPlugin.Item> <optional>
visibleOnLoad boolean <optional>
 false

Displays the gallery when loading the first panorama
hideOnClick boolean <optional>
 true

Hides the gallery when the user clicks on an item
thumbnailSize PSV.Size <optional>

Size of thumbnails, default (200x100) is set with CSS

Events

Triggered when the gallery is hidden

Triggered when the gallery is shown