Document Map events

This commit is contained in:
ahocevar
2014-03-24 21:53:42 +01:00
parent fcd737e62b
commit f37245963c
+10 -3
View File
@@ -153,9 +153,14 @@ ol.MapProperty = {
* The above snippet creates a map with a MapQuest OSM layer on a 2D view and * 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`. * 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 * @constructor
* @extends {ol.Object} * @extends {ol.Object}
* @param {olx.MapOptions} options Map options. * @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 stability experimental
* @todo observable layergroup {ol.layer.LayerGroup} a layer group containing * @todo observable layergroup {ol.layer.LayerGroup} a layer group containing
* the layers in this map. * the layers in this map.
@@ -163,7 +168,7 @@ ol.MapProperty = {
* @todo observable target {string|Element} the Element or id of the Element * @todo observable target {string|Element} the Element or id of the Element
* that the map is rendered in. * that the map is rendered in.
* @todo observable view {ol.IView} the view that controls this map * @todo observable view {ol.IView} the view that controls this map
*/ */
ol.Map = function(options) { ol.Map = function(options) {
goog.base(this); goog.base(this);
@@ -766,7 +771,8 @@ ol.Map.prototype.getViewport = function() {
/** /**
* @return {Element} The map's overlay container. Elements added to this * @return {Element} The map's overlay container. Elements added to this
* container will let mousedown and touchstart events through to the map, so * 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() { ol.Map.prototype.getOverlayContainer = function() {
return this.overlayContainer_; return this.overlayContainer_;
@@ -776,7 +782,8 @@ ol.Map.prototype.getOverlayContainer = function() {
/** /**
* @return {Element} The map's overlay container. Elements added to this * @return {Element} The map's overlay container. Elements added to this
* container won't let mousedown and touchstart events through to the map, so * 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() { ol.Map.prototype.getOverlayContainerStopEvent = function() {
return this.overlayContainerStopEvent_; return this.overlayContainerStopEvent_;