# Migration from v3

Photo Sphere Viewer 4 is a complete rewrite of the internals of the library using ES6 modules and a modular plugin system. The library is still compatible with less modern browsers and any build systems (or no build system at all) but many methods and options have been moved and renamed.

# Compatibility wrapper

For a quick migration from Photo Sphere Viewer 3 you can use the CompatViewer class instead of PhotoSphereViewer.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/photo-sphere-viewer.min.css"/>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/markers.min.css"/>

<script src="https://cdn.jsdelivr.net/npm/three/build/three.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/uevent@2/browser.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/photo-sphere-viewer.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/viewer-compat.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/markers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/gyroscope.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/stereo.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/visible-range.min.js"></script>

<script>
var viewer = new PhotoSphereViewer.CompatViewer({
  // old options
});
</script>

WARNING

Please note this wrapper is not fully tested and only addresses renamed options and moved methods.

It does not cover the signature changes of event methods (on and once).

# Plugins

The following features have been moved into separated plugins :

# Options

# Renamed options

The viewer configuration is globally the same as version 3 but every snake_case properties are now in camelCase, for example default_lat is now named defaultLat. Be sure to rename your configuration properties, the old naming is not supported at all.

# Other renamed options :

  • usexmpdatauseXmpData
  • anim_speedautorotateSpeed
  • anim_latautorotateLat
  • time_animautorotateDelay
  • default_fovdefaultZoomLvl
  • mousemove_hovercaptureCursor
  • zoom_speedzoomButtonIncrement
  • mousewheel_factormousewheelSpeed

# Deleted options

  • transition → use transition and showLoader options of setPanorama()
  • tooltip → the properties of the tooltip are now extracted from the stylesheet
  • webgl → WebGL is now always enabled since three.js deprecated the CanvasRenderer
  • panorama_roll → use sphereCorrection with the roll property

# Methods

# Moved methods

In version 3, all methods where on the main PhotoSphereViewer object. Now in version 4, many methods have been moved to sub-objects for the renderer, hud, left-panel, etc. Bellow is the mapping of the most common methods, please check the API Documentation for a complete list of methods.

# General

  • render()needsUpdate() (prefered) or renderer.render()
  • preloadPanorama()textureLoader.preloadPanorama()
  • clearPanoramaCache()textureLoader.clearPanoramaCache()
  • getPanoramaCache()textureLoader.getPanoramaCache()
  • showNavbar()navbar.show()
  • hideNavbar()navbar.hide()
  • toggleNavbar()navbar.toggle()
  • getNavbarButton()navbar.getButton()
  • setCaption()navbar.setCaption()

# Notification

  • showNotification()notification.show()
  • hideNotification()notification.hide()
  • isNotificationVisible()notification.isVisible()

# Overlay

  • showOverlay()overlay.show()
  • hideOverlay()overlay.hide()
  • isOverlayVisible()overlay.isVisible()

# Panel

  • showPanel()panel.show()
  • hidePanel()panel.hide()

# Tooltip

  • showTooltip()tooltip.show()
  • hideTooltip()tooltip.hide()
  • isTooltipVisible()tooltip.isVisible()

# Events

Although the events are now triggered by the new sub-objects, you only have to use on() and off() on the main object, for the sake of simplicity.

# Markers

Markers' properties are not directly stored in the Marker object anymore but in its config attribute. You should only use markersPlugin.updateMarker() to update these properties.