Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

panorama.Manager

Extends IEventEmitter.

Manager of the panorama player linked to the map.

Constructor | Fields | Events | Methods

Constructor

panorama.Manager(playerElement, map[, playerOptions])

Parameters:

ParameterDefault valueDescription
playerElement *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: HTMLElement|String|panorama.Manager.USE_MAP_CONTAINER

The element containing the player.

map *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Map

The map to which the panorama player is linked.

playerOptions

Type: Object

Player options.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
closeplayer

The panorama player is closed. Instance of the Event class.

disablelookup

Search mode is disabled for panoramas. Instance of the Event class.

enablelookup

Search mode is enabled for panoramas. Instance of the Event class.

locate

Started searching for panoramas at the given point. Instance of the Event class. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.

locatefail

The panorama search failed with an error. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.
  • error - The error that occurred while searching.

locatesuccess

The panorama search finished successfully. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.
  • result - The list of the found panoramas.

openplayer

The panorama player is opened. Instance of the Event class.

Methods

NameReturnsDescription
closePlayer()

Hides the panorama player.

disableLookup()

Disables panorama search mode on the map.

enableLookup()

Enables panorama search mode on the map.

getPlayer()

panorama.Player

Returns the current panorama player or null if the player is closed.

isLookupEnabled()

Boolean

Checks whether panorama search mode is enabled on the map.

openPlayer(panorama)

vow.Promise

Opens the panorama player.

Events details

closeplayer

The panorama player is closed. Instance of the Event class.

disablelookup

Search mode is disabled for panoramas. Instance of the Event class.

enablelookup

Search mode is enabled for panoramas. Instance of the Event class.

locate

Started searching for panoramas at the given point. Instance of the Event class. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.

locatefail

The panorama search failed with an error. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.
  • error - The error that occurred while searching.

locatesuccess

The panorama search finished successfully. Names of fields that are available via the Event#get method:

  • point - Search for panoramas around this point.
  • options - Panorama search options.
  • result - The list of the found panoramas.

openplayer

The panorama player is opened. Instance of the Event class.

Methods details

closePlayer

{} closePlayer()

Hides the panorama player.

disableLookup

{} disableLookup()

Disables panorama search mode on the map.

enableLookup

{} enableLookup()

Enables panorama search mode on the map.

getPlayer

{panorama.Player} getPlayer()

Returns the current panorama player or null if the player is closed.

isLookupEnabled

{Boolean} isLookupEnabled()

Checks whether panorama search mode is enabled on the map.

openPlayer

{vow.Promise} openPlayer(panorama)

Opens the panorama player.

Returns the promise that will be resolved with an error if the panorama has failed to open or if opening has been canceled by the closePlayer request.

Parameters:

ParameterDefault valueDescription
panorama*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IPanorama[][]|Number[]

Panorama or the coordinates of the panorama.

* Mandatory parameter/option.