IBalloonManager
Extends IPopupManager.
Interface for the balloon manager.
Constructor | Fields | Events | Methods
Constructor
IBalloonManager()
Fields
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
Events
Name | Description |
---|---|
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:
|
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:
|
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:
|
close | Closing the info object.
Names of fields available via Event.get:
Inherited from IPopupManager. |
open | Opening the info object.
Names of fields available via Event.get:
Inherited from IPopupManager. |
userclose | Balloon closed by the user.
Instance of the Event class.
Names of fields that are available via the Event.get method:
|
Name | Description |
---|---|
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:
|
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:
|
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:
|
close | Closing the info object.
Names of fields available via Event.get:
Inherited from IPopupManager. |
open | Opening the info object.
Names of fields available via Event.get:
Inherited from IPopupManager. |
userclose | 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. | |
close([force]) | 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. |
getOptions() | IOptionManager|null | Returns the options manager or 'null'. Inherited from IPopupManager. |
getOverlay() | Returns the promise object to return the overlay. Inherited from IPopupManager. | |
getOverlaySync() | IOverlay|null | Returns the overlay, if one exists. Inherited from IPopupManager. |
getPosition() | 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. |
open([position[, data[, options]]]) | Opens the info object at the specified position. Inherited from IPopupManager. | |
setData(data) | Defines new data for the info object. Inherited from IPopupManager. | |
setOptions(options) | Defines new options for the info object. Inherited from IPopupManager. | |
setPosition(position) | Specifies a new position for the info object. Inherited from IPopupManager. |
Name | Returns | Description |
---|---|---|
autoPan() | Moves the map so that the balloon is visible. | |
close([force]) | 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. |
getOptions() | IOptionManager|null | Returns the options manager or 'null'. Inherited from IPopupManager. |
getOverlay() | Returns the promise object to return the overlay. Inherited from IPopupManager. | |
getOverlaySync() | IOverlay|null | Returns the overlay, if one exists. Inherited from IPopupManager. |
getPosition() | 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. |
open([position[, data[, options]]]) | Opens the info object at the specified position. Inherited from IPopupManager. | |
setData(data) | Defines new data for the info object. Inherited from IPopupManager. | |
setOptions(options) | Defines new options for the info object. Inherited from IPopupManager. | |
setPosition(position) | Specifies a new position for the info object. Inherited from IPopupManager. |
Events details
autopanbegin
- target - Reference to the IBalloonOwner object.
autopanend
- target - Reference to the IBalloonOwner object.
beforeuserclose
- target - Reference to the IBalloonOwner object.
userclose
- target - Reference to the IBalloonOwner object.
Methods details
autoPan
{vow.Promise} autoPan()
Moves the map so that the balloon is visible.
Returns Promise object.