Module type for ol/MapBrowserEvent

src/ol/interaction/DoubleClickZoom.js

@@ -40,9 +40,9 @@ inherits(DoubleClickZoom, Interaction);
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} (if it was a
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} (if it was a
  * doubleclick) and eventually zooms the map.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.DoubleClickZoom}
  */

src/ol/interaction/DragBox.js

@@ -44,7 +44,7 @@ const DragBoxEventType = {
  *
  * @param {string} type The event type.
  * @param {module:ol/coordinate~Coordinate} coordinate The event coordinate.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Originating event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Originating event.
  * @extends {ol.events.Event}
  * @constructor
  * @implements {oli.DragBoxEvent}
@@ -62,7 +62,7 @@ const DragBoxEvent = function(type, coordinate, mapBrowserEvent) {
 
   /**
    * @const
-   * @type {ol.MapBrowserEvent}
+   * @type {module:ol/MapBrowserEvent~MapBrowserEvent}
    * @api
    */
   this.mapBrowserEvent = mapBrowserEvent;
@@ -137,7 +137,7 @@ inherits(DragBox, PointerInteraction);
 /**
  * The default condition for determining whether the boxend event
  * should fire.
- * @param {ol.MapBrowserEvent} mapBrowserEvent The originating MapBrowserEvent
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent The originating MapBrowserEvent
  *     leading to the box end.
  * @param {module:ol~Pixel} startPixel The starting pixel of the box.
  * @param {module:ol~Pixel} endPixel The end pixel of the box.
@@ -180,7 +180,7 @@ DragBox.prototype.getGeometry = function() {
 /**
  * To be overridden by child classes.
  * FIXME: use constructor option instead of relying on overriding.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @protected
  */
 DragBox.prototype.onBoxEnd = UNDEFINED;

src/ol/interaction/Draw.js

@@ -394,9 +394,9 @@ Draw.prototype.setMap = function(map) {
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} and may actually
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may actually
  * draw or finish the drawing.
- * @param {ol.MapBrowserEvent} event Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.Draw}
  * @api
@@ -521,7 +521,7 @@ function handleUpEvent(event) {
 
 /**
  * Handle move events.
- * @param {ol.MapBrowserEvent} event A move event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event A move event.
  * @return {boolean} Pass the event to other interactions.
  * @private
  */
@@ -553,7 +553,7 @@ Draw.prototype.handlePointerMove_ = function(event) {
 
 /**
  * Determine if an event is within the snapping tolerance of the start coord.
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @return {boolean} The event is within the snapping tolerance of the start.
  * @private
  */
@@ -592,7 +592,7 @@ Draw.prototype.atFinish_ = function(event) {
 
 
 /**
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @private
  */
 Draw.prototype.createOrUpdateSketchPoint_ = function(event) {
@@ -609,7 +609,7 @@ Draw.prototype.createOrUpdateSketchPoint_ = function(event) {
 
 /**
  * Start the drawing.
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @private
  */
 Draw.prototype.startDrawing_ = function(event) {
@@ -640,7 +640,7 @@ Draw.prototype.startDrawing_ = function(event) {
 
 /**
  * Modify the drawing.
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @private
  */
 Draw.prototype.modifyDrawing_ = function(event) {
@@ -687,7 +687,7 @@ Draw.prototype.modifyDrawing_ = function(event) {
 
 /**
  * Add a new coordinate to the drawing.
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @private
  */
 Draw.prototype.addToDrawing_ = function(event) {

src/ol/interaction/Extent.js

@@ -151,7 +151,7 @@ const ExtentInteraction = function(opt_options) {
 inherits(ExtentInteraction, PointerInteraction);
 
 /**
- * @param {ol.MapBrowserEvent} mapBrowserEvent Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Event.
  * @return {boolean} Propagate event?
  * @this {ol.interaction.Extent}
  */
@@ -366,7 +366,7 @@ ExtentInteraction.prototype.snapToVertex_ = function(pixel, map) {
 };
 
 /**
- * @param {ol.MapBrowserEvent} mapBrowserEvent pointer move event
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent pointer move event
  * @private
  */
 ExtentInteraction.prototype.handlePointerMove_ = function(mapBrowserEvent) {

src/ol/interaction/KeyboardPan.js

@@ -35,7 +35,7 @@ const KeyboardPan = function(opt_options) {
 
   /**
    * @private
-   * @param {ol.MapBrowserEvent} mapBrowserEvent Browser event.
+   * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Browser event.
    * @return {boolean} Combined condition result.
    */
   this.defaultCondition_ = function(mapBrowserEvent) {
@@ -68,10 +68,10 @@ const KeyboardPan = function(opt_options) {
 inherits(KeyboardPan, Interaction);
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} if it was a
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} if it was a
  * `KeyEvent`, and decides the direction to pan to (if an arrow key was
  * pressed).
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.KeyboardPan}
  */

src/ol/interaction/KeyboardZoom.js

@@ -55,10 +55,10 @@ inherits(KeyboardZoom, Interaction);
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} if it was a
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} if it was a
  * `KeyEvent`, and decides whether to zoom in or out (depending on whether the
  * key pressed was '+' or '-').
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.KeyboardZoom}
  */

src/ol/interaction/Modify.js

@@ -68,8 +68,8 @@ export const ModifyEvent = function(type, features, mapBrowserPointerEvent) {
   this.features = features;
 
   /**
-   * Associated {@link ol.MapBrowserEvent}.
-   * @type {ol.MapBrowserEvent}
+   * Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
+   * @type {module:ol/MapBrowserEvent~MapBrowserEvent}
    * @api
    */
   this.mapBrowserEvent = mapBrowserPointerEvent;
@@ -115,7 +115,7 @@ const Modify = function(options) {
 
   /**
    * @private
-   * @param {ol.MapBrowserEvent} mapBrowserEvent Browser event.
+   * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Browser event.
    * @return {boolean} Combined condition result.
    */
   this.defaultDeleteCondition_ = function(mapBrowserEvent) {
@@ -831,9 +831,9 @@ function handleUpEvent(evt) {
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} and may modify the
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may modify the
  * geometry.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.Modify}
  */
@@ -866,7 +866,7 @@ function handleEvent(mapBrowserEvent) {
 
 
 /**
- * @param {ol.MapBrowserEvent} evt Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} evt Event.
  * @private
  */
 Modify.prototype.handlePointerMove_ = function(evt) {

src/ol/interaction/MouseWheelZoom.js

@@ -136,9 +136,9 @@ inherits(MouseWheelZoom, Interaction);
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} (if it was a
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} (if it was a
  * mousewheel-event) and eventually zooms the map.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} Allow event propagation.
  * @this {ol.interaction.MouseWheelZoom}
  */

src/ol/interaction/Pointer.js

@@ -166,10 +166,10 @@ PointerInteraction.prototype.updateTrackedPointers_ = function(mapBrowserEvent)
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} and may call into
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may call into
  * other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
  * detected.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.Pointer}
  * @api

src/ol/interaction/Select.js

@@ -37,8 +37,8 @@ const SelectEventType = {
  * @param {SelectEventType} type The event type.
  * @param {Array.<module:ol/Feature~Feature>} selected Selected features.
  * @param {Array.<module:ol/Feature~Feature>} deselected Deselected features.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Associated
- *     {@link ol.MapBrowserEvent}.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Associated
+ *     {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
  * @implements {oli.SelectEvent}
  * @extends {ol.events.Event}
  * @constructor
@@ -61,8 +61,8 @@ const SelectEvent = function(type, selected, deselected, mapBrowserEvent) {
   this.deselected = deselected;
 
   /**
-   * Associated {@link ol.MapBrowserEvent}.
-   * @type {ol.MapBrowserEvent}
+   * Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
+   * @type {module:ol/MapBrowserEvent~MapBrowserEvent}
    * @api
    */
   this.mapBrowserEvent = mapBrowserEvent;
@@ -244,9 +244,9 @@ Select.prototype.getLayer = function(feature) {
 
 
 /**
- * Handles the {@link ol.MapBrowserEvent map browser event} and may change the
+ * Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may change the
  * selected state of features.
- * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} `false` to stop event propagation.
  * @this {ol.interaction.Select}
  */

src/ol/interaction/Snap.js

@@ -580,7 +580,7 @@ Snap.prototype.writePolygonGeometry_ = function(feature, geometry) {
 
 /**
  * Handle all pointer events events.
- * @param {ol.MapBrowserEvent} evt A move event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} evt A move event.
  * @return {boolean} Pass the event to other interactions.
  * @this {ol.interaction.Snap}
  */

src/ol/interaction/Translate.js

@@ -221,7 +221,7 @@ function handleDragEvent(event) {
 
 
 /**
- * @param {ol.MapBrowserEvent} event Event.
+ * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Event.
  * @this {ol.interaction.Translate}
  */
 function handleMoveEvent(event) {

src/ol/typedefs.js

@@ -154,10 +154,10 @@ ol.DeclutterGroup;
 
 
 /**
- * A function that takes a {@link ol.MapBrowserEvent} and two
+ * A function that takes a {@link module:ol/MapBrowserEvent~MapBrowserEvent} and two
  * {@link module:ol~Pixel}s and returns a `{boolean}`. If the condition is met,
  * true should be returned.
- * @typedef {function(ol.MapBrowserEvent, module:ol~Pixel, module:ol~Pixel):boolean}
+ * @typedef {function(module:ol/MapBrowserEvent~MapBrowserEvent, module:ol~Pixel, module:ol~Pixel):boolean}
  */
 ol.DragBoxEndConditionType;
 
@@ -174,10 +174,10 @@ ol.DrawGeometryFunctionType;
 
 
 /**
- * A function that takes an {@link ol.MapBrowserEvent} and returns a
+ * A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a
  * `{boolean}`. If the condition is met, true should be returned.
  *
- * @typedef {function(ol.MapBrowserEvent): boolean}
+ * @typedef {function(module:ol/MapBrowserEvent~MapBrowserEvent): boolean}
  */
 ol.EventsConditionType;