Photo Sphere Viewer

# ResolutionPlugin

API Documentation

Adds a button to choose between multiple resolutions of the panorama. Requires the Settings plugin.

This plugin is available in the core photo-sphere-viewer package in dist/plugins/resolution.js.

WARNING

ResolutionPlugin is not compatible with GalleryPlugin.

# Usage

Once enabled the plugin will add a new setting the user can use to change the resolution of the panorama.

const viewer = new PhotoSphereViewer.Viewer({
  plugins: [
    PhotoSphereViewer.SettingsPlugin,
    [PhotoSphereViewer.ResolutionPlugin, {
      defaultResolution: 'SD',
      resolutions: [
        {
          id      : 'SD',
          label   : 'Small',
          panorama: 'sphere_small.jpg',
        },
        {
          id      : 'HD',
          label   : 'Normal',
          panorama: 'sphere.jpg',
        },
      ],
    }],
  ],
});

# Example

The following example provides two resolutions for the panorama, "small" is loaded by default.

# Configuration

# resolutions

  • type: object[]

List of available resolutions. Each resolution consist of an object with the properties id, label and panorama. Cubemaps are supported.

# defaultResolution 4.7.2

  • type: string

The id of the default resolution to load. If not provided the first resolution will be used.

WARNING

If a panorama is initially configured on the viewer, this setting is ignored.

# showBadge

  • type: boolean
  • default: true

Show the resolution id as a badge on the settings button.

# lang

  • type: object
  • default:
lang: {
    resolution : 'Quality',
}

Note: this option is not part of the plugin but is merged with the main lang object.

# Events

# resolution-changed(id)

Triggered when the resolution is changed.

resolutionPlugin.on('resolution-changed', (e, id) => {
  console.log(`Current resolution: ${id}`);
});

← SettingsPlugin →