OpenLayers API
OpenLayers JavaScript API Documentation<a title="Link to this section" class="anchor" href="/wiki/Documentation#OpenLayersJavaScriptAPIDocumentation"> ¶</a>
Automatically generated API documentation is available:
- <a class="ext-link" href="http://dev.openlayers.org/releases/OpenLayers-2.6/doc/apidocs/files/OpenLayers-js.html">2.6 (Last stable release) API Natural Docs on dev.openlayers.org</a>.
- <a class="ext-link" href="http://dev.openlayers.org/apidocs/files/OpenLayers-js.html">Trunk API Natural Docs on dev.openlayers.org</a>.
See <a class="wiki" href="/wiki/NaturalDocs">Natural Docs conventions</a> if you are contributing code.
Note on API Stability:
There are two types of properties/methods in the <a class="wiki" href="/wiki/OpenLayers">OpenLayers</a> code: One set is the set of API Methods and properties. There are also additional internal properties which are not exposed to the API. Javascript does not have private members, so there is no technical limitation to using these non-documented methods in Application code. However, while we make every effort not to change APIs between releases, methods and properties which are not explicitly declared as API Methods may change in minor releases.
The documentation above only includes the API Methods. Full developer/internal library documentation is also available below, but methods which are not available in the API documentation above can not be depended upon to stay the same between releases. If you use methods included in these docs, you may have to make modifications in your application code to run between minor releases of <a class="wiki" href="/wiki/OpenLayers">OpenLayers</a>.
- <a class="ext-link" href="http://dev.openlayers.org/releases/OpenLayers-2.6/doc/devdocs/files/OpenLayers-js.html">2.6 (Last stable release) Developer Library Natural Docs on dev.openlayers.org</a>
- <a class="ext-link" href="http://dev.openlayers.org/docs/files/OpenLayers-js.html">Trunk Developer Library Natural Docs on dev.openlayers.org