@mapgis/mapbox-gl 16.0.0 → 16.2.0

package/src/ui/events.js

@@ -1,806 +0,0 @@
-// @flow
-
-import {Event} from '../util/evented';
-
-import DOM from '../util/dom';
-import Point from '@mapbox/point-geometry';
-import {extend} from '../util/util';
-
-import type Map from './map';
-import type LngLat from '../geo/lng_lat';
-
-/**
- * `MapMouseEvent` is the event type for mouse-related map events.
- * @extends {Object}
- */
-export class MapMouseEvent extends Event {
-    /**
-     * The event type.
-     */
-    type: 'mousedown'
-        | 'mouseup'
-        | 'click'
-        | 'dblclick'
-        | 'mousemove'
-        | 'mouseover'
-        | 'mouseenter'
-        | 'mouseleave'
-        | 'mouseout'
-        | 'contextmenu';
-
-    /**
-     * The `Map` object that fired the event.
-     */
-    target: Map;
-
-    /**
-     * The DOM event which caused the map event.
-     */
-    originalEvent: MouseEvent;
-
-    /**
-     * The pixel coordinates of the mouse cursor, relative to the map and measured from the top left corner.
-     */
-    point: Point;
-
-    /**
-     * The geographic location on the map of the mouse cursor.
-     */
-    lngLat: LngLat;
-
-    /**
-     * Prevents subsequent default processing of the event by the map.
-     *
-     * Calling this method will prevent the following default map behaviors:
-     *
-     *   * On `mousedown` events, the behavior of {@link DragPanHandler}
-     *   * On `mousedown` events, the behavior of {@link DragRotateHandler}
-     *   * On `mousedown` events, the behavior of {@link BoxZoomHandler}
-     *   * On `dblclick` events, the behavior of {@link DoubleClickZoomHandler}
-     *
-     */
-    preventDefault() {
-        this._defaultPrevented = true;
-    }
-
-    /**
-     * `true` if `preventDefault` has been called.
-     * @private
-     */
-    get defaultPrevented(): boolean {
-        return this._defaultPrevented;
-    }
-
-    _defaultPrevented: boolean;
-
-    /**
-     * @private
-     */
-    constructor(type: string, map: Map, originalEvent: MouseEvent, data: Object = {}) {
-        const point = DOM.mousePos(map.getCanvasContainer(), originalEvent);
-        const lngLat = map.unproject(point);
-        super(type, extend({point, lngLat, originalEvent}, data));
-        this._defaultPrevented = false;
-        this.target = map;
-    }
-}
-
-/**
- * `MapTouchEvent` is the event type for touch-related map events.
- * @extends {Object}
- */
-export class MapTouchEvent extends Event {
-    /**
-     * The event type.
-     */
-    type: 'touchstart'
-        | 'touchend'
-        | 'touchcancel';
-
-    /**
-     * The `Map` object that fired the event.
-     */
-    target: Map;
-
-    /**
-     * The DOM event which caused the map event.
-     */
-    originalEvent: TouchEvent;
-
-    /**
-     * The geographic location on the map of the center of the touch event points.
-     */
-    lngLat: LngLat;
-
-    /**
-     * The pixel coordinates of the center of the touch event points, relative to the map and measured from the top left
-     * corner.
-     */
-    point: Point;
-
-    /**
-     * The array of pixel coordinates corresponding to a
-     * [touch event's `touches`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/touches) property.
-     */
-    points: Array<Point>;
-
-    /**
-     * The geographical locations on the map corresponding to a
-     * [touch event's `touches`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/touches) property.
-     */
-    lngLats: Array<LngLat>;
-
-    /**
-     * Prevents subsequent default processing of the event by the map.
-     *
-     * Calling this method will prevent the following default map behaviors:
-     *
-     *   * On `touchstart` events, the behavior of {@link DragPanHandler}
-     *   * On `touchstart` events, the behavior of {@link TouchZoomRotateHandler}
-     *
-     */
-    preventDefault() {
-        this._defaultPrevented = true;
-    }
-
-    /**
-     * `true` if `preventDefault` has been called.
-     * @private
-     */
-    get defaultPrevented(): boolean {
-        return this._defaultPrevented;
-    }
-
-    _defaultPrevented: boolean;
-
-    /**
-     * @private
-     */
-    constructor(type: string, map: Map, originalEvent: TouchEvent) {
-        const points = DOM.touchPos(map.getCanvasContainer(), originalEvent);
-        const lngLats = points.map((t) => map.unproject(t));
-        const point = points.reduce((prev, curr, i, arr) => {
-            return prev.add(curr.div(arr.length));
-        }, new Point(0, 0));
-        const lngLat = map.unproject(point);
-        super(type, {points, point, lngLats, lngLat, originalEvent});
-        this._defaultPrevented = false;
-    }
-}
-
-/**
- * `MapWheelEvent` is the event type for the `wheel` map event.
- * @extends {Object}
- */
-export class MapWheelEvent extends Event {
-    /**
-     * The event type.
-     */
-    type: 'wheel';
-
-    /**
-     * The `Map` object that fired the event.
-     */
-    target: Map;
-
-    /**
-     * The DOM event which caused the map event.
-     */
-    originalEvent: WheelEvent;
-
-    /**
-     * Prevents subsequent default processing of the event by the map.
-     *
-     * Calling this method will prevent the the behavior of {@link ScrollZoomHandler}.
-     */
-    preventDefault() {
-        this._defaultPrevented = true;
-    }
-
-    /**
-     * `true` if `preventDefault` has been called.
-     * @private
-     */
-    get defaultPrevented(): boolean {
-        return this._defaultPrevented;
-    }
-
-    _defaultPrevented: boolean;
-
-    /**
-     * @private
-     */
-    constructor(type: string, map: Map, originalEvent: WheelEvent) {
-        super(type, {originalEvent});
-        this._defaultPrevented = false;
-    }
-}
-
-/**
- * A `MapBoxZoomEvent` is the event type for boxzoom-related map events.
- * `originalEvent` can be a {@link Map.event:click} when the zoom is triggered by a UI event.
- *
- * @typedef {Object} MapBoxZoomEvent
- * @property {MouseEvent} originalEvent
- */
-export type MapBoxZoomEvent = {
-    type: 'boxzoomstart'
-        | 'boxzoomend'
-        | 'boxzoomcancel',
-    map: Map,
-    originalEvent: MouseEvent
-};
-
-/**
- * A `MapDataEvent` object is emitted with the {@link Map.event:data}
- * and {@link Map.event:dataloading} events. Possible values for
- * `dataType`s are:
- *
- * - `'source'`: The non-tile data associated with any source
- * - `'style'`: The [style](https://www.mapbox.com/mapbox-gl-style-spec/) used by the map
- *
- * @typedef {Object} MapDataEvent
- * @property {string} type The event type.
- * @property {string} dataType The type of data that has changed. One of `'source'`, `'style'`.
- * @property {boolean} [isSourceLoaded] True if the event has a `dataType` of `source` and the source has no outstanding network requests.
- * @property {Object} [source] The [style spec representation of the source](https://www.mapbox.com/mapbox-gl-style-spec/#sources) if the event has a `dataType` of `source`.
- * @property {string} [sourceDataType] Included if the event has a `dataType` of `source` and the event signals
- * that internal data has been received or changed. Possible values are `metadata` and `content`.
- * @property {Object} [tile] The tile being loaded or changed, if the event has a `dataType` of `source` and
- * the event is related to loading of a tile.
- * @property {Coordinate} [coord] The coordinate of the tile if the event has a `dataType` of `source` and
- * the event is related to loading of a tile.
- */
-export type MapDataEvent = {
-    type: string,
-    dataType: string
-};
-
-export type MapContextEvent = {
-    type: 'webglcontextlost' | 'webglcontextrestored',
-    originalEvent: WebGLContextEvent
-}
-
-export type MapEvent =
-    /**
-     * Fired when a pointing device (usually a mouse) is pressed within the map.
-     *
-     * @event mousedown
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Highlight features within a bounding box](https://www.mapbox.com/mapbox-gl-js/example/using-box-queryrenderedfeatures/)
-     * @see [Create a draggable point](https://www.mapbox.com/mapbox-gl-js/example/drag-a-point/)
-     */
-    | 'mousedown'
-
-    /**
-     * Fired when a pointing device (usually a mouse) is released within the map.
-     *
-     * @event mouseup
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Highlight features within a bounding box](https://www.mapbox.com/mapbox-gl-js/example/using-box-queryrenderedfeatures/)
-     * @see [Create a draggable point](https://www.mapbox.com/mapbox-gl-js/example/drag-a-point/)
-     */
-    | 'mouseup'
-
-    /**
-     * Fired when a pointing device (usually a mouse) is moved within the map.
-     *
-     * @event mouseover
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Get coordinates of the mouse pointer](https://www.mapbox.com/mapbox-gl-js/example/mouse-position/)
-     * @see [Highlight features under the mouse pointer](https://www.mapbox.com/mapbox-gl-js/example/hover-styles/)
-     * @see [Display a popup on hover](https://www.mapbox.com/mapbox-gl-js/example/popup-on-hover/)
-     */
-    | 'mouseover'
-
-    /**
-     * Fired when a pointing device (usually a mouse) is moved within the map.
-     *
-     * @event mousemove
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Get coordinates of the mouse pointer](https://www.mapbox.com/mapbox-gl-js/example/mouse-position/)
-     * @see [Highlight features under the mouse pointer](https://www.mapbox.com/mapbox-gl-js/example/hover-styles/)
-     * @see [Display a popup on over](https://www.mapbox.com/mapbox-gl-js/example/popup-on-hover/)
-     */
-    | 'mousemove'
-
-    /**
-     * Fired when a pointing device (usually a mouse) is pressed and released at the same point on the map.
-     *
-     * @event click
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Measure distances](https://www.mapbox.com/mapbox-gl-js/example/measure/)
-     * @see [Center the map on a clicked symbol](https://www.mapbox.com/mapbox-gl-js/example/center-on-symbol/)
-     */
-    | 'click'
-
-    /**
-     * Fired when a pointing device (usually a mouse) is clicked twice at the same point on the map.
-     *
-     * @event dblclick
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     */
-    | 'dblclick'
-
-    /**
-     * Fired when a pointing device (usually a mouse) enters a visible portion of a specified layer from
-     * outside that layer or outside the map canvas. This event can only be listened for via the three-argument
-     * version of {@link Map#on}, where the second argument specifies the desired layer.
-     *
-     * @event mouseenter
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     */
-    | 'mouseenter'
-
-    /**
-     * Fired when a pointing device (usually a mouse) leaves a visible portion of a specified layer, or leaves
-     * the map canvas. This event can only be listened for via the three-argument version of {@link Map#on},
-     * where the second argument specifies the desired layer.
-     *
-     * @event mouseleave
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     * @see [Highlight features under the mouse pointer](https://www.mapbox.com/mapbox-gl-js/example/hover-styles/)
-     */
-    | 'mouseleave'
-
-    /**
-     * Fired when a point device (usually a mouse) leaves the map's canvas.
-     *
-     * @event mouseout
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     */
-    | 'mouseout'
-
-    /**
-     * Fired when the right button of the mouse is clicked or the context menu key is pressed within the map.
-     *
-     * @event contextmenu
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent} data
-     */
-    | 'contextmenu'
-
-    /**
-     * Fired when a [`wheel`](https://developer.mozilla.org/en-US/docs/Web/Events/wheel) event occurs within the map.
-     *
-     * @event wheel
-     * @memberof Map
-     * @instance
-     * @property {MapWheelEvent} data
-     */
-    | 'wheel'
-
-    /**
-     * Fired when a [`touchstart`](https://developer.mozilla.org/en-US/docs/Web/Events/touchstart) event occurs within the map.
-     *
-     * @event touchstart
-     * @memberof Map
-     * @instance
-     * @property {MapTouchEvent} data
-     */
-    | 'touchstart'
-
-    /**
-     * Fired when a [`touchend`](https://developer.mozilla.org/en-US/docs/Web/Events/touchend) event occurs within the map.
-     *
-     * @event touchend
-     * @memberof Map
-     * @instance
-     * @property {MapTouchEvent} data
-     */
-    | 'touchend'
-
-    /**
-     * Fired when a [`touchmove`](https://developer.mozilla.org/en-US/docs/Web/Events/touchmove) event occurs within the map.
-     *
-     * @event touchmove
-     * @memberof Map
-     * @instance
-     * @property {MapTouchEvent} data
-     */
-    | 'touchmove'
-
-    /**
-     * Fired when a [`touchcancel`](https://developer.mozilla.org/en-US/docs/Web/Events/touchcancel) event occurs within the map.
-     *
-     * @event touchcancel
-     * @memberof Map
-     * @instance
-     * @property {MapTouchEvent} data
-     */
-    | 'touchcancel'
-
-    /**
-     * Fired just before the map begins a transition from one
-     * view to another, as the result of either user interaction or methods such as {@link Map#jumpTo}.
-     *
-     * @event movestart
-     * @memberof Map
-     * @instance
-     * @property {{originalEvent: DragEvent}} data
-     */
-    | 'movestart'
-
-    /**
-     * Fired repeatedly during an animated transition from one view to
-     * another, as the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event move
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'move'
-
-    /**
-     * Fired just after the map completes a transition from one
-     * view to another, as the result of either user interaction or methods such as {@link Map#jumpTo}.
-     *
-     * @event moveend
-     * @memberof Map
-     * @instance
-     * @property {{originalEvent: DragEvent}} data
-     * @see [Play map locations as a slideshow](https://www.mapbox.com/mapbox-gl-js/example/playback-locations/)
-     * @see [Filter features within map view](https://www.mapbox.com/mapbox-gl-js/example/filter-features-within-map-view/)
-     */
-    | 'moveend'
-
-    /**
-     * Fired when a "drag to pan" interaction starts. See {@link DragPanHandler}.
-     *
-     * @event dragstart
-     * @memberof Map
-     * @instance
-     * @property {{originalEvent: DragEvent}} data
-     */
-    | 'dragstart'
-
-    /**
-     * Fired repeatedly during a "drag to pan" interaction. See {@link DragPanHandler}.
-     *
-     * @event drag
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'drag'
-
-    /**
-     * Fired when a "drag to pan" interaction ends. See {@link DragPanHandler}.
-     *
-     * @event dragend
-     * @memberof Map
-     * @instance
-     * @property {{originalEvent: DragEvent}} data
-     */
-    | 'dragend'
-
-    /**
-     * Fired just before the map begins a transition from one zoom level to another,
-     * as the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event zoomstart
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'zoomstart'
-
-    /**
-     * Fired repeatedly during an animated transition from one zoom level to another,
-     * as the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event zoom
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     * @see [Update a choropleth layer by zoom level](https://www.mapbox.com/mapbox-gl-js/example/updating-choropleth/)
-     */
-    | 'zoom'
-
-    /**
-     * Fired just after the map completes a transition from one zoom level to another,
-     * as the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event zoomend
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'zoomend'
-
-    /**
-     * Fired when a "drag to rotate" interaction starts. See {@link DragRotateHandler}.
-     *
-     * @event rotatestart
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'rotatestart'
-
-    /**
-     * Fired repeatedly during a "drag to rotate" interaction. See {@link DragRotateHandler}.
-     *
-     * @event rotate
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'rotate'
-
-    /**
-     * Fired when a "drag to rotate" interaction ends. See {@link DragRotateHandler}.
-     *
-     * @event rotateend
-     * @memberof Map
-     * @instance
-     * @property {MapMouseEvent | MapTouchEvent} data
-     */
-    | 'rotateend'
-
-    /**
-     * Fired whenever the map's pitch (tilt) begins a change as
-     * the result of either user interaction or methods such as {@link Map#flyTo} .
-     *
-     * @event pitchstart
-     * @memberof Map
-     * @instance
-     * @property {MapEventData} data
-     */
-    | 'pitchstart'
-
-    /**
-     * Fired whenever the map's pitch (tilt) changes as
-     * the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event pitch
-     * @memberof Map
-     * @instance
-     * @property {MapEventData} data
-     */
-    | 'pitch'
-
-    /**
-     * Fired immediately after the map's pitch (tilt) finishes changing as
-     * the result of either user interaction or methods such as {@link Map#flyTo}.
-     *
-     * @event pitchend
-     * @memberof Map
-     * @instance
-     * @property {MapEventData} data
-     */
-    | 'pitchend'
-
-    /**
-     * Fired when a "box zoom" interaction starts. See {@link BoxZoomHandler}.
-     *
-     * @event boxzoomstart
-     * @memberof Map
-     * @instance
-     * @property {MapBoxZoomEvent} data
-     */
-    | 'boxzoomstart'
-
-    /**
-     * Fired when a "box zoom" interaction ends.  See {@link BoxZoomHandler}.
-     *
-     * @event boxzoomend
-     * @memberof Map
-     * @instance
-     * @type {Object}
-     * @property {MapBoxZoomEvent} data
-     */
-    | 'boxzoomend'
-
-    /**
-     * Fired when the user cancels a "box zoom" interaction, or when the bounding box does not meet the minimum size threshold.
-     * See {@link BoxZoomHandler}.
-     *
-     * @event boxzoomcancel
-     * @memberof Map
-     * @instance
-     * @property {MapBoxZoomEvent} data
-     */
-    | 'boxzoomcancel'
-
-    /**
-     * Fired immediately after the map has been resized.
-     *
-     * @event resize
-     * @memberof Map
-     * @instance
-     */
-    | 'resize'
-
-    /**
-     * Fired when the WebGL context is lost.
-     *
-     * @event webglcontextlost
-     * @memberof Map
-     * @instance
-     */
-    | 'webglcontextlost'
-
-    /**
-     * Fired when the WebGL context is restored.
-     *
-     * @event webglcontextrestored
-     * @memberof Map
-     * @instance
-     */
-    | 'webglcontextrestored'
-
-    /**
-     * Fired immediately after all necessary resources have been downloaded
-     * and the first visually complete rendering of the map has occurred.
-     *
-     * @event load
-     * @memberof Map
-     * @instance
-     * @type {Object}
-     * @see [Draw GeoJSON points](https://www.mapbox.com/mapbox-gl-js/example/geojson-markers/)
-     * @see [Add live realtime data](https://www.mapbox.com/mapbox-gl-js/example/live-geojson/)
-     * @see [Animate a point](https://www.mapbox.com/mapbox-gl-js/example/animate-point-along-line/)
-     */
-    | 'load'
-
-    /**
-     * Fired whenever the map is drawn to the screen, as the result of
-     *
-     * - a change to the map's position, zoom, pitch, or bearing
-     * - a change to the map's style
-     * - a change to a GeoJSON source
-     * - the loading of a vector tile, GeoJSON file, glyph, or sprite
-     *
-     * @event render
-     * @memberof Map
-     * @instance
-     */
-    | 'render'
-
-    /**
-     * Fired after the last frame rendered before the map enters an
-     * "idle" state:
-     *
-     * - No camera transitions are in progress
-     * - All currently requested tiles have loaded
-     * - All fade/transition animations have completed
-     *
-     * @event idle
-     * @memberof Map
-     * @instance
-     */
-    | 'idle'
-
-    /**
-     * Fired immediately after the map has been removed with {@link Map.event:remove}.
-     *
-     * @event remove
-     * @memberof Map
-     * @instance
-     */
-    | 'remove'
-
-    /**
-     * Fired when an error occurs. This is GL JS's primary error reporting
-     * mechanism. We use an event instead of `throw` to better accommodate
-     * asyncronous operations. If no listeners are bound to the `error` event, the
-     * error will be printed to the console.
-     *
-     * @event error
-     * @memberof Map
-     * @instance
-     * @property {{error: {message: string}}} data
-     */
-    | 'error'
-
-    /**
-     * Fired when any map data loads or changes. See {@link MapDataEvent}
-     * for more information.
-     *
-     * @event data
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'data'
-
-    /**
-     * Fired when the map's style loads or changes. See
-     * {@link MapDataEvent} for more information.
-     *
-     * @event styledata
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'styledata'
-
-    /**
-     * Fired when one of the map's sources loads or changes, including if a tile belonging
-     * to a source loads or changes. See {@link MapDataEvent} for more information.
-     *
-     * @event sourcedata
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'sourcedata'
-
-    /**
-     * Fired when any map data (style, source, tile, etc) begins loading or
-     * changing asyncronously. All `dataloading` events are followed by a `data`
-     * or `error` event. See {@link MapDataEvent} for more information.
-     *
-     * @event dataloading
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'dataloading'
-
-    /**
-     * Fired when the map's style begins loading or changing asyncronously.
-     * All `styledataloading` events are followed by a `styledata`
-     * or `error` event. See {@link MapDataEvent} for more information.
-     *
-     * @event styledataloading
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'styledataloading'
-
-    /**
-     * Fired when one of the map's sources begins loading or changing asyncronously.
-     * All `sourcedataloading` events are followed by a `sourcedata` or `error` event.
-     * See {@link MapDataEvent} for more information.
-     *
-     * @event sourcedataloading
-     * @memberof Map
-     * @instance
-     * @property {MapDataEvent} data
-     */
-    | 'sourcedataloading'
-
-    /**
-     * Fired when an icon or pattern needed by the style is missing. The missing image can
-     * be added with {@link Map#addImage} within this event listener callback to prevent the image from
-     * being skipped. This event can be used to dynamically generate icons and patterns.
-     *
-     * @event styleimagemissing
-     * @memberof Map
-     * @instance
-     * @property {string} id The id of the missing image.
-     *
-     * @see [Generate and add a missing icon to the map](https://mapbox.com/mapbox-gl-js/example/add-image-missing-generated/)
-     */
-    | 'styleimagemissing'
-
-    /**
-     * @event style.load
-     * @memberof Map
-     * @instance
-     * @private
-     */
-    | 'style.load';