Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

IPopupManager

Extends IEventEmitter.

Interface for the info object manager.

Constructor | Fields | Events | Methods

Constructor

IPopupManager()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
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

NameReturnsDescription
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:

ParameterDefault valueDescription
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

Opens the info object at the specified position.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
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:

ParameterDefault valueDescription
data*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

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:

ParameterDefault valueDescription
options*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

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:

ParameterDefault valueDescription
position*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]

The coordinates of the info object.

* Mandatory parameter/option.