Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

Popup

Extends IPopup.

A class for creating an info object.

Constructor | Fields | Events | Methods

Constructor

Popup(map[, options])

Info object.

Parameters:

ParameterDefault valueDescription
map *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Map

Reference to the map.

options

Type: Object

Options.

options.closeTimeout 700

Type: Number

Delay before closing (in ms).

options.interactivityModel

Type: String

Key for the interactivity model. Available keys and their values are listed in the description of interactivityModel.storage.

options.openTimeout 150

Type: Number

Delay before opening (in ms).

options.pane

Type: IPane|String

Info object pane. For the list of available default panes, see map.pane.Manager.

options.projection

Type: IProjection

The projection of the coordinates to global pixels.

options.zIndex

Type: String

The z-index of the info object.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

Events

NameDescription
close

Closing the info object.

Inherited from IPopup.

open

Opening the info object.

Inherited from IPopup.

optionschange

Change to the object options.

Inherited from ICustomizable.

Methods

NameReturnsDescription
close([force])

vow.Promise

Closes the info object.

Inherited from IPopup.

getData()

Returns info object data.

Inherited from IPopup.

getOverlay()

vow.Promise

Returns the promise object to return the overlay.

Inherited from IPopup.

getOverlaySync()

IOverlay

Returns the overlay, if one exists.

Inherited from IPopup.

getPosition()

Returns the coordinates of the info object.

Inherited from IPopup.

isOpen()

Boolean

Returns the info object state: open/closed.

Inherited from IPopup.

open([position[, data]])

vow.Promise

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.

Inherited from IPopup.

setData(data)

vow.Promise

Defines new data for the info object.

Inherited from IPopup.

setPosition(position)

vow.Promise

Specifies a new position for the info object.

Inherited from IPopup.