Document stability of MapBrowserEvent properties and events
This commit is contained in:
@@ -41,16 +41,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
|
|||||||
/**
|
/**
|
||||||
* @const
|
* @const
|
||||||
* @type {Event}
|
* @type {Event}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
this.originalEvent = browserEvent.getBrowserEvent();
|
this.originalEvent = browserEvent.getBrowserEvent();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @type {ol.Coordinate}
|
* @type {ol.Coordinate}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
this.coordinate = map.getEventCoordinate(this.originalEvent);
|
this.coordinate = map.getEventCoordinate(this.originalEvent);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @type {ol.Pixel}
|
* @type {ol.Pixel}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
this.pixel = map.getEventPixel(this.originalEvent);
|
this.pixel = map.getEventPixel(this.originalEvent);
|
||||||
|
|
||||||
@@ -464,16 +467,19 @@ ol.MapBrowserEvent.EventType = {
|
|||||||
* A true single click with no dragging and no double click. Note that this
|
* 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 is delayed by 250 ms to ensure that it is not a double click.
|
||||||
* @event ol.MapBrowserEvent#singleclick
|
* @event ol.MapBrowserEvent#singleclick
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
SINGLECLICK: 'singleclick',
|
SINGLECLICK: 'singleclick',
|
||||||
/**
|
/**
|
||||||
* A true double click, with no dragging.
|
* A true double click, with no dragging.
|
||||||
* @event ol.MapBrowserEvent#dblclick
|
* @event ol.MapBrowserEvent#dblclick
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
DBLCLICK: goog.events.EventType.DBLCLICK,
|
DBLCLICK: goog.events.EventType.DBLCLICK,
|
||||||
/**
|
/**
|
||||||
* Triggered when a pointer is dragged.
|
* Triggered when a pointer is dragged.
|
||||||
* @event ol.MapBrowserEvent#pointerdrag
|
* @event ol.MapBrowserEvent#pointerdrag
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
POINTERDRAG: 'pointerdrag',
|
POINTERDRAG: 'pointerdrag',
|
||||||
|
|
||||||
@@ -481,6 +487,7 @@ ol.MapBrowserEvent.EventType = {
|
|||||||
/**
|
/**
|
||||||
* Triggered when a pointer is moved.
|
* Triggered when a pointer is moved.
|
||||||
* @event ol.MapBrowserEvent#pointermove
|
* @event ol.MapBrowserEvent#pointermove
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
POINTERMOVE: 'pointermove',
|
POINTERMOVE: 'pointermove',
|
||||||
POINTERDOWN: 'pointerdown',
|
POINTERDOWN: 'pointerdown',
|
||||||
@@ -491,4 +498,3 @@ ol.MapBrowserEvent.EventType = {
|
|||||||
POINTERLEAVE: 'pointerleave',
|
POINTERLEAVE: 'pointerleave',
|
||||||
POINTERCANCEL: 'pointercancel'
|
POINTERCANCEL: 'pointercancel'
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user