147 lines
3.5 KiB
TypeScript
147 lines
3.5 KiB
TypeScript
export default MouseWheelZoom;
|
|
export type Mode = "trackpad" | "wheel";
|
|
export type Options = {
|
|
/**
|
|
* A function that
|
|
* takes a {@link module :ol/MapBrowserEvent~MapBrowserEvent} and returns a
|
|
* boolean to indicate whether that event should be handled. Default is
|
|
* {@link module :ol/events/condition.always}.
|
|
*/
|
|
condition?: import("../events/condition.js").Condition | undefined;
|
|
/**
|
|
* When the map's target has a `tabindex` attribute set,
|
|
* the interaction will only handle events when the map has the focus.
|
|
*/
|
|
onFocusOnly?: boolean | undefined;
|
|
/**
|
|
* Maximum mouse wheel delta.
|
|
*/
|
|
maxDelta?: number | undefined;
|
|
/**
|
|
* Animation duration in milliseconds.
|
|
*/
|
|
duration?: number | undefined;
|
|
/**
|
|
* Mouse wheel timeout duration in milliseconds.
|
|
*/
|
|
timeout?: number | undefined;
|
|
/**
|
|
* Enable zooming using the mouse's
|
|
* location as the anchor. When set to `false`, zooming in and out will zoom to
|
|
* the center of the screen instead of zooming on the mouse's location.
|
|
*/
|
|
useAnchor?: boolean | undefined;
|
|
/**
|
|
* If true, the mouse wheel zoom
|
|
* event will always animate to the closest zoom level after an interaction;
|
|
* false means intermediary zoom levels are allowed.
|
|
*/
|
|
constrainResolution?: boolean | undefined;
|
|
};
|
|
/**
|
|
* @classdesc
|
|
* Allows the user to zoom the map by scrolling the mouse wheel.
|
|
* @api
|
|
*/
|
|
declare class MouseWheelZoom extends Interaction {
|
|
/**
|
|
* @param {Options} [options] Options.
|
|
*/
|
|
constructor(options?: Options);
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private totalDelta_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private lastDelta_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private maxDelta_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private duration_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private timeout_;
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
private useAnchor_;
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
private constrainResolution_;
|
|
/**
|
|
* @private
|
|
* @type {import("../events/condition.js").Condition}
|
|
*/
|
|
private condition_;
|
|
/**
|
|
* @private
|
|
* @type {?import("../pixel.js").Pixel}
|
|
*/
|
|
private lastAnchor_;
|
|
/**
|
|
* @private
|
|
* @type {number|undefined}
|
|
*/
|
|
private startTime_;
|
|
/**
|
|
* @private
|
|
* @type {ReturnType<typeof setTimeout>}
|
|
*/
|
|
private timeoutId_;
|
|
/**
|
|
* @private
|
|
* @type {Mode|undefined}
|
|
*/
|
|
private mode_;
|
|
/**
|
|
* Trackpad events separated by this delay will be considered separate
|
|
* interactions.
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private trackpadEventGap_;
|
|
/**
|
|
* @private
|
|
* @type {ReturnType<typeof setTimeout>}
|
|
*/
|
|
private trackpadTimeoutId_;
|
|
/**
|
|
* The number of delta values per zoom level
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private deltaPerZoom_;
|
|
/**
|
|
* @private
|
|
*/
|
|
private endInteraction_;
|
|
/**
|
|
* @private
|
|
* @param {import("../Map.js").default} map Map.
|
|
*/
|
|
private handleWheelZoom_;
|
|
/**
|
|
* Enable or disable using the mouse's location as an anchor when zooming
|
|
* @param {boolean} useAnchor true to zoom to the mouse's location, false
|
|
* to zoom to the center of the map
|
|
* @api
|
|
*/
|
|
setMouseAnchor(useAnchor: boolean): void;
|
|
}
|
|
import Interaction from './Interaction.js';
|
|
//# sourceMappingURL=MouseWheelZoom.d.ts.map
|