111 lines
2.8 KiB
JavaScript
111 lines
2.8 KiB
JavaScript
/**
|
|
* @module ol/MapBrowserEvent
|
|
*/
|
|
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.
|
|
*/
|
|
class MapBrowserEvent extends MapEvent {
|
|
|
|
/**
|
|
* @param {string} type Event type.
|
|
* @param {import("./PluggableMap.js").default} map Map.
|
|
* @param {Event} browserEvent Browser 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) {
|
|
|
|
super(type, map, opt_frameState);
|
|
|
|
/**
|
|
* The original browser event.
|
|
* @const
|
|
* @type {Event}
|
|
* @api
|
|
*/
|
|
this.originalEvent = browserEvent;
|
|
|
|
/**
|
|
* The map pixel relative to the viewport corresponding to the original browser event.
|
|
* @type {?import("./pixel.js").Pixel}
|
|
*/
|
|
this.pixel_ = null;
|
|
|
|
/**
|
|
* The coordinate in the user projection corresponding to the original browser event.
|
|
* @type {?import("./coordinate.js").Coordinate}
|
|
*/
|
|
this.coordinate_ = null;
|
|
|
|
/**
|
|
* Indicates if the map is currently being dragged. Only set for
|
|
* `POINTERDRAG` and `POINTERMOVE` events. Default is `false`.
|
|
*
|
|
* @type {boolean}
|
|
* @api
|
|
*/
|
|
this.dragging = opt_dragging !== undefined ? opt_dragging : false;
|
|
|
|
}
|
|
|
|
/**
|
|
* The map pixel relative to the viewport corresponding to the original browser event.
|
|
* @type {import("./pixel.js").Pixel}
|
|
* @api
|
|
*/
|
|
get pixel() {
|
|
if (!this.pixel_) {
|
|
this.pixel_ = this.map.getEventPixel(this.originalEvent);
|
|
}
|
|
return this.pixel_;
|
|
}
|
|
set pixel(pixel) {
|
|
this.pixel_ = pixel;
|
|
}
|
|
|
|
/**
|
|
* The coordinate corresponding to the original browser event. This will be in the user
|
|
* projection if one is set. Otherwise it will be in the view projection.
|
|
* @type {import("./coordinate.js").Coordinate}
|
|
* @api
|
|
*/
|
|
get coordinate() {
|
|
if (!this.coordinate_) {
|
|
this.coordinate_ = this.map.getCoordinateFromPixel(this.pixel);
|
|
}
|
|
return this.coordinate_;
|
|
}
|
|
set coordinate(coordinate) {
|
|
this.coordinate_ = coordinate;
|
|
}
|
|
|
|
/**
|
|
* Prevents the default browser action.
|
|
* See https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault.
|
|
* @override
|
|
* @api
|
|
*/
|
|
preventDefault() {
|
|
super.preventDefault();
|
|
this.originalEvent.preventDefault();
|
|
}
|
|
|
|
/**
|
|
* Prevents further propagation of the current event.
|
|
* See https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation.
|
|
* @override
|
|
* @api
|
|
*/
|
|
stopPropagation() {
|
|
super.stopPropagation();
|
|
this.originalEvent.stopPropagation();
|
|
}
|
|
}
|
|
|
|
|
|
export default MapBrowserEvent;
|