ol/MapBrowserEvent.d.ts

OpenLayers mapping library

export default MapBrowserEvent;
/**
 * @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.
 */
declare 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: string, map: import("./PluggableMap.js").default, browserEvent: Event, opt_dragging?: boolean, opt_frameState?: import("./PluggableMap.js").FrameState);
    /**
     * The original browser event.
     * @const
     * @type {Event}
     * @api
     */
    originalEvent: Event;
    /**
     * The map pixel relative to the viewport corresponding to the original browser event.
     * @type {?import("./pixel.js").Pixel}
     */
    pixel_: import("./pixel.js").Pixel | null;
    /**
     * The coordinate in the user projection corresponding to the original browser event.
     * @type {?import("./coordinate.js").Coordinate}
     */
    coordinate_: import("./coordinate.js").Coordinate | null;
    /**
     * Indicates if the map is currently being dragged. Only set for
     * `POINTERDRAG` and `POINTERMOVE` events. Default is `false`.
     *
     * @type {boolean}
     * @api
     */
    dragging: boolean;
    set pixel(arg: number[]);
    /**
     * The map pixel relative to the viewport corresponding to the original browser event.
     * @type {import("./pixel.js").Pixel}
     * @api
     */
    get pixel(): number[];
    set coordinate(arg: number[]);
    /**
     * 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(): number[];
}
import MapEvent from "./MapEvent.js";
//# sourceMappingURL=MapBrowserEvent.d.ts.map