API Reference

Methods

Method	Description
`ready()`	Returns a Promise which resolves when the iGUIDE is ready to be used.
`tour.move(position, camera, transition)`	Transition to another pano. The `position` parameter is the ID of the pano and `transition` can be one of the following: `'no-animation', 'navigation', 'crossfade', 'floorplan-crossfade'`. See below for `camera`.
`tour.moveCamera(camera)`	Move the camera. The `camera` parameter is an object containing the `angle`, `elevation` and `zoom` properties.
`tour.floorplanResize(state)`	Resize the floor plan. The `state` parameter is a string that must equal either `min` or `max`.
`addEventListener(event, cb)`	Subscribe to an event. `cb` is a callback function that will be executed when the event is fired.
`removeEventListener(event, cb)`	Unsubscribe from an event. `cb` must be the same reference to the callback function passed earlier to `addEventListener()`.
`disconnect()`	Disconnect from the API, unsubscribing from all events.

Events

Event	Parameters	Description
`tour:move-start`	`(position, camera, transition)`	Fires as soon as the user clicks to switch to a new pano or floor, before the transition begins. The parameters can be passed to `tour.move()` in the same order.
`tour:move-end`	`(position, camera, transition)`	Fires once the user has switched to a new pano or floor, after the transition ends. The parameters can be passed to `tour.move()` in the same order.
`tour:camera-move-start`	`(camera)`	Fires when the user begins rotating the pano. The `camera` parameter can be passed to `tour.moveCamera()`.
`tour:camera-move`	`(camera)`	Fires while the user is rotating the pano. The `camera` parameter can be passed to `tour.moveCamera()`.
`tour:camera-move-end`	`(camera)`	Fires when the user finishes rotating the pano (and inertia has stopped rotating the pano, if applicable). The `camera` parameter can be passed to `tour.moveCamera()`.
`tour:floorplan-resize`	`(state)`	Fires when the floor plan is resized either by the user, device orientation change or window resize. The `state` parameter can be passed to `tour.floorplanResize()`.
`tour:floorplan-resize-end`	`(state)`	Fires when the floor plan resize transition has finished. The `state` parameter can be passed to `tour.floorplanResize()`.