Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

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:

ParameterDefault valueDescription
clusterer *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Clusterer

Clusterer.

* Mandatory parameter/option.

Fields

NameTypeDescription
close

Closing the balloon.

  • target - Link to the clusterer balloon manager.
  • cluster - Reference to the cluster object.
Instance of the Event class.

eventsIEventManager

Event manager.

Inherited from IEventEmitter.

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.

Events

NameDescription
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:

Inherited from IBalloonManager.

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:

Inherited from IBalloonManager.

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:

Inherited from IBalloonManager.

close

Closing the info object. Names of fields available via Event#get:

  • target - Reference to the object where the closing occurred.

Inherited from IPopupManager.

open

Opening the info object. Names of fields available via Event#get:

  • target - Reference to the object where the opening occurred.

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:

Inherited from IBalloonManager.

Methods

NameReturnsDescription
autoPan()

vow.Promise

Moves the map so that the balloon is visible.

Inherited from IBalloonManager.

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()

vow.Promise

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.

setData(data)

vow.Promise

Defines new data for the info object.

Inherited from IPopupManager.

setOptions(options)

vow.Promise

Defines new options for the info object.

Inherited from IPopupManager.

setPosition(position)

vow.Promise

Specifies a new position for the info object.

Inherited from IPopupManager.

Fields details

close

close

Closing the balloon.

  • target - Link to the clusterer balloon manager.
  • cluster - Reference to the cluster object.
Instance of the Event class.

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');
});