Files
openlayers/src/ol/MapEvent.js

40 lines
919 B
JavaScript

/**
* @module ol/MapEvent
*/
import {inherits} from './util.js';
import Event from './events/Event.js';
/**
* @classdesc
* Events emitted as map events are instances of this type.
* See {@link module:ol/Map~Map} for which events trigger a map event.
*
* @constructor
* @extends {module:ol/events/Event}
* @param {string} type Event type.
* @param {module:ol/PluggableMap} map Map.
* @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
*/
const MapEvent = function(type, map, opt_frameState) {
Event.call(this, type);
/**
* The map where the event occurred.
* @type {module:ol/PluggableMap}
* @api
*/
this.map = map;
/**
* The frame state at the time of the event.
* @type {?module:ol/PluggableMap~FrameState}
* @api
*/
this.frameState = opt_frameState !== undefined ? opt_frameState : null;
};
inherits(MapEvent, Event);
export default MapEvent;