clusterer.Balloon
Extends IBalloonManager.
The clusterer's balloon manager. Provides management of the cluster's balloon - opening it and hiding it. It uses the map balloon manager map.Balloon. Clusterers contain an instance of this class, which is available as myGeoObject.balloon. Don't create new instances of this class unless necessary.
See Balloon
Constructor | Fields | Events | Methods
Constructor
clusterer.Balloon(clusterer)
Parameters:
Parameter |
Default value |
Description |
— |
Type: Clusterer Clusterer. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Opening a balloon on a cluster. Names of fields that are available via the Event.get method:
|
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 balloon.
|
|
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. |
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. |
Fields details
open
open
Opening a balloon on a cluster. Names of fields that are available via the Event.get method:
- target - Link to the clusterer balloon manager.
- cluster - Reference to the cluster object.
Instance of the Event class.
Example:
clusterer.balloon.events.add('open', function (e) {
var clusterPlacemark = e.get('cluster');
});
Events details
close
Closing the balloon.
- target - Link to the clusterer balloon manager.
- cluster - Reference to the cluster object.
Instance of the Event class.
Mandatory parameter/option.