Skip to content

Latest commit

 

History

History
89 lines (52 loc) · 2.57 KB

README.md

File metadata and controls

89 lines (52 loc) · 2.57 KB
Raw

OpenLayers 3 Popup

Basic popup overlay for an OL3 map. By default the map is centred so that the popup is entirely visible.

Examples

The examples demonstrate usage and can be viewed online thanks to RawGit:

  • Basic usage
    • Create a popup instance, show it on single-click specifying the content
  • DOM Events
    • Handle DOM events triggered by interacting with elements within the popup content
  • Scroll
    • Controlling popup dimensions and scrolling overflowing content
  • Multiple popups
    • Add a new popup each time the maps is clicked

The source for all examples can be found in examples.

API

new ol.Overlay.Popup(opt_options)

OpenLayers 3 Popup Overlay. See the examples for usage. Styling can be done via CSS.

Parameters:

Name Type Description
opt_options Object Overlay options.

Extends

ol.Overlay

Methods

show(coord,html)

Show the popup.

Parameters:
Name Type Description
coord ol.Coordinate Where to anchor the popup.
html String or HTMLElement String or element of HTML to display within the popup.
hide()

Hide the popup.

isOpened()

Indicates if the popup is in open state

Contributing

Contributions are welcome, please create an issue first to discuss any potential contributions.

Updating README.md

README.md is generated from the JSDoc comments in the source code and the template util/README.md. To update the API docs edit the comments in the code; to update the other text edit the template (util/README.md).

Once you've made edits run the following which will recreate README.md using the JSDoc comments and template:

npm run doc

In order to use the doc npm script you will need to install the devDependencies:

npm install --only=dev

License

MIT (c) Matt Walker.

Credit

Based on an example by Tim Schaub posted on the OL3-Dev list.

Also see

If you find the popup useful you might also like the ol3-layerswitcher.