panorama.Manager
Note
The constructor of the panorama.Manager class is hidden, as this class is not intended for autonomous initialization.
Extends IEventEmitter.
Manager of the panorama player linked to the map.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
The panorama player is closed. Instance of the Event class. |
|
Search mode is disabled for panoramas. Instance of the Event class. |
|
Search mode is enabled for panoramas. Instance of the Event class. |
|
Started searching for panoramas at the given point. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
The panorama search failed with an error. Names of fields that are available via the Event.get method:
|
|
The panorama search finished successfully. Names of fields that are available via the Event.get method:
|
|
The panorama player is opened. Instance of the Event class. |
Methods
Name |
Returns |
Description |
Hides the panorama player. |
||
Disables panorama search mode on the map. |
||
Enables panorama search mode on the map. |
||
Returns the current panorama player or null if the player is closed. |
||
Boolean |
Checks whether panorama search mode is enabled on the map. |
|
openPlayer(panorama[, locateOptions[, options]]) |
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[, locateOptions[, options]])
Opens the panorama player.
Returns the promise that will be rejected with an error if the panorama has failed to open or if opening has been canceled by the closePlayer request.
Parameters:
Parameter |
Default value |
Description |
— |
Type: IPanorama|Number[] Panorama or the coordinates of the panorama. |
|
— |
Type: Object Options for panorama.locate. |
|
— |
Type: Object |
|
'auto' |
Type: Number[] Direction of view for panorama. |
* Mandatory parameter/option.
Mandatory parameter/option.