IBalloonManager

Extends IPopupManager.

Interface for the balloon manager.

Constructor | Fields | Events | Methods

Constructor

Fields

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: target - Reference to the IBalloonOwner object.
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: target - Reference to the IBalloonOwner object.
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: target - Reference to the IBalloonOwner object.
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: target - Reference to the IBalloonOwner object.

Methods

Name	Returns	Description
autoPan()	vow.Promise	Moves the map so that the balloon is visible.
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 info object at the specified position. 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.

Events details

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:

• target - Reference to the IBalloonOwner object.

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:

• target - Reference to the IBalloonOwner object.

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:

• target - Reference to the IBalloonOwner object.

userclose

Balloon closed by the user. Instance of the Event class. Names of fields that are available via the Event#get method:

• target - Reference to the IBalloonOwner object.

Methods details

autoPan

Moves the map so that the balloon is visible.

Returns Promise object.