Module type for MapEvent

This commit is contained in:
Tim Schaub
2018-03-18 09:48:06 -06:00
parent 393df3faf3
commit 0edbfde4d3
7 changed files with 14 additions and 14 deletions

View File

@@ -29,7 +29,7 @@ import {visibleAtResolution} from '../layer/Layer.js';
* @property {string|Element} [collapseLabel='»'] Text label to use * @property {string|Element} [collapseLabel='»'] Text label to use
* for the expanded attributions button. * for the expanded attributions button.
* Instead of text, also an element (e.g. a `span` element) can be used. * Instead of text, also an element (e.g. a `span` element) can be used.
* @property {function(ol.MapEvent)} [render] Function called when * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when
* the control should be re-rendered. This is called in a `requestAnimationFrame` * the control should be re-rendered. This is called in a `requestAnimationFrame`
* callback. * callback.
*/ */
@@ -208,7 +208,7 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) {
/** /**
* Update the attribution element. * Update the attribution element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.Attribution} * @this {ol.control.Attribution}
* @api * @api
*/ */

View File

@@ -14,7 +14,7 @@ import {listen, unlistenByKey} from '../events.js';
* @property {Element|undefined} element The element is the control's * @property {Element|undefined} element The element is the control's
* container element. This only needs to be specified if you're developing * container element. This only needs to be specified if you're developing
* a custom control. * a custom control.
* @property {function(ol.MapEvent)|undefined} render Function called when * @property {function(module:ol/MapEvent~MapEvent)|undefined} render Function called when
* the control should be re-rendered. This is called in a `requestAnimationFrame` * the control should be re-rendered. This is called in a `requestAnimationFrame`
* callback. * callback.
* @property {Element|string|undefined} target Specify a target if you want * @property {Element|string|undefined} target Specify a target if you want
@@ -80,7 +80,7 @@ const Control = function(options) {
this.listenerKeys = []; this.listenerKeys = [];
/** /**
* @type {function(ol.MapEvent)} * @type {function(module:ol/MapEvent~MapEvent)}
*/ */
this.render = options.render ? options.render : UNDEFINED; this.render = options.render ? options.render : UNDEFINED;

View File

@@ -26,7 +26,7 @@ const COORDINATE_FORMAT = 'coordinateFormat';
* @property {string} [className='ol-mouse-position'] CSS class name. * @property {string} [className='ol-mouse-position'] CSS class name.
* @property {module:ol/coordinate~CoordinateFormat} [coordinateFormat] Coordinate format. * @property {module:ol/coordinate~CoordinateFormat} [coordinateFormat] Coordinate format.
* @property {ol.ProjectionLike} projection Projection. * @property {ol.ProjectionLike} projection Projection.
* @property {function(ol.MapEvent)} [render] Function called when the * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the
* control should be re-rendered. This is called in a `requestAnimationFrame` * control should be re-rendered. This is called in a `requestAnimationFrame`
* callback. * callback.
* @property {Element|string} [target] Specify a target if you want the * @property {Element|string} [target] Specify a target if you want the
@@ -109,7 +109,7 @@ inherits(MousePosition, Control);
/** /**
* Update the mouseposition element. * Update the mouseposition element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.MousePosition} * @this {ol.control.MousePosition}
* @api * @api
*/ */

View File

@@ -48,7 +48,7 @@ const MIN_RATIO = 0.1;
* @property {Array.<ol.layer.Layer>|ol.Collection.<ol.layer.Layer>} [layers] * @property {Array.<ol.layer.Layer>|ol.Collection.<ol.layer.Layer>} [layers]
* Layers for the overview map. If not set, then all main map layers are used * Layers for the overview map. If not set, then all main map layers are used
* instead. * instead.
* @property {function(ol.MapEvent)} [render] Function called when the control * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
* should be re-rendered. This is called in a `requestAnimationFrame` callback. * should be re-rendered. This is called in a `requestAnimationFrame` callback.
* @property {Element|string} [target] Specify a target if you want the control * @property {Element|string} [target] Specify a target if you want the control
* to be rendered outside of the map's viewport. * to be rendered outside of the map's viewport.
@@ -322,7 +322,7 @@ OverviewMap.prototype.handleRotationChanged_ = function() {
/** /**
* Update the overview map element. * Update the overview map element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.OverviewMap} * @this {ol.control.OverviewMap}
* @api * @api
*/ */

View File

@@ -18,7 +18,7 @@ import {inherits} from '../index.js';
* @property {string} [tipLabel='Reset rotation'] Text label to use for the rotate tip. * @property {string} [tipLabel='Reset rotation'] Text label to use for the rotate tip.
* @property {number} [duration=250] Animation duration in milliseconds. * @property {number} [duration=250] Animation duration in milliseconds.
* @property {boolean} [autoHide=true] Hide the control when rotation is 0. * @property {boolean} [autoHide=true] Hide the control when rotation is 0.
* @property {function(ol.MapEvent)} [render] Function called when the control should * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control should
* be re-rendered. This is called in a `requestAnimationFrame` callback. * be re-rendered. This is called in a `requestAnimationFrame` callback.
* @property {function()} [resetNorth] Function called when the control is clicked. * @property {function()} [resetNorth] Function called when the control is clicked.
* This will override the default `resetNorth`. * This will override the default `resetNorth`.
@@ -153,7 +153,7 @@ Rotate.prototype.resetNorth_ = function() {
/** /**
* Update the rotate control element. * Update the rotate control element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.Rotate} * @this {ol.control.Rotate}
* @api * @api
*/ */

View File

@@ -29,7 +29,7 @@ const LEADING_DIGITS = [1, 2, 5];
* @typedef {Object} Options * @typedef {Object} Options
* @property {string} [className='ol-scale-line'] CSS Class name. * @property {string} [className='ol-scale-line'] CSS Class name.
* @property {number} [minWidth=64] Minimum width in pixels. * @property {number} [minWidth=64] Minimum width in pixels.
* @property {function(ol.MapEvent)} [render] Function called when the control * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
* should be re-rendered. This is called in a `requestAnimationFrame` callback. * should be re-rendered. This is called in a `requestAnimationFrame` callback.
* @property {Element|string} [target] Specify a target if you want the control * @property {Element|string} [target] Specify a target if you want the control
* to be rendered outside of the map's viewport. * to be rendered outside of the map's viewport.
@@ -135,7 +135,7 @@ ScaleLine.prototype.getUnits = function() {
/** /**
* Update the scale line element. * Update the scale line element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.ScaleLine} * @this {ol.control.ScaleLine}
* @api * @api
*/ */

View File

@@ -31,7 +31,7 @@ const Direction = {
* @property {number} [duration=200] Animation duration in milliseconds. * @property {number} [duration=200] Animation duration in milliseconds.
* @property {number|undefined} maxResolution Maximum resolution. * @property {number|undefined} maxResolution Maximum resolution.
* @property {number|undefined} minResolution Minimum resolution. * @property {number|undefined} minResolution Minimum resolution.
* @property {function(ol.MapEvent)} [render] Function called when the control * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
* should be re-rendered. This is called in a `requestAnimationFrame` callback. * should be re-rendered. This is called in a `requestAnimationFrame` callback.
*/ */
@@ -209,7 +209,7 @@ ZoomSlider.prototype.initSlider_ = function() {
/** /**
* Update the zoomslider element. * Update the zoomslider element.
* @param {ol.MapEvent} mapEvent Map event. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
* @this {ol.control.ZoomSlider} * @this {ol.control.ZoomSlider}
* @api * @api
*/ */