new Popup(options)
A class to display popups on a map
Parameters:
| Name | Type | Description |
|---|---|---|
options |
module:nyc/ol/Popup~Popup.Options | Constructor options |
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 cssstring A css class
- Source:
-
hide()
-
Hide the popup
- Source:
-
show(options)
-
Show the popup
Parameters:
Name Type Description optionsmodule:nyc/ol/Popup~Popup.ShowOptions Overlay options
- Source:
Type Definitions
-
Options
-
Constructor option for module:nyc/ol/Popup~Popup
Type:
- Object
- Source:
Properties:
Name Type Description mapol.Map The map
-
ShowOptions
-
Options for module:nyc/ol/Popup~Popup#show
Type:
- Object
- Source:
Properties:
Name Type Argument Description htmljQuery | Element | string The popup content
coordinateol.coordinate The popup location
cssstring <optional>
A css class