diff --git a/externs/olx.js b/externs/olx.js index 6a0b21326b..aba6f65df3 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -5,56 +5,6 @@ let olx; -/** - * @typedef {{condition: (ol.EventsConditionType|undefined), - * duration: (number|undefined)}} - */ -olx.interaction.DragRotateAndZoomOptions; - - -/** - * A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean - * to indicate whether that event should be handled. - * Default is {@link ol.events.condition.shiftKeyOnly}. - * @type {ol.EventsConditionType|undefined} - * @api - */ -olx.interaction.DragRotateAndZoomOptions.prototype.condition; - - -/** - * Animation duration in milliseconds. Default is `400`. - * @type {number|undefined} - * @api - */ -olx.interaction.DragRotateAndZoomOptions.prototype.duration; - - -/** - * @typedef {{condition: (ol.EventsConditionType|undefined), - * duration: (number|undefined)}} - */ -olx.interaction.DragRotateOptions; - - -/** - * A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean - * to indicate whether that event should be handled. - * Default is {@link ol.events.condition.altShiftKeysOnly}. - * @type {ol.EventsConditionType|undefined} - * @api - */ -olx.interaction.DragRotateOptions.prototype.condition; - - -/** - * Animation duration in milliseconds. Default is `250`. - * @type {number|undefined} - * @api - */ -olx.interaction.DragRotateOptions.prototype.duration; - - /** * @typedef {{className: (string|undefined), * condition: (ol.EventsConditionType|undefined), diff --git a/externs/xol.js b/externs/xol.js index 9dfa27601f..bad56e6d09 100644 --- a/externs/xol.js +++ b/externs/xol.js @@ -1,22 +1,4 @@ -/** - * @typedef {Object} interaction_DragRotateAndZoomOptions - * @property {ol.EventsConditionType|undefined} condition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean - * to indicate whether that event should be handled. - * Default is {@link ol.events.condition.shiftKeyOnly}. - * @property {number|undefined} duration Animation duration in milliseconds. Default is `400`. - */ - - -/** - * @typedef {Object} interaction_DragRotateOptions - * @property {ol.EventsConditionType|undefined} condition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean - * to indicate whether that event should be handled. - * Default is {@link ol.events.condition.altShiftKeysOnly}. - * @property {number|undefined} duration Animation duration in milliseconds. Default is `250`. - */ - - /** * @typedef {Object} interaction_DragZoomOptions * @property {string|undefined} className CSS class name for styling the box. The default is `ol-dragzoom`. diff --git a/src/ol/interaction/DragRotate.js b/src/ol/interaction/DragRotate.js index 9eb2ddeded..d3c25bd362 100644 --- a/src/ol/interaction/DragRotate.js +++ b/src/ol/interaction/DragRotate.js @@ -9,17 +9,28 @@ import {FALSE} from '../functions.js'; import {rotate, rotateWithoutConstraints} from '../interaction/Interaction.js'; import PointerInteraction from '../interaction/Pointer.js'; + +/** + * @typedef {Object} Options + * @property {module:ol/events/condition~Condition} [condition] A function that takes an + * {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean + * to indicate whether that event should be handled. + * Default is {@link module:ol/events/condition~altShiftKeysOnly}. + * @property {number} [duration=250] Animation duration in milliseconds. + */ + + /** * @classdesc * Allows the user to rotate the map by clicking and dragging on the map, - * normally combined with an {@link ol.events.condition} that limits + * normally combined with an {@link module:ol/events/condition} that limits * it to when the alt and shift keys are held down. * * This interaction is only supported for mouse devices. * * @constructor - * @extends {ol.interaction.Pointer} - * @param {olx.interaction.DragRotateOptions=} opt_options Options. + * @extends {module:ol/interaction/Pointer~Pointer} + * @param {ol/interaction/DragRotate~Options=} opt_options Options. * @api */ const DragRotate = function(opt_options) { @@ -55,8 +66,8 @@ inherits(DragRotate, PointerInteraction); /** - * @param {ol.MapBrowserPointerEvent} mapBrowserEvent Event. - * @this {ol.interaction.DragRotate} + * @param {module:ol/MapBrowserPointerEvent~MapBrowserPointerEvent} mapBrowserEvent Event. + * @this {module:ol/interaction/DragRotate~DragRotate} */ function handleDragEvent(mapBrowserEvent) { if (!mouseOnly(mapBrowserEvent)) { @@ -82,9 +93,9 @@ function handleDragEvent(mapBrowserEvent) { /** - * @param {ol.MapBrowserPointerEvent} mapBrowserEvent Event. + * @param {module:ol/MapBrowserPointerEvent~MapBrowserPointerEvent} mapBrowserEvent Event. * @return {boolean} Stop drag sequence? - * @this {ol.interaction.DragRotate} + * @this {module:ol/interaction/DragRotate~DragRotate} */ function handleUpEvent(mapBrowserEvent) { if (!mouseOnly(mapBrowserEvent)) { @@ -101,9 +112,9 @@ function handleUpEvent(mapBrowserEvent) { /** - * @param {ol.MapBrowserPointerEvent} mapBrowserEvent Event. + * @param {module:ol/MapBrowserPointerEvent~MapBrowserPointerEvent} mapBrowserEvent Event. * @return {boolean} Start drag sequence? - * @this {ol.interaction.DragRotate} + * @this {module:ol/interaction/DragRotate~DragRotate} */ function handleDownEvent(mapBrowserEvent) { if (!mouseOnly(mapBrowserEvent)) {