IPopupManager
Extends IEventEmitter.
Interface for the info object manager.
Constructor | Fields | Events | Methods
Constructor
IPopupManager()
Fields
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
Events
Methods
Name | Returns | Description |
---|---|---|
close([force]) | Closes the info object. | |
destroy() | Disables the info object manager. | |
getData() | Object|null | Returns the data of the info object or 'null'. |
getOptions() | IOptionManager|null | Returns the options manager or 'null'. |
getOverlay() | Returns the promise object to return the overlay. | |
getOverlaySync() | IOverlay|null | Returns the overlay, if one exists. |
getPosition() | Number[]|null | Returns the coordinates of the info object or 'null'. |
isOpen() | Boolean | Returns the info object state: open/closed. |
open([position[, data[, options]]]) | Opens the info object at the specified position. | |
setData(data) | Defines new data for the info object. | |
setOptions(options) | Defines new options for the info object. | |
setPosition(position) | Specifies a new position for the info object. |
Name | Returns | Description |
---|---|---|
close([force]) | Closes the info object. | |
destroy() | Disables the info object manager. | |
getData() | Object|null | Returns the data of the info object or 'null'. |
getOptions() | IOptionManager|null | Returns the options manager or 'null'. |
getOverlay() | Returns the promise object to return the overlay. | |
getOverlaySync() | IOverlay|null | Returns the overlay, if one exists. |
getPosition() | Number[]|null | Returns the coordinates of the info object or 'null'. |
isOpen() | Boolean | Returns the info object state: open/closed. |
open([position[, data[, options]]]) | Opens the info object at the specified position. | |
setData(data) | Defines new data for the info object. | |
setOptions(options) | Defines new options for the info object. | |
setPosition(position) | Specifies a new position for the info object. |
Events details
Methods details
close
{vow.Promise} close([force])
Closes the info object.
Returns Promise object.
Parameters:
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:
setData
{vow.Promise} setData(data)
Defines new data for the info object.
Returns Promise object.
Parameters:
* Mandatory parameter/option.
setOptions
{vow.Promise} setOptions(options)
Defines new options for the info object.
Returns Promise object.
Parameters:
* Mandatory parameter/option.
setPosition
{vow.Promise} setPosition(position)
Specifies a new position for the info object.
Returns Promise object.
Parameters:
* Mandatory parameter/option.