Files
openlayers/src/ol/MapEvent.js
2017-12-15 16:17:56 +01:00

41 lines
878 B
JavaScript

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