IPopupManager
Extends IEventEmitter.
Interface for the info object manager.
Constructor | Fields | Events | Methods
Constructor
IPopupManager()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
Closing the info object. Names of fields available via Event.get:
|
|
Opening the info object. Names of fields available via Event.get:
|
Methods
Name |
Returns |
Description |
Closes the info object. |
||
destroy() |
Disables the info object manager. |
|
getData() |
Object|null |
Returns the data of the info object or 'null'. |
IOptionManager|null |
Returns the options manager or 'null'. |
|
Returns the promise object to return the overlay. |
||
IOverlay|null |
Returns the overlay, if one exists. |
|
Number[]|null |
Returns the coordinates of the info object or 'null'. |
|
isOpen() |
Boolean |
Returns the info object state: open/closed. |
Opens the info object at the specified position. |
||
Defines new data for the info object. |
||
Defines new options for the info object. |
||
Specifies a new position for the info object. |
Events details
close
Closing the info object. Names of fields available via Event.get:
- target - Reference to the object where the closing occurred.
open
Opening the info object. Names of fields available via Event.get:
- target - Reference to the object where the opening occurred.
Methods details
close
{vow.Promise} close([force])
Closes the info object.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
false |
Type: Boolean Instant closure. |
destroy
{} destroy()
Disables the info object manager.
getData
{Object|null} getData()
Returns the data of the info object or 'null'.
getOptions
{IOptionManager|null} getOptions()
Returns the options manager or 'null'.
getOverlay
{vow.Promise} getOverlay()
Returns the promise object to return the overlay.
getOverlaySync
{IOverlay|null} getOverlaySync()
Returns the overlay, if one exists.
getPosition
{Number[]|null} getPosition()
Returns the coordinates of the info object or 'null'.
isOpen
{Boolean} isOpen()
Returns the info object state: open/closed.
open
{vow.Promise} open([position[, data[, options]]])
Opens the info object at the specified position.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[] Coordinates of the point where the hint is opened. |
|
— |
Type: Object|String|HTMLElement Data. |
|
— |
Type: Object Options. |
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.
setOptions
{vow.Promise} setOptions(options)
Defines new options for the info object.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Info object options. |
* 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.