VisibleRangePlugin

Locks the visible area of the panorama.

This plugin is available in the @photo-sphere-viewer/visible-range-plugin package.

Usage

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

import { VisibleRangePlugin } from '@photo-sphere-viewer/visible-range-plugin';

const viewer = new Viewer({
    plugins: [
        [VisibleRangePlugin, {
            horizontalRange: [-Math.PI / 2, Math.PI / 2],
            verticalRange: [-Math.PI / 3, Math.PI / 3],
        }],
    ],
});

const visibleRangePlugin = viewer.getPlugin(VisibleRangePlugin);

visibleRangePlugin.setHorizontalRange(['0deg', '180deg']);
visibleRangePlugin.setVerticalRange(null);

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

Example

Configuration

horizontalRange

• type: double[]|string[]
• default: null
• updatable: no, use setHorizontalRange() plugin

Visible horizontal range as two angles.

verticalRange

• type: double[]|string[]
• default: null
• updatable: no, use setVerticalRange() plugin

Visible vertical range as two angles.

usePanoData

• type: boolean
• default: false
• updatable: yes

Use cropped panorama data as visible range immediately after load.

Methods

setHorizontalRange(range) | setVerticalRange(range)

Change or remove the ranges.

setRangesFromPanoData()

Use cropped panorama data as visible range.