Class: Popup

nyc/ol/Popup~ Popup


A class to display popups on a map

Parameters:
Name Type Description
options module:nyc/ol/Popup~Popup.Options

Constructor options

Source:
See:

Extends

  • ol.Overlay

Members


margin :Array.<number>

Margin to maintain from the edges of the map

Type:
  • Array.<number>
Source:

Methods


cssClass(css)

Set a CSS class for the popup content

Parameters:
Name Type Description
css string

A css class

Source:

hide()

Hide the popup

Source:

show(options)

Show the popup

Parameters:
Name Type Description
options module:nyc/ol/Popup~Popup.ShowOptions

Overlay options

Source:

Type Definitions


Options

Constructor option for module:nyc/ol/Popup~Popup

Type:
  • Object
Properties:
Name Type Description
map ol.Map

The map

Source:

ShowOptions

Type:
  • Object
Properties:
Name Type Argument Description
html jQuery | Element | string

The popup content

coordinate ol.coordinate

The popup location

css string <optional>

A css class

Source: