ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Use JSDoc's stock event documentation

Browse Source
This commit is contained in:
ahocevar
2014-03-25 18:21:08 +01:00
parent f37245963c
commit 7e850ca33d
8 changed files with 32 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/ol/map.js
View File

@@ -153,14 +153,11 @@ 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.
* @fires {@link ol.MapEvent} ol.MapEvent
* @fires {@link ol.MapBrowserEvent} ol.MapBrowserEvent
* @todo stability experimental
* @todo observable layergroup {ol.layer.LayerGroup} a layer group containing
* the layers in this map.

31
src/ol/mapbrowserevent.js
View File

@@ -26,19 +26,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @param {ol.Map} map Map.
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @param {?oli.FrameState=} opt_frameState Frame state.
* @event singleclick A true single click with no dragging and no double click.
* Note that this event is delayed by 250 ms to ensure that it is not a
* double click.
* @event dblclick A true double click, with no dragging.
* @event pointerdrag Triggered when a pointer is dragged.
* @event pointermove Triggered when a pointer is moved.
* @event pointerdown Triggered on pointer down.
* @event pointerup Triggered on pointer up.
* @event pointerover Triggered when a pointer is over the map's `target`.
* @event pointerout Triggered when a pointer is outside the map's `target`.
* @event pointerenter Triggered when a pointer enters the map's `target`.
* @event pointerleave Triggered when a pointer leaves the map's `target`.
* @event pointercancel Triggered when a pointer is no longer registered.
* @todo stability experimental
*/
ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
@@ -473,11 +460,28 @@ ol.MapBrowserEventHandler.prototype.disposeInternal = function() {
*/
ol.MapBrowserEvent.EventType = {
// derived event types
/**
* A true single click with no dragging and no double click. Note that this
* event is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick
*/
SINGLECLICK: 'singleclick',
/**
* A true double click, with no dragging.
* @event ol.MapBrowserEvent#dblclick
*/
DBLCLICK: goog.events.EventType.DBLCLICK,
/**
* Triggered when a pointer is dragged.
* @event ol.MapBrowserEvent#pointerdrag
*/
POINTERDRAG: 'pointerdrag',
// original pointer event types
/**
* Triggered when a pointer is moved.
* @event ol.MapBrowserEvent#pointermove
*/
POINTERMOVE: 'pointermove',
POINTERDOWN: 'pointerdown',
POINTERUP: 'pointerup',
@@ -487,3 +491,4 @@ ol.MapBrowserEvent.EventType = {
POINTERLEAVE: 'pointerleave',
POINTERCANCEL: 'pointercancel'
};