hotspot.layer.Balloon
Extends IBalloonManager.
Manager of the balloon of a hotspot layer. Allows a geo object to manage the hotspot layer by opening it and hiding it. It uses the map balloon manager map.Balloon. Hotspot layers contain an instance of this class available as myHotspotLayer.balloon. Don't create new instances of this class unless necessary.
See Balloonhotspot.Layer.balloon
Constructor | Fields | Events | Methods
Constructor
hotspot.layer.Balloon(hotspotLayer)
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Hotspot layer. |
* Mandatory parameter/option.
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:
Inherited from IBalloonManager. |
|
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:
Inherited from IBalloonManager. |
|
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:
Inherited from IBalloonManager. |
|
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:
Inherited from IBalloonManager. |
Methods
Name |
Returns |
Description |
autoPan() |
Moves the map so that the balloon is visible. Inherited from IBalloonManager. |
|
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 balloon at the specified position. |
||
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. |
Methods details
open
{vow.Promise} open([position[, data[, options]]])
Opens the balloon at the specified position.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[] The coordinates of the balloon opening in the global pixel coordinates. |
|
— |
Type: Object Data. |
|
— |
Type: Object Options. |
Mandatory parameter/option.