Tool: OpenLayers API

[AmeliaBR]

This issue is for discussion of the reference tool "OpenLayers API".

---

overview and docs

Another reference example that can be as complicated as you make it, but also has very simple examples that will be used as the basis for the reference.

[prushforth]

OpenLayers is the most mature of the open source mapping libraries, and members of their project are also members of this GitHub organization, although not yet members of the CG. It would be awesome if top level devs like @ahocevar and / or @bartvde would be willing to help us define an API for an eventual (proposed) <map> and <layer> DOM.

[nchan0154]

Notes for widget capabilities:

Generate a default map for a given area

Not supported, need to provide a tileset.

Display a map using a single custom image as a map layer

Full support, example from their docs.

Display a map using tile data from an author-specified web map service

Full support, this is the default behavior for Open Layers.

Display a basic map without JavaScript.

No support, Open Layers is a JS library.

Show pinpoint locations or custom markers on the map

Fully supported. You could add points as a generic Point object or as a Feature which allows for customized icons.

Draw polygons or polylines as stylable, interactive vector graphics (separate from the image tiles)

Full support.

Support hyperlinks from markers or vector features

Full support. Example from their docs

Display map data attribution and links

Full support, this is automatically generated if you use tiles from preconfigured sources like OSM, and it is possible to pass in custom attribution.

Select map view from latitude and longitude point

Full support, this is the default selection method.

Select map view from street address or place name

Supported through a third party plugin

Display map tiles defined in various common coordinate systems

Full support through the Projection class

Reproject map tile data into a new projection or globe view

No support. Like Leaflet, you can destroy and reinitialize the map if another projection is needed.

Save the location or export to other application

No support.

Zoom the map independently from the rest of the page

Full support. Note, for full keyboard support, a tabindex must be added to the map container so that it can be focused.

Pan the map display

Full support. Same as above for keyboard support.

Load additional map tiles when they pan into view

Full support.

Wrap/duplicate data tiles when panning around the globe

Full support.

Maintain reasonable scale of labels and lines when zooming

Full support.

Dynamically load different resolution map tile on zoom

Full support.

Hide or show (and maybe dynamically load) vector features and labels on zoom

Full support.

Apply custom styling to map markers and vector features

Support, you can use custom images or style vector features with properties such as stroke and fill.

Apply custom styling to map controls

Full support, you can style controls with CSS.

Toggle whether default controls are displayed

Full support, passed in the initial configuration object.