IMultiRouterRouteBalloon

Note. The constructor of the IMultiRouterRouteBalloon class is hidden, as this class is not intended for autonomous initialization.

Interface of the model description object of a multi-stop route.

Events | Methods

Events

Name Description
close

Closing the balloon.

open

Opening the balloon.

Methods

Name Returns Description
close()

vow.Promise

Closes route's balloon.

isOpen()

Boolean

Returns the info object state: open/closed.

open([position])

vow.Promise

Opens route's balloon at closest position on route to specified location. Also makes route active.

Events details

close

Closing the balloon.

open

Opening the balloon.

Methods details

close

{vow.Promise} close()

Closes route's balloon.

Returns Promise object.

isOpen

{Boolean} isOpen()

Returns the info object state: open/closed.

open

Opens route's balloon at closest position on route to specified location. Also makes route active.

Returns Promise object.

Parameters:

Parameter Default value Description
position

Type: Number[]

The point where you want to place the balloon. By default balloon will open in the middle of the route.