Merge pull request #11025 from ahocevar/no-more-mapbrowser-pointer-event

Get rid of MapBrowserPointerEvent
This commit is contained in:
Andreas Hocevar
2020-05-11 09:11:00 +02:00
committed by GitHub
27 changed files with 108 additions and 151 deletions

View File

@@ -7,25 +7,26 @@ import MapEvent from './MapEvent.js';
* @classdesc
* Events emitted as map browser events are instances of this type.
* See {@link module:ol/PluggableMap~PluggableMap} for which events trigger a map browser event.
* @template {UIEvent} EVENT
*/
class MapBrowserEvent extends MapEvent {
/**
* @param {string} type Event type.
* @param {import("./PluggableMap.js").default} map Map.
* @param {Event} browserEvent Browser event.
* @param {EVENT} originalEvent Original event.
* @param {boolean=} opt_dragging Is the map currently being dragged?
* @param {?import("./PluggableMap.js").FrameState=} opt_frameState Frame state.
*/
constructor(type, map, browserEvent, opt_dragging, opt_frameState) {
constructor(type, map, originalEvent, opt_dragging, opt_frameState) {
super(type, map, opt_frameState);
/**
* The original browser event.
* @const
* @type {Event}
* @type {EVENT}
* @api
*/
this.originalEvent = browserEvent;
this.originalEvent = originalEvent;
/**
* The map pixel relative to the viewport corresponding to the original browser event.
@@ -50,7 +51,7 @@ class MapBrowserEvent extends MapEvent {
}
/**
* The map pixel relative to the viewport corresponding to the original browser event.
* The map pixel relative to the viewport corresponding to the original event.
* @type {import("./pixel.js").Pixel}
* @api
*/

View File

@@ -5,8 +5,8 @@
import 'elm-pep';
import EventTarget from './events/Target.js';
import EventType from './events/EventType.js';
import MapBrowserEvent from './MapBrowserEvent.js';
import MapBrowserEventType from './MapBrowserEventType.js';
import MapBrowserPointerEvent from './MapBrowserPointerEvent.js';
import PointerEventType from './pointer/EventType.js';
import {DEVICE_PIXEL_RATIO, PASSIVE_EVENT_LISTENERS} from './has.js';
import {listen, unlistenByKey} from './events.js';
@@ -122,7 +122,7 @@ class MapBrowserEventHandler extends EventTarget {
* @private
*/
emulateClick_(pointerEvent) {
let newEvent = new MapBrowserPointerEvent(
let newEvent = new MapBrowserEvent(
MapBrowserEventType.CLICK,
this.map_,
pointerEvent
@@ -132,7 +132,7 @@ class MapBrowserEventHandler extends EventTarget {
// double-click
clearTimeout(this.clickTimeoutId_);
this.clickTimeoutId_ = undefined;
newEvent = new MapBrowserPointerEvent(
newEvent = new MapBrowserEvent(
MapBrowserEventType.DBLCLICK,
this.map_,
pointerEvent
@@ -143,7 +143,7 @@ class MapBrowserEventHandler extends EventTarget {
this.clickTimeoutId_ = setTimeout(
function () {
this.clickTimeoutId_ = undefined;
const newEvent = new MapBrowserPointerEvent(
const newEvent = new MapBrowserEvent(
MapBrowserEventType.SINGLECLICK,
this.map_,
pointerEvent
@@ -183,7 +183,7 @@ class MapBrowserEventHandler extends EventTarget {
*/
handlePointerUp_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
const newEvent = new MapBrowserEvent(
MapBrowserEventType.POINTERUP,
this.map_,
pointerEvent
@@ -229,7 +229,7 @@ class MapBrowserEventHandler extends EventTarget {
*/
handlePointerDown_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
const newEvent = new MapBrowserEvent(
MapBrowserEventType.POINTERDOWN,
this.map_,
pointerEvent
@@ -299,7 +299,7 @@ class MapBrowserEventHandler extends EventTarget {
// moved a significant distance.
if (this.isMoving_(pointerEvent)) {
this.dragging_ = true;
const newEvent = new MapBrowserPointerEvent(
const newEvent = new MapBrowserEvent(
MapBrowserEventType.POINTERDRAG,
this.map_,
pointerEvent,
@@ -311,7 +311,7 @@ class MapBrowserEventHandler extends EventTarget {
/**
* Wrap and relay a pointer event. Note that this requires that the type
* string for the MapBrowserPointerEvent matches the PointerEvent type.
* string for the MapBrowserEvent matches the PointerEvent type.
* @param {PointerEvent} pointerEvent Pointer
* event.
* @private
@@ -320,12 +320,7 @@ class MapBrowserEventHandler extends EventTarget {
this.originalPointerMoveEvent_ = pointerEvent;
const dragging = !!(this.down_ && this.isMoving_(pointerEvent));
this.dispatchEvent(
new MapBrowserPointerEvent(
pointerEvent.type,
this.map_,
pointerEvent,
dragging
)
new MapBrowserEvent(pointerEvent.type, this.map_, pointerEvent, dragging)
);
}

View File

@@ -1,29 +0,0 @@
/**
* @module ol/MapBrowserPointerEvent
*/
import MapBrowserEvent from './MapBrowserEvent.js';
/**
* @classdesc
* @api
*/
class MapBrowserPointerEvent extends MapBrowserEvent {
/**
* @param {string} type Event type.
* @param {import("./PluggableMap.js").default} map Map.
* @param {PointerEvent} pointerEvent Pointer event.
* @param {boolean=} opt_dragging Is the map currently being dragged?
* @param {?import("./PluggableMap.js").FrameState=} opt_frameState Frame state.
*/
constructor(type, map, pointerEvent, opt_dragging, opt_frameState) {
super(type, map, pointerEvent, opt_dragging, opt_frameState);
/**
* @const
* @type {PointerEvent}
*/
this.pointerEvent = pointerEvent;
}
}
export default MapBrowserPointerEvent;

View File

@@ -704,7 +704,7 @@ class PluggableMap extends BaseObject {
/**
* Returns the coordinate in user projection for a browser event.
* @param {Event} event Event.
* @param {MouseEvent} event Event.
* @return {import("./coordinate.js").Coordinate} Coordinate.
* @api
*/
@@ -714,7 +714,7 @@ class PluggableMap extends BaseObject {
/**
* Returns the coordinate in view projection for a browser event.
* @param {Event} event Event.
* @param {MouseEvent} event Event.
* @return {import("./coordinate.js").Coordinate} Coordinate.
*/
getEventCoordinateInternal(event) {
@@ -723,13 +723,14 @@ class PluggableMap extends BaseObject {
/**
* Returns the map pixel position for a browser event relative to the viewport.
* @param {Event|TouchEvent} event Event.
* @param {UIEvent} event Event.
* @return {import("./pixel.js").Pixel} Pixel.
* @api
*/
getEventPixel(event) {
const viewportPosition = this.viewport_.getBoundingClientRect();
const eventPosition =
//FIXME Are we really calling this with a TouchEvent anywhere?
'changedTouches' in event
? /** @type {TouchEvent} */ (event).changedTouches[0]
: /** @type {MouseEvent} */ (event);
@@ -998,7 +999,7 @@ class PluggableMap extends BaseObject {
}
/**
* @param {Event} browserEvent Browser event.
* @param {UIEvent} browserEvent Browser event.
* @param {string=} opt_type Type.
*/
handleBrowserEvent(browserEvent, opt_type) {

View File

@@ -148,7 +148,7 @@ class MousePosition extends Control {
}
/**
* @param {Event} event Browser event.
* @param {MouseEvent} event Browser event.
* @protected
*/
handleMouseMove(event) {

View File

@@ -243,7 +243,7 @@ class OverviewMap extends Control {
const move = function (event) {
const position = /** @type {?} */ (computeDesiredMousePosition(event));
const coordinates = ovmap.getEventCoordinateInternal(
/** @type {Event} */ (position)
/** @type {MouseEvent} */ (position)
);
overlay.setPosition(coordinates);

View File

@@ -210,8 +210,8 @@ export const targetNotEditable = function (mapBrowserEvent) {
* @api
*/
export const mouseOnly = function (mapBrowserEvent) {
const pointerEvent = /** @type {import("../MapBrowserPointerEvent").default} */ (mapBrowserEvent)
.pointerEvent;
const pointerEvent = /** @type {import("../MapBrowserEvent").default} */ (mapBrowserEvent)
.originalEvent;
assert(pointerEvent !== undefined, 56); // mapBrowserEvent must originate from a pointer event
// see http://www.w3.org/TR/pointerevents/#widl-PointerEvent-pointerType
return pointerEvent.pointerType == 'mouse';
@@ -225,8 +225,8 @@ export const mouseOnly = function (mapBrowserEvent) {
* @api
*/
export const touchOnly = function (mapBrowserEvent) {
const pointerEvt = /** @type {import("../MapBrowserPointerEvent").default} */ (mapBrowserEvent)
.pointerEvent;
const pointerEvt = /** @type {import("../MapBrowserEvent").default} */ (mapBrowserEvent)
.originalEvent;
assert(pointerEvt !== undefined, 56); // mapBrowserEvent must originate from a pointer event
// see http://www.w3.org/TR/pointerevents/#widl-PointerEvent-pointerType
return pointerEvt.pointerType === 'touch';
@@ -240,8 +240,8 @@ export const touchOnly = function (mapBrowserEvent) {
* @api
*/
export const penOnly = function (mapBrowserEvent) {
const pointerEvt = /** @type {import("../MapBrowserPointerEvent").default} */ (mapBrowserEvent)
.pointerEvent;
const pointerEvt = /** @type {import("../MapBrowserEvent").default} */ (mapBrowserEvent)
.originalEvent;
assert(pointerEvt !== undefined, 56); // mapBrowserEvent must originate from a pointer event
// see http://www.w3.org/TR/pointerevents/#widl-PointerEvent-pointerType
return pointerEvt.pointerType === 'pen';
@@ -257,8 +257,8 @@ export const penOnly = function (mapBrowserEvent) {
* @api
*/
export const primaryAction = function (mapBrowserEvent) {
const pointerEvent = /** @type {import("../MapBrowserPointerEvent").default} */ (mapBrowserEvent)
.pointerEvent;
const pointerEvent = /** @type {import("../MapBrowserEvent").default} */ (mapBrowserEvent)
.originalEvent;
assert(pointerEvent !== undefined, 56); // mapBrowserEvent must originate from a pointer event
return pointerEvent.isPrimary && pointerEvent.button === 0;
};

View File

@@ -16,7 +16,6 @@ export {default as Kinetic} from './Kinetic.js';
export {default as Map} from './Map.js';
export {default as MapBrowserEvent} from './MapBrowserEvent.js';
export {default as MapBrowserEventHandler} from './MapBrowserEventHandler.js';
export {default as MapBrowserPointerEvent} from './MapBrowserPointerEvent.js';
export {default as MapEvent} from './MapEvent.js';
export {default as Object} from './Object.js';
export {default as Observable} from './Observable.js';

View File

@@ -170,7 +170,7 @@ class DragBox extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
this.box_.setPixels(this.startPixel_, mapBrowserEvent.pixel);
@@ -186,7 +186,7 @@ class DragBox extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -213,7 +213,7 @@ class DragBox extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {

View File

@@ -87,7 +87,7 @@ class DragPan extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
if (!this.panning_) {
@@ -123,7 +123,7 @@ class DragPan extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -163,7 +163,7 @@ class DragPan extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {
@@ -192,7 +192,7 @@ class DragPan extends PointerInteraction {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Browser event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Browser event.
* @return {boolean} Combined condition result.
*/
function defaultCondition(mapBrowserEvent) {

View File

@@ -60,7 +60,7 @@ class DragRotate extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
if (!mouseOnly(mapBrowserEvent)) {
@@ -84,7 +84,7 @@ class DragRotate extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -100,7 +100,7 @@ class DragRotate extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {

View File

@@ -66,7 +66,7 @@ class DragRotateAndZoom extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
if (!mouseOnly(mapBrowserEvent)) {
@@ -97,7 +97,7 @@ class DragRotateAndZoom extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -115,7 +115,7 @@ class DragRotateAndZoom extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {

View File

@@ -8,8 +8,8 @@ import Feature from '../Feature.js';
import GeometryType from '../geom/GeometryType.js';
import InteractionProperty from './Property.js';
import LineString from '../geom/LineString.js';
import MapBrowserEvent from '../MapBrowserEvent.js';
import MapBrowserEventType from '../MapBrowserEventType.js';
import MapBrowserPointerEvent from '../MapBrowserPointerEvent.js';
import MultiLineString from '../geom/MultiLineString.js';
import MultiPoint from '../geom/MultiPoint.js';
import MultiPolygon from '../geom/MultiPolygon.js';
@@ -493,7 +493,7 @@ class Draw extends PointerInteraction {
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may actually draw or finish the drawing.
* @param {import("../MapBrowserPointerEvent.js").default} event Map browser event.
* @param {import("../MapBrowserEvent.js").default} event Map browser event.
* @return {boolean} `false` to stop event propagation.
* @api
*/
@@ -545,7 +545,7 @@ class Draw extends PointerInteraction {
event.preventDefault();
}
} else if (
event.pointerEvent.pointerType == 'mouse' ||
event.originalEvent.pointerType == 'mouse' ||
(event.type === MapBrowserEventType.POINTERDRAG &&
this.downTimeout_ === undefined)
) {
@@ -560,7 +560,7 @@ class Draw extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(event) {
@@ -577,10 +577,10 @@ class Draw extends PointerInteraction {
this.downTimeout_ = setTimeout(
function () {
this.handlePointerMove_(
new MapBrowserPointerEvent(
new MapBrowserEvent(
MapBrowserEventType.POINTERMOVE,
event.map,
event.pointerEvent,
event.originalEvent,
false,
event.frameState
)
@@ -598,7 +598,7 @@ class Draw extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(event) {

View File

@@ -276,11 +276,11 @@ class Extent extends PointerInteraction {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Map browser event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
*/
handleEvent(mapBrowserEvent) {
if (!mapBrowserEvent.pointerEvent) {
if (!mapBrowserEvent.originalEvent) {
return true;
}
//display pointer (if not dragging)
@@ -298,7 +298,7 @@ class Extent extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {
@@ -359,7 +359,7 @@ class Extent extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
if (this.pointerHandler_) {
@@ -371,7 +371,7 @@ class Extent extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {

View File

@@ -130,10 +130,10 @@ export class ModifyEvent extends Event {
* @param {ModifyEventType} type Type.
* @param {Collection<Feature>} features
* The features modified.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserPointerEvent
* Associated {@link module:ol/MapBrowserPointerEvent}.
* @param {import("../MapBrowserEvent.js").default} MapBrowserEvent
* Associated {@link module:ol/MapBrowserEvent}.
*/
constructor(type, features, mapBrowserPointerEvent) {
constructor(type, features, MapBrowserEvent) {
super(type);
/**
@@ -148,7 +148,7 @@ export class ModifyEvent extends Event {
* @type {import("../MapBrowserEvent.js").default}
* @api
*/
this.mapBrowserEvent = mapBrowserPointerEvent;
this.mapBrowserEvent = MapBrowserEvent;
}
}
@@ -350,7 +350,7 @@ class Modify extends PointerInteraction {
);
/**
* @type {import("../MapBrowserPointerEvent.js").default}
* @type {import("../MapBrowserEvent.js").default}
* @private
*/
this.lastPointerEvent_ = null;
@@ -376,7 +376,7 @@ class Modify extends PointerInteraction {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} evt Map browser event
* @param {import("../MapBrowserEvent.js").default} evt Map browser event
* @private
*/
willModifyFeatures_(evt) {
@@ -743,11 +743,11 @@ class Modify extends PointerInteraction {
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may modify the geometry.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Map browser event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
*/
handleEvent(mapBrowserEvent) {
if (!mapBrowserEvent.pointerEvent) {
if (!mapBrowserEvent.originalEvent) {
return true;
}
this.lastPointerEvent_ = mapBrowserEvent;
@@ -780,7 +780,7 @@ class Modify extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @param {import("../MapBrowserEvent.js").default} evt Event.
*/
handleDragEvent(evt) {
this.ignoreNextSingleClick_ = false;
@@ -874,7 +874,7 @@ class Modify extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(evt) {
@@ -977,7 +977,7 @@ class Modify extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(evt) {

View File

@@ -74,7 +74,7 @@ class PinchRotate extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
let rotationDelta = 0.0;
@@ -122,7 +122,7 @@ class PinchRotate extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -138,7 +138,7 @@ class PinchRotate extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {

View File

@@ -59,7 +59,7 @@ class PinchZoom extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
*/
handleDragEvent(mapBrowserEvent) {
let scaleDelta = 1.0;
@@ -98,7 +98,7 @@ class PinchZoom extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(mapBrowserEvent) {
@@ -115,7 +115,7 @@ class PinchZoom extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(mapBrowserEvent) {

View File

@@ -7,10 +7,10 @@ import {getValues} from '../obj.js';
/**
* @typedef {Object} Options
* @property {function(import("../MapBrowserPointerEvent.js").default):boolean} [handleDownEvent]
* @property {function(import("../MapBrowserEvent.js").default):boolean} [handleDownEvent]
* Function handling "down" events. If the function returns `true` then a drag
* sequence is started.
* @property {function(import("../MapBrowserPointerEvent.js").default)} [handleDragEvent]
* @property {function(import("../MapBrowserEvent.js").default)} [handleDragEvent]
* Function handling "drag" events. This function is called on "move" events
* during a drag sequence.
* @property {function(import("../MapBrowserEvent.js").default):boolean} [handleEvent]
@@ -18,13 +18,13 @@ import {getValues} from '../obj.js';
* dispatched to the map. The function may return `false` to prevent the
* propagation of the event to other interactions in the map's interactions
* chain.
* @property {function(import("../MapBrowserPointerEvent.js").default)} [handleMoveEvent]
* @property {function(import("../MapBrowserEvent.js").default)} [handleMoveEvent]
* Function handling "move" events. This function is called on "move" events.
* This functions is also called during a drag sequence, so during a drag
* sequence both the `handleDragEvent` function and this function are called.
* If `handleDownEvent` is defined and it returns true this function will not
* be called during a drag sequence.
* @property {function(import("../MapBrowserPointerEvent.js").default):boolean} [handleUpEvent]
* @property {function(import("../MapBrowserEvent.js").default):boolean} [handleUpEvent]
* Function handling "up" events. If the function returns `false` then the
* current drag sequence is stopped.
* @property {function(boolean):boolean} [stopDown]
@@ -105,7 +105,7 @@ class PointerInteraction extends Interaction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
* @protected
*/
@@ -115,7 +115,7 @@ class PointerInteraction extends Interaction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @protected
*/
handleDragEvent(mapBrowserEvent) {}
@@ -124,12 +124,12 @@ class PointerInteraction extends Interaction {
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may call into
* other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
* detected.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Map browser event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
* @api
*/
handleEvent(mapBrowserEvent) {
if (!mapBrowserEvent.pointerEvent) {
if (!mapBrowserEvent.originalEvent) {
return true;
}
@@ -159,14 +159,14 @@ class PointerInteraction extends Interaction {
/**
* Handle pointer move events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @protected
*/
handleMoveEvent(mapBrowserEvent) {}
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} If the event was consumed.
* @protected
*/
@@ -185,12 +185,12 @@ class PointerInteraction extends Interaction {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @private
*/
updateTrackedPointers_(mapBrowserEvent) {
if (isPointerDraggingEvent(mapBrowserEvent)) {
const event = mapBrowserEvent.pointerEvent;
const event = mapBrowserEvent.originalEvent;
const id = event.pointerId.toString();
if (mapBrowserEvent.type == MapBrowserEventType.POINTERUP) {
@@ -222,7 +222,7 @@ export function centroid(pointerEvents) {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Event.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Event.
* @return {boolean} Whether the event is a pointerdown, pointerdrag
* or pointerup event.
*/

View File

@@ -259,7 +259,7 @@ class Snap extends PointerInteraction {
}
/**
* @param {import("../MapBrowserPointerEvent.js").default} evt Map browser event.
* @param {import("../MapBrowserEvent.js").default} evt Map browser event.
* @return {boolean} `false` to stop event propagation.
*/
handleEvent(evt) {
@@ -307,7 +307,7 @@ class Snap extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(evt) {

View File

@@ -189,7 +189,7 @@ class Translate extends PointerInteraction {
/**
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(event) {
@@ -217,7 +217,7 @@ class Translate extends PointerInteraction {
/**
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(event) {
@@ -245,7 +245,7 @@ class Translate extends PointerInteraction {
/**
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
*/
handleDragEvent(event) {
if (this.lastCoordinate_) {
@@ -277,7 +277,7 @@ class Translate extends PointerInteraction {
/**
* Handle pointer move events.
* @param {import("../MapBrowserPointerEvent.js").default} event Event.
* @param {import("../MapBrowserEvent.js").default} event Event.
*/
handleMoveEvent(event) {
const elem = event.map.getViewport();