66 lines
2.5 KiB
TypeScript
66 lines
2.5 KiB
TypeScript
export default MapBrowserEvent;
|
|
/**
|
|
* @classdesc
|
|
* Events emitted as map browser events are instances of this type.
|
|
* See {@link module:ol/Map~Map} for which events trigger a map browser event.
|
|
* @template {PointerEvent|KeyboardEvent|WheelEvent} [EVENT=PointerEvent|KeyboardEvent|WheelEvent]
|
|
*/
|
|
declare class MapBrowserEvent<EVENT extends PointerEvent | KeyboardEvent | WheelEvent = KeyboardEvent | WheelEvent | PointerEvent> extends MapEvent {
|
|
/**
|
|
* @param {string} type Event type.
|
|
* @param {import("./Map.js").default} map Map.
|
|
* @param {EVENT} originalEvent Original event.
|
|
* @param {boolean} [dragging] Is the map currently being dragged?
|
|
* @param {import("./Map.js").FrameState} [frameState] Frame state.
|
|
* @param {Array<PointerEvent>} [activePointers] Active pointers.
|
|
*/
|
|
constructor(type: string, map: import("./Map.js").default, originalEvent: EVENT, dragging?: boolean, frameState?: import("./Map.js").FrameState, activePointers?: Array<PointerEvent>);
|
|
/**
|
|
* 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}
|
|
* @private
|
|
*/
|
|
private pixel_;
|
|
/**
|
|
* The coordinate in the user projection corresponding to the original browser event.
|
|
* @type {?import("./coordinate.js").Coordinate}
|
|
* @private
|
|
*/
|
|
private coordinate_;
|
|
/**
|
|
* Indicates if the map is currently being dragged. Only set for
|
|
* `POINTERDRAG` and `POINTERMOVE` events. Default is `false`.
|
|
*
|
|
* @type {boolean}
|
|
* @api
|
|
*/
|
|
dragging: boolean;
|
|
/**
|
|
* @type {Array<PointerEvent>|undefined}
|
|
*/
|
|
activePointers: Array<PointerEvent> | undefined;
|
|
set pixel(pixel: import("./pixel.js").Pixel);
|
|
/**
|
|
* The map pixel relative to the viewport corresponding to the original event.
|
|
* @type {import("./pixel.js").Pixel}
|
|
* @api
|
|
*/
|
|
get pixel(): import("./pixel.js").Pixel;
|
|
set coordinate(coordinate: import("./coordinate.js").Coordinate);
|
|
/**
|
|
* 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(): import("./coordinate.js").Coordinate;
|
|
}
|
|
import MapEvent from './MapEvent.js';
|
|
//# sourceMappingURL=MapBrowserEvent.d.ts.map
|