Context Navigation

Version 48 (modified by openlayers, 5 years ago)
--

Documentation

Before Getting Started -- The Technologies Behind OpenLayers

We at OpenLayers generally assume that everyone who comes to us is already a highly skilled web programmer. Such, however, is not always the case. Here we have assembled a few quick links to tutorials and the like on how to master the art of coding in JavaScript, debug in Firebug, understand JSON, etc.

Introduction to JavaScript by the people at mootools.
Four-part video series by Douglas Crockford on Programming in JavaScript
Crockford's JavaScript page
Introduction to JSON
Debugging with Firebug

Getting Started

Getting Started - How to initialise the javascript and run it from your own HTML

OpenLayers JavaScript API Documentation

Automatically generated API documentation is available:

See Natural Docs conventions if you are contributing code.

Note on API Stability:

There are two types of properties/methods in the OpenLayers 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 OpenLayers.