IPopup
Extends ICustomizable, IEventEmitter.
Interface for an info object.
Constructor | Fields | Events | Methods
Constructor
IPopup()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Closing the info object. |
|
Opening the info object. |
|
Change to the object options. Inherited from ICustomizable. |
Methods
Name |
Returns |
Description |
Closes the info object. |
||
getData() |
Returns info object data. |
|
Returns the promise object to return the overlay. |
||
Returns the overlay, if one exists. |
||
Returns the coordinates of the info object. |
||
isOpen() |
Boolean |
Returns the info object state: open/closed. |
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. |
||
Defines new data for the info object. |
||
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:
Parameter |
Default value |
Description |
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
{vow.Promise} open([position[, data]])
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:
Parameter |
Default value |
Description |
— |
Type: Number[] The point where you want to place the balloon. |
|
— |
Type: Object|String|HTMLElement Overlay data. |
setData
{vow.Promise} setData(data)
Defines new data for the info object.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
|
— |
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:
Parameter |
Default value |
Description |
— |
Type: Number[] The coordinates of the info object. |
* Mandatory parameter/option.
Mandatory parameter/option.