photo-sphere-viewer/types/plugins/gallery/index.d.ts

A JavaScript library to display Photo Sphere panoramas

import { AbstractPlugin, PanoramaOptions, Size, Viewer } from '../..';

export type GalleryPluginOptions = {
  items?: GalleryPluginItem[];
  visibleOnLoad?: boolean;
  hideOnClick?: boolean;
  thumbnailSize?: Size;
};

export type GalleryPluginItem = {
  id: number | string;
  panorama: any;
  thumbnail?: string;
  name?: string;
  options?: PanoramaOptions;
};

export const EVENTS: {
  SHOW_GALLERY: 'show-gallery',
  HIDE_GALLERY: 'hide-gallery',
};

/**
 * @summary Adds a gallery of multiple panoramas
 */
export class GalleryPlugin extends AbstractPlugin {

  static EVENTS: typeof EVENTS;

  constructor(psv: Viewer, options: GalleryPluginOptions);

  /**
   * @summary Hides the gallery
   */
  hide();

  /**
   * @summary Shows the gallery
   */
  show();

  /**
   * @summary Hides or shows the gallery
   */
  toggle();

  /**
   * @summary Sets the list of items
   */
  setItems(items?: GalleryPluginItem[]);

  /**
   * @summary Triggered when the gallery is shown
   */
  on(e: 'show-gallery'): this;

  /**
   * @summary Triggered when the gallery is hidden
   */
  on(e: 'hide-gallery'): this;

}