Documenting supported event types for the map.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@5853 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2008-01-23 20:08:43 +00:00
parent 077db39d39
commit 74bbd0347e

View File

@@ -26,7 +26,32 @@ OpenLayers.Map = OpenLayers.Class({
/**
* Constant: EVENT_TYPES
* {Array(String)} supported application event types
* {Array(String)} Supported application event types. Register a listener
* for a particular event with the following syntax:
* (code)
* map.events.register(type, obj, listener);
* (end)
*
* Supported map event types:
* - *addlayer* triggered after a layer has been added
* - *removelayer* triggered after a layer has been removed
* - *changelayer* triggered after a layer name change, order change, or
* visibility change (due to resolution thresholds)
* - *movestart* triggered after the start of a drag, pan, or zoom
* - *move* triggered after each drag, pan, or zoom
* - *moveend* triggered after a drag, pan, or zoom completes
* - *popupopen* triggered after a popup opens
* - *popupclose* triggered after a popup opens
* - *addmarker* triggered after a marker has been added
* - *removemarker* triggered after a marker has been removed
* - *clearmarkers* triggered after markers have been cleared
* - *mouseover* triggered after mouseover the map
* - *mouseout* triggered after mouseout the map
* - *mousemove* triggered after mousemove the map
* - *dragstart* triggered after the start of a drag
* - *drag* triggered after a drag
* - *dragend* triggered after the end of a drag
* - *changebaselayer* triggered after the base layer changes
*/
EVENT_TYPES: [
"addlayer", "removelayer", "changelayer", "movestart", "move",