IBalloonManager
Extends IPopupManager.
Interface for the balloon manager.
Constructor | Fields | Events | Methods
Constructor
IBalloonManager()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
Start of automatic shifting of the map center initiated by the autoPan method. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
End of automatic shifting of the map center initiated by the autoPan method. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
The event which precedes Balloon.event:userclose. Allows you to cancel the user's action by calling the preventDefault method. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
Closing the info object. Names of fields available via Event.get:
Inherited from IPopupManager. |
|
Opening the info object. Names of fields available via Event.get:
Inherited from IPopupManager. |
|
Balloon closed by the user. Instance of the Event class. Names of fields that are available via the Event.get method:
|
Methods
Name |
Returns |
Description |
autoPan() |
Moves the map so that the balloon is visible. |
|
Closes the info object. Inherited from IPopupManager. |
||
destroy() |
Disables the info object manager. Inherited from IPopupManager. |
|
getData() |
Object|null |
Returns the data of the info object or 'null'. Inherited from IPopupManager. |
IOptionManager|null |
Returns the options manager or 'null'. Inherited from IPopupManager. |
|
Returns the promise object to return the overlay. Inherited from IPopupManager. |
||
IOverlay|null |
Returns the overlay, if one exists. Inherited from IPopupManager. |
|
Number[]|null |
Returns the coordinates of the info object or 'null'. Inherited from IPopupManager. |
|
isOpen() |
Boolean |
Returns the info object state: open/closed. Inherited from IPopupManager. |
Opens the info object at the specified position. Inherited from IPopupManager. |
||
Defines new data for the info object. Inherited from IPopupManager. |
||
Defines new options for the info object. Inherited from IPopupManager. |
||
Specifies a new position for the info object. Inherited from IPopupManager. |
Events details
autopanbegin
Start of automatic shifting of the map center initiated by the autoPan method. Instance of the Event class. Names of fields that are available via the Event.get method:
- target - Reference to the IBalloonOwner object.
autopanend
End of automatic shifting of the map center initiated by the autoPan method. Instance of the Event class. Names of fields that are available via the Event.get method:
- target - Reference to the IBalloonOwner object.
beforeuserclose
The event which precedes Balloon.event:userclose. Allows you to cancel the user's action by calling the preventDefault method. Instance of the Event class. Names of fields that are available via the Event.get method:
- target - Reference to the IBalloonOwner object.
userclose
Balloon closed by the user. Instance of the Event class. Names of fields that are available via the Event.get method:
- target - Reference to the IBalloonOwner object.
Methods details
autoPan
{vow.Promise} autoPan()
Moves the map so that the balloon is visible.
Returns Promise object.
Mandatory parameter/option.