Photo Sphere Viewer

# Methods

# Presentation

Many methods are available to control the viewer from your application. The full list of methods is available on the API Documentation .

Modular architecture

Photo Sphere Viewer is internally splitted in multiple components, this has an impact on where are located each method. For example, the methods to control the navbar are in the navbar object.

The important components are :

  • navbar
  • hud
  • panel

It is good practice to wait for the ready event before calling any method.

viewer.once('ready', () => {
  viewer.rotate({
    x: 1500,
    y: 1000
  });
});

# Main methods

This section describes the most useful methods available, remember to check the API Documentation for a full list.

# animate(options): Animation

Rotate and zoom the view with a smooth animation. You can change the position (longitude, latitude or x, y) and the zoom level (zoom). The speed option is either a duration in milliseconds or string containing the speed in revolutions per minute (2rpm) or degrees per second (10dps). It returns a PSV.Animation which is a standard Promise with an additional cancel method.

viewer.animate({
  longitude: Math.PI / 2,
  latitude: '20deg',
  zoom: 50,
  speed: '-2rpm',
})
  .then(() => /* animation complete */);

# destroy()

Remove the viewer from the page and frees memory used by three.js.

# getPosition(): Position

Return the current position of the view.

# getZoomLevel(): number

Return the current zoom level between 0 and 100.

# rotate(position)

Immediately rotate the view without animation.

// you can also use longitude and latitude
viewer.rotate({
  x: 1500,
  y: 600,
});

# setOption(option, value)

Update an option of the viewer. Some options cannot be changed : panorama, panoData, container, adapter and plugins.

viewer.setOption('fisheye', true);

# setOptions(options)

Update multiple options at once.

viewer.setOptions({
  fisheye: true,
  autorotateSpeed: '-1rpm',
});

# setPanorama(panorama, options): Promise

Change the panorama image with an optional transition animation (enabled by default). You can also set the new sphereCorrection and panoData if needed.

viewer.setPanorama('image.jpg')
  .then(() => /* update complete */);

# zoom(level) | zoomIn() | zoomOut()

Change the zoom level without animation.

← Events →