diff --git a/apidoc/index.md b/apidoc/index.md index d4ead4ed78..f0a9bec988 100644 --- a/apidoc/index.md +++ b/apidoc/index.md @@ -1,20 +1,41 @@ -Finding your way around ------------------------ -See the class list to the right and especially take a look at {@link ol.Map} and {@link ol.layer.Layer} because those are the central objects. - -In general every use of OpenLayers starts by initializing a map, then adding the required layers. Controls and interactions can be added to change the behavior of the map. - -Projections ------------ -A {@link ol.proj.Projection} defines which point on earth is represented by a pair of coordinates. -Coordinates within OpenLayers can be used in various projections where some common projections are always supported, -others can be used via [Proj4js](http://trac.osgeo.org/proj4js/). - -Maps and Layers ---------------- -A map in OpenLayers is essentially a staple of layers that is viewed from the top. Layers are responsible for retrieving data and displaying it. - -Contributing ------------- -See [CONTRIBUTING.md](https://github.com/openlayers/ol3/blob/master/CONTRIBUTING.md) for instructions -on building and testing OpenLayers. The file does also describe how to commit your changes to OpenLayers. +
| Map | View | Layers | +
|---|---|---|
A [map](ol.Map.html) is made of [layers](ol.layer.html), a [view](ol.View.html) to visualize them, [interactions](ol.interaction.html) to modify map content and [controls](ol.control.html) with UI components. +[Overview](ol.Map.html)+[Creation](ol.Map.html#Map) +[Events](ol.MapBrowserEvent.html) |
+The view manages the visual parameters of the map view, like resolution or rotation. +[ol.View2D](ol.View2D.html) with center, projection, resolution and rotation |
+Layers are lightweight containers that get their data from [sources](ol.source.html). +[ol.layer.Tile](ol.layer.Tile.html)+[ol.layer.Image](ol.layer.Image) +[ol.layer.Vector](ol.layer.Vector) |
+
| Controls | Interactions | Sources and formats | +
| [Map default controls](ol.control.html#defaults) +[All controls](ol.control.html) + |
+
+[Map default interactions](ol.interaction.html#defaults) +Interactions for [vector features](ol.Feature.html) +
|
+[Tile sources](ol.source.Tile.html) for [ol.layer.Tile](ol.layer.Tile.html)
+ [Image sources](ol.source.Image.html) for [ol.layer.Image](ol.layer.Image) + [Vector sources](ol.source.Vector.html) for [ol.layer.Vector](ol.layer.Vector) + [Formats](ol.format.Feature.html) for reading/writing vector data + [ol.format.WMSCapabilities](ol.format.WMSCapabilities.html) |
| Projections | 2-way bindings | Other components |
All coordinates and extents need to be provided in map projection (default: [EPSG:3857](ol.proj.EPSG3857.html)). To transform, use [ol.proj.transform()](ol.proj.html#transform). +[ol.proj](ol.proj.html) |
+[Objects](ol.Object.html) can be kept in sync using the [bindTo()](ol.Object.html#bindTo) method. +A [DOM Input](ol.dom.Input.html) class is available to bind Object properties to HTML Input elements. |
+[ol.DeviceOrientation](ol.DeviceOrientation.html) +[ol.Geolocation](ol.Geolocation.html) +[ol.Overlay](ol.Overlay.html) +[ol.FeatureOverlay](ol.FeatureOverlay.html) |
+