Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

geoObject.Balloon

Extends IBalloonManager.

Geo object balloon manager. Allows a geo object to manage a balloon by opening it and hiding it. Passes data to the balloon in the IGeoObjectPopupData. Uses the map balloon manager map.Balloon internally. Geo objects contain an instance of this class, which is available as myGeoObject.balloon. Don't create new instances of this class unless necessary.

See Balloon GeoObject.balloon

Constructor | Fields | Events | Methods

Constructor

geoObject.Balloon(geoObject)

Parameters:

ParameterDefault valueDescription
geoObject *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Geo object.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

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.

close([force])

vow.Promise

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

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.

open([position[, data[, options]]])

vow.Promise

Opens the balloon for the geo object.

setData([data])

vow.Promise

Sets new user data.

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.

Methods details

open

Opens the balloon for the geo object.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
position

Type: Number[]

Coordinates of the point where the hint is opened. By default: the point on the geoobject that is closest to the current center of the map. The projection of the coordinates can be specified in the options, otherwise the geo object projection is used.

data

Type: Object

Data to add to the userData field for the object of data passed to the balloon.

options

Type: Object

Options.

setData

{vow.Promise} setData([data])

Sets new user data.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
data

Type: Object

Data to add to the userData field for the object of data passed to the balloon.