Module type for ol.events.Event

This commit is contained in:
Frederic Junod
2018-03-19 11:57:48 +01:00
parent 93b2fe0e95
commit 857b946f3e
17 changed files with 22 additions and 22 deletions

View File

@@ -44,7 +44,7 @@ const DragAndDropEventType = {
* of this type.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.interaction.DragAndDropEvent}
* @param {module:ol/interaction/DragAndDrop~DragAndDropEventType} type Type.
* @param {File} file File.

View File

@@ -89,7 +89,7 @@ LayerGroup.prototype.handleLayerChange_ = function() {
/**
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
* @private
*/
LayerGroup.prototype.handleLayersChanged_ = function(event) {

View File

@@ -41,7 +41,7 @@ import Event from '../events/Event.js';
* touch events and even native pointer events.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @param {string} type The type of the event to create.
* @param {Event} originalEvent The event.
* @param {Object.<string, ?>=} opt_eventDict An optional dictionary of

View File

@@ -6,7 +6,7 @@ import Event from '../events/Event.js';
/**
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.render.Event}
* @param {ol.render.EventType} type Type.
* @param {ol.render.VectorContext=} opt_vectorContext Vector context.

View File

@@ -91,7 +91,7 @@ LayerRenderer.prototype.getLayer = function() {
/**
* Handle changes in image state.
* @param {ol.events.Event} event Image change event.
* @param {module:ol/events/Event~Event} event Image change event.
* @private
*/
LayerRenderer.prototype.handleImageChange_ = function(event) {

View File

@@ -273,7 +273,7 @@ CanvasVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordi
/**
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
*/
CanvasVectorLayerRenderer.prototype.handleFontsChanged_ = function(event) {
const layer = this.getLayer();
@@ -285,7 +285,7 @@ CanvasVectorLayerRenderer.prototype.handleFontsChanged_ = function(event) {
/**
* Handle changes in image style state.
* @param {ol.events.Event} event Image style change event.
* @param {module:ol/events/Event~Event} event Image style change event.
* @private
*/
CanvasVectorLayerRenderer.prototype.handleStyleImageChange_ = function(event) {

View File

@@ -339,7 +339,7 @@ CanvasVectorTileLayerRenderer.prototype.getReplayTransform_ = function(tile, fra
/**
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
*/
CanvasVectorTileLayerRenderer.prototype.handleFontsChanged_ = function(event) {
const layer = this.getLayer();
@@ -351,7 +351,7 @@ CanvasVectorTileLayerRenderer.prototype.handleFontsChanged_ = function(event) {
/**
* Handle changes in image style state.
* @param {ol.events.Event} event Image style change event.
* @param {module:ol/events/Event~Event} event Image style change event.
* @private
*/
CanvasVectorTileLayerRenderer.prototype.handleStyleImageChange_ = function(event) {

View File

@@ -91,7 +91,7 @@ function renderCircleGeometry(replayGroup, geometry, style, feature) {
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {ol.style.Style} style Style.
* @param {number} squaredTolerance Squared tolerance.
* @param {function(this: T, ol.events.Event)} listener Listener function.
* @param {function(this: T, module:ol/events/Event~Event)} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`.
* @return {boolean} `true` if style is loading.
* @template T

View File

@@ -367,7 +367,7 @@ WebGLMapRenderer.prototype.getType = function() {
/**
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
* @protected
*/
WebGLMapRenderer.prototype.handleWebGLContextLost = function(event) {

View File

@@ -200,7 +200,7 @@ WebGLVectorLayerRenderer.prototype.forEachLayerAtPixel = function(pixel, frameSt
/**
* Handle changes in image style state.
* @param {ol.events.Event} event Image style change event.
* @param {module:ol/events/Event~Event} event Image style change event.
* @private
*/
WebGLVectorLayerRenderer.prototype.handleStyleImageChange_ = function(event) {

View File

@@ -47,7 +47,7 @@ const ImageSourceEventType = {
* type.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.source.ImageEvent}
* @param {string} type Type.
* @param {ol.Image} image The image.
@@ -192,7 +192,7 @@ ImageSource.prototype.getImageInternal = function(extent, resolution, pixelRatio
/**
* Handle image change events.
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
* @protected
*/
ImageSource.prototype.handleImageChange = function(event) {

View File

@@ -48,7 +48,7 @@ const RasterEventType = {
* type.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.source.RasterEvent}
* @param {string} type Type.
* @param {module:ol/PluggableMap~FrameState} frameState The frame state.

View File

@@ -313,7 +313,7 @@ TileSource.prototype.useTile = UNDEFINED;
* type.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.source.Tile.Event}
* @param {string} type Type.
* @param {module:ol/Tile~Tile} tile The tile.

View File

@@ -112,7 +112,7 @@ UrlTile.prototype.getUrls = function() {
/**
* Handle tile change events.
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
* @protected
*/
UrlTile.prototype.handleTileChange = function(event) {

View File

@@ -28,7 +28,7 @@ import RBush from '../structs/RBush.js';
* type.
*
* @constructor
* @extends {ol.events.Event}
* @extends {module:ol/events/Event~Event}
* @implements {oli.source.Vector.Event}
* @param {string} type Type.
* @param {module:ol/Feature~Feature=} opt_feature Feature.
@@ -690,7 +690,7 @@ VectorSource.prototype.getUrl = function() {
/**
* @param {ol.events.Event} event Event.
* @param {module:ol/events/Event~Event} event Event.
* @private
*/
VectorSource.prototype.handleFeatureChange_ = function(event) {

View File

@@ -12,7 +12,7 @@ import EventType from '../events/EventType.js';
* items from the cache is the responsibility of the user.
* @constructor
* @extends {module:ol/events/EventTarget~EventTarget}
* @fires ol.events.Event
* @fires module:ol/events/Event~Event
* @struct
* @template T
* @param {number=} opt_highWaterMark High water mark.

View File

@@ -215,7 +215,7 @@ ImageStyle.prototype.setSnapToPixel = function(snapToPixel) {
/**
* @abstract
* @param {function(this: T, ol.events.Event)} listener Listener function.
* @param {function(this: T, module:ol/events/Event~Event)} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`.
* @return {module:ol/events~EventsKey|undefined} Listener key.
* @template T
@@ -232,7 +232,7 @@ ImageStyle.prototype.load = function() {};
/**
* @abstract
* @param {function(this: T, ol.events.Event)} listener Listener function.
* @param {function(this: T, module:ol/events/Event~Event)} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`.
* @template T
*/