IPopupManager

Interface for the info object manager.

Constructor

IPopupManager()

Fields


Name	Type	Description
events	IEventManager	Event manager. Inherited from IEventEmitter.

Events


Name	Description
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.


Name	Description
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


Name	Returns	Description
close([force])	vow.Promise	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()	vow.Promise	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]]])	vow.Promise	Opens the info object at the specified position.
setData(data)	vow.Promise	Defines new data for the info object.
setOptions(options)	vow.Promise	Defines new options for the info object.
setPosition(position)	vow.Promise	Specifies a new position for the info object.


Name	Returns	Description
close([force])	vow.Promise	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()	vow.Promise	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]]])	vow.Promise	Opens the info object at the specified position.
setData(data)	vow.Promise	Defines new data for the info object.
setOptions(options)	vow.Promise	Defines new options for the info object.
setPosition(position)	vow.Promise	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
force	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
position	—	Type: Number[] Coordinates of the point where the hint is opened.
data	—	Type: Object\|String\|HTMLElement Data.
options	—	Type: Object Options.


Parameter	Default value	Description
position	—	Type: Number[] Coordinates of the point where the hint is opened.
data	—	Type: Object\|String\|HTMLElement Data.
options	—	Type: Object Options.

setData

{vow.Promise} setData(data)

Defines new data for the info object.

Returns Promise object.

Parameters:


Parameter	Default value	Description
data *	—	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
options *	—	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
position *	—	Type: Number[] The coordinates of the info object.

^* Mandatory parameter/option.