From f37245963c59fcb05819ab86ae3fe4186318eb5f Mon Sep 17 00:00:00 2001 From: ahocevar Date: Mon, 24 Mar 2014 21:53:42 +0100 Subject: [PATCH] Document Map events --- src/ol/map.js | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/ol/map.js b/src/ol/map.js index fbe46a52cd..7ff7b1e724 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -153,9 +153,14 @@ ol.MapProperty = { * The above snippet creates a map with a MapQuest OSM layer on a 2D view and * renders it to a DOM element with the id `map`. * + * In addition to the events listed below, the map relays + * {@link ol.MapBrowserEvent} events. + * * @constructor * @extends {ol.Object} * @param {olx.MapOptions} options Map options. + * @event moveend Triggered after the map is moved. + * @event postrender Triggered after a map frame is rendered. * @todo stability experimental * @todo observable layergroup {ol.layer.LayerGroup} a layer group containing * the layers in this map. @@ -163,7 +168,7 @@ ol.MapProperty = { * @todo observable target {string|Element} the Element or id of the Element * that the map is rendered in. * @todo observable view {ol.IView} the view that controls this map - */ +† */ ol.Map = function(options) { goog.base(this); @@ -766,7 +771,8 @@ ol.Map.prototype.getViewport = function() { /** * @return {Element} The map's overlay container. Elements added to this * container will let mousedown and touchstart events through to the map, so - * clicks and gestures on an overlay will trigger MapBrowserEvent events. + * clicks and gestures on an overlay will trigger {@link ol.MapBrowserEvent} + * events. */ ol.Map.prototype.getOverlayContainer = function() { return this.overlayContainer_; @@ -776,7 +782,8 @@ ol.Map.prototype.getOverlayContainer = function() { /** * @return {Element} The map's overlay container. Elements added to this * container won't let mousedown and touchstart events through to the map, so - * clicks and gestures on an overlay don't trigger any MapBrowserEvent. + * clicks and gestures on an overlay don't trigger any + * {@link ol.MapBrowserEvent}. */ ol.Map.prototype.getOverlayContainerStopEvent = function() { return this.overlayContainerStopEvent_;