Do not expose ol.MapBrowserPointerEvent to the docs

This commit is contained in:
Andreas Hocevar
2016-08-09 16:13:57 +02:00
parent a9c54e0c02
commit 4b68df73a8
5 changed files with 8 additions and 35 deletions

View File

@@ -224,3 +224,7 @@ Hex color should have 3 or 6 digits.
### 55
The `{-y}` placeholder requires a tile grid with extent.
### 56
`mapBrowserEvent` must originate from a pointer event.

View File

@@ -157,30 +157,6 @@ oli.MapBrowserEvent.prototype.pixel;
oli.MapBrowserEvent.prototype.dragging;
/**
* @interface
*/
oli.MapBrowserPointerEvent;
/**
* @type {ol.pointer.PointerEvent}
*/
oli.MapBrowserPointerEvent.prototype.pointerEvent;
/**
* @interface
*/
oli.pointer.PointerEvent;
/**
* @type {Event}
*/
oli.pointer.PointerEvent.prototype.originalEvent;
/**
* @interface
*/

View File

@@ -2,7 +2,6 @@ goog.provide('ol.events.condition');
goog.require('ol.functions');
goog.require('ol.MapBrowserEvent.EventType');
goog.require('ol.MapBrowserPointerEvent');
/**
@@ -199,14 +198,14 @@ ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
/**
* Return `true` if the event originates from a mouse device.
*
* @param {ol.MapBrowserPointerEvent} mapBrowserPointerEvent Map browser pointer
* event.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the event originates from a mouse device.
* @api stable
*/
ol.events.condition.mouseOnly = function(mapBrowserPointerEvent) {
ol.events.condition.mouseOnly = function(mapBrowserEvent) {
ol.assert(mapBrowserEvent.pointerEvent, 56); // mapBrowserEvent must originate from a pointer event
// see http://www.w3.org/TR/pointerevents/#widl-PointerEvent-pointerType
return mapBrowserPointerEvent.pointerEvent.pointerType == 'mouse';
return /** @type {ol.MapBrowserEvent} */ (mapBrowserEvent).pointerEvent.pointerType == 'mouse';
};

View File

@@ -91,7 +91,6 @@ ol.MapBrowserEvent.prototype.stopPropagation = function() {
/**
* @constructor
* @implements {oli.MapBrowserPointerEvent}
* @extends {ol.MapBrowserEvent}
* @param {string} type Event type.
* @param {ol.Map} map Map.
@@ -106,10 +105,8 @@ ol.MapBrowserPointerEvent = function(type, map, pointerEvent, opt_dragging,
opt_frameState);
/**
* The underlying pointer event.
* @const
* @type {ol.pointer.PointerEvent}
* @api
*/
this.pointerEvent = pointerEvent;

View File

@@ -41,7 +41,6 @@ goog.require('ol.events.Event');
* touch events and even native pointer events.
*
* @constructor
* @implements {oli.pointer.PointerEvent}
* @extends {ol.events.Event}
* @param {string} type The type of the event to create.
* @param {Event} originalEvent The event.
@@ -52,10 +51,8 @@ ol.pointer.PointerEvent = function(type, originalEvent, opt_eventDict) {
ol.events.Event.call(this, type);
/**
* The original browser event.
* @const
* @type {Event}
* @api
*/
this.originalEvent = originalEvent;