No olx and ol types for ol/interaction/DragRotate

This commit is contained in:
ahocevar
2018-03-15 17:08:32 +01:00
parent a71ad16995
commit 5d0ea11189
3 changed files with 20 additions and 77 deletions

View File

@@ -5,56 +5,6 @@
let olx; 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), * @typedef {{className: (string|undefined),
* condition: (ol.EventsConditionType|undefined), * condition: (ol.EventsConditionType|undefined),

View File

@@ -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 * @typedef {Object} interaction_DragZoomOptions
* @property {string|undefined} className CSS class name for styling the box. The default is `ol-dragzoom`. * @property {string|undefined} className CSS class name for styling the box. The default is `ol-dragzoom`.

View File

@@ -9,17 +9,28 @@ import {FALSE} from '../functions.js';
import {rotate, rotateWithoutConstraints} from '../interaction/Interaction.js'; import {rotate, rotateWithoutConstraints} from '../interaction/Interaction.js';
import PointerInteraction from '../interaction/Pointer.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 * @classdesc
* Allows the user to rotate the map by clicking and dragging on the map, * 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. * it to when the alt and shift keys are held down.
* *
* This interaction is only supported for mouse devices. * This interaction is only supported for mouse devices.
* *
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {module:ol/interaction/Pointer~Pointer}
* @param {olx.interaction.DragRotateOptions=} opt_options Options. * @param {ol/interaction/DragRotate~Options=} opt_options Options.
* @api * @api
*/ */
const DragRotate = function(opt_options) { const DragRotate = function(opt_options) {
@@ -55,8 +66,8 @@ inherits(DragRotate, PointerInteraction);
/** /**
* @param {ol.MapBrowserPointerEvent} mapBrowserEvent Event. * @param {module:ol/MapBrowserPointerEvent~MapBrowserPointerEvent} mapBrowserEvent Event.
* @this {ol.interaction.DragRotate} * @this {module:ol/interaction/DragRotate~DragRotate}
*/ */
function handleDragEvent(mapBrowserEvent) { function handleDragEvent(mapBrowserEvent) {
if (!mouseOnly(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? * @return {boolean} Stop drag sequence?
* @this {ol.interaction.DragRotate} * @this {module:ol/interaction/DragRotate~DragRotate}
*/ */
function handleUpEvent(mapBrowserEvent) { function handleUpEvent(mapBrowserEvent) {
if (!mouseOnly(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? * @return {boolean} Start drag sequence?
* @this {ol.interaction.DragRotate} * @this {module:ol/interaction/DragRotate~DragRotate}
*/ */
function handleDownEvent(mapBrowserEvent) { function handleDownEvent(mapBrowserEvent) {
if (!mouseOnly(mapBrowserEvent)) { if (!mouseOnly(mapBrowserEvent)) {