# VisibleRangePlugin

API Documentation

Locks visible longitude and/or latitude.

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

# Usage

The plugin allows to define latitudeRange and longitudeRange to lock to viewable zone. It affects manual moves and automatic rotation.

const viewer = new PhotoSphereViewer.Viewer({
  plugins: [
    [PhotoSphereViewer.VisibleRangePlugin, {
      longitudeRange: [-Math.PI / 2, Math.PI / 2],
      latitudeRange : [-Math.PI / 3, Math.PI / 3],

const visibleRangePlugin = viewer.getPlugin(PhotoSphereViewer.VisibleRangePlugin);

visibleRangePlugin.setLongitudeRange(['0deg', '180deg']);

Alternatively, if usePanoData is set to true, the visible range is limited to the cropped panorama data provided to the viewer.

# Example

In this example only the front portion of the sphere is visible.

# Configuration

# longitudeRange

  • type: double[]|string[]
  • default: null

Visible longitude as two angles.

# latitudeRange

  • type: double[]|string[]
  • default: null

Visible latitude as two angles.

# usePanoData

  • type: boolean
  • default: false

Use cropped panorama data as visible range immediately after load.

# Methods

# setLatitudeRange(range) | setLongitudeRange(range)

Change or remove the ranges.

# setRangesFromPanoData()

Use cropped panorama data as visible range.