Files
openlayers/config/jsdoc/api/index.md
ahocevar e810387956 Fix some JSDoc issues
Also makes a few minor changes to the template, so it can be used until
we have a new doc generation process. JSDoc output is written to
build/apidoc.
2018-05-10 17:14:17 +02:00

3.7 KiB

MapViewLayers

A [map](module-ol_Map-Map.html) is made of [layers](module-ol_layer_Base-BaseLayer.html), a [view](module-ol_View-View.html) to visualize them, [interactions](module-ol_interaction_Interaction-Interaction.html) to modify map content and [controls](module-ol_control_Control-Control.html) with UI components.

[Overview](module-ol_Map-Map.html)
[Creation](module-ol_Map-Map.html#Map)
[Events](module-ol_MapBrowserEvent-MapBrowserEvent.html)

The view manages the visual parameters of the map view, like resolution or rotation.

[View](module-ol_View-View.html) with center, projection, resolution and rotation

Layers are lightweight containers that get their data from [sources](module-ol_source_Source-Source.html).

[layer/Tile](module-ol_layer_Tile-TileLayer.html)
[layer/Image](module-ol_layer_Image-ImageLayer.html)
[layer/Vector](module-ol_layer_Vector-VectorLayer.html)
[layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html)
ControlsInteractionsSources and formats
[Map default controls](module-ol_control_util.html#.defaults)
[All controls](module-ol_control_Control-Control.html)
[Map default interactions](module-ol_interaction.html#~defaults)
Interactions for [vector features](module-ol_Feature-Feature.html)
  • [interaction/Select](module-ol_interaction_Select-Select.html)
  • [interaction/Draw](module-ol_interaction_Draw-Draw.html)
  • [interaction/Modify](module-ol_interaction_Modify-Modify.html)
[All interactions](module-ol_interaction_Interaction-Interaction.html)
[Tile sources](module-ol_source_Tile-TileSource.html) for [layer/Tile](module-ol_layer_Tile-TileLayer.html)
[Image sources](module-ol_source_Image-ImageSource.html) for [layer/Image](module-ol_layer_Image-ImageLayer.html)
[Vector sources](module-ol_source_Vector-VectorSource.html) for [layer/Vector](module-ol_layer_Vector-VectorLayer.html)
[Vector tile sources](module-ol_source_VectorTile-VectorTile.html) for [layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html)
[Formats](module-ol_format_Feature-FeatureFormat.html) for reading/writing vector data
[format/WMSCapabilities](module-ol_format_WMSCapabilities-WMSCapabilities.html)
ProjectionsObservable objectsOther components

All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use [proj.transform()](module-ol_proj.html#.transform) and [proj.transformExtent()](module-ol_proj.html#.transformExtent).

[ol/proj](module-ol_proj.html)

Changes to all [ol/Object](module-ol_Object-BaseObject.html)s can be observed by calling the [object.on('propertychange')](module-ol_Object-BaseObject.html#on) method. Listeners receive an [ol/Object~ObjectEvent](module-ol_Object-ObjectEvent.html) with information on the changed property and old value.

[ol/Geolocation](module-ol_Geolocation.html)
[ol/Overlay](module-ol_Overlay-Overlay.html)

 

API change policy

The OpenLayers API consists of

  • names and signatures of constructors
  • names and signatures of instance methods and properties
  • names and signatures of functions
  • names of constants

Within a major release series, the API will not be changed. Any changes to the API will be accompanied by a new major release.

Note: The API change policy does not cover CSS class names that are used to style the OpenLayers UI. It also does not cover any typedefs and enums.