Class: Popup

Extends

• ol.Overlay

Methods

---

cssClass(css)

Set a CSS class for the popup content

Parameters:

Name	Type	Description
css	string	A css class

Source:

• ol/Popup.js, line 95

---

goFullscreen()

Make the popup fill the map

Source:

• ol/Popup.js, line 148

---

hide()

Hide the popup

Source:

• ol/Popup.js, line 104

---

pan()

Pan the popup so it full appears on the map

Source:

• ol/Popup.js, line 124

---

show(options)

Show the popup

Parameters:

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

Source:

• ol/Popup.js, line 78

Type Definitions

---

Options

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

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
map	ol.Map			The map
autoPanMargin	number	<optional>	10	The margin the popup will maintain from the edge of the map

Source:

• ol/Popup.js, line 181

---

ShowOptions

Options for module:nyc/ol/Popup~Popup#show

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:

• ol/Popup.js, line 172