Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

IPopup

Extends ICustomizable, IEventEmitter.

Interface for an info object.

Constructor | Fields | Events | Methods

Constructor

IPopup()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

Events

NameDescription
close

Closing the info object.

open

Opening the info object.

optionschange

Change to the object options.

Inherited from ICustomizable.

Methods

NameReturnsDescription
close([force])

vow.Promise

Closes the info object.

getData()

Returns info object data.

getOverlay()

vow.Promise

Returns the promise object to return the overlay.

getOverlaySync()

IOverlay

Returns the overlay, if one exists.

getPosition()

Returns the coordinates of the info object.

isOpen()

Boolean

Returns the info object state: open/closed.

open([position[, data]])

vow.Promise

Opens the info object at the specified position. If the info object is already open, it moves it to the specified point. The format and content of the coordinates is determined by the IProjection that is in the options.

setData(data)

vow.Promise

Defines new data for the info object.

setPosition(position)

vow.Promise

Specifies a new position for the info object.

Events details

close

Closing the info object.

open

Opening the info object.

Methods details

close

{vow.Promise} close([force])

Closes the info object.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
force false

Type: Boolean

Instant closure.

getData

{} getData()

Returns info object data.

getOverlay

{vow.Promise} getOverlay()

Returns the promise object to return the overlay.

getOverlaySync

{IOverlay} getOverlaySync()

Returns the overlay, if one exists.

getPosition

{} getPosition()

Returns the coordinates of the info object.

isOpen

{Boolean} isOpen()

Returns the info object state: open/closed.

open

Opens the info object at the specified position. If the info object is already open, it moves it to the specified point. The format and content of the coordinates is determined by the IProjection that is in the options.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
position

Type: Number[]

The point where you want to place the balloon.

data

Type: Object|String|HTMLElement

Overlay data.

setData

{vow.Promise} setData(data)

Defines new data for the info object.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
data*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object|String|HTMLElement

Info object data.

* Mandatory parameter/option.

setPosition

{vow.Promise} setPosition(position)

Specifies a new position for the info object.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
position*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]

The coordinates of the info object.

* Mandatory parameter/option.