OpenLayers API

From OSGeo
Revision as of 09:05, 28 September 2008 by Wiki-Linovski (talk | contribs) (New page: OpenLayers JavaScript API Documentation<a title="Link to this section" class="anchor" href="/wiki/Documentation#OpenLayersJavaScriptAPIDocumentation"> ¶</a></h2> <p> Automatically generat...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

OpenLayers JavaScript API Documentation<a title="Link to this section" class="anchor" href="/wiki/Documentation#OpenLayersJavaScriptAPIDocumentation"> ¶</a>

Automatically generated API documentation is available:

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>.