Class: MouseWheelZoom

ol.interaction.MouseWheelZoom

Allows the user to zoom the map by scrolling the mouse wheel.

new ol.interaction.MouseWheelZoom(opt_options)

src/ol/interaction/mousewheelzoominteraction.js, line 22
Name Type Description
options

Options.

Name Type Description
duration number | undefined experimental

Animation duration in milliseconds. Default is 250.

useAnchor boolean | undefined experimental

Enable zooming using the mouse's location as the anchor. Default is true. When set to false, zooming in and out will zoom to the center of the screen instead of zooming on the mouse's location.

Fires:

Extends

Observable Properties

Name Type Settable ol.ObjectEvent type Description
active boolean yes change:active

true if the interaction is active, false otherwise.

Methods

ol.interaction.MouseWheelZoom.handleEvent(mapBrowserEvent){boolean} experimental

src/ol/interaction/mousewheelzoominteraction.js, line 78

Handles the map browser event (if it was a mousewheel-event) and eventually zooms the map.

This:
Name Type Description
mapBrowserEvent ol.MapBrowserEvent

Map browser event.

Returns:
false to stop event propagation.

changed() inherited experimental

src/ol/observable.js, line 51

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 73

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event goog.events.EventLike

Event object.

get(key){*} inherited

src/ol/object.js, line 149

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getActive(){boolean} inherited experimental

src/ol/interaction/interaction.js, line 66

Return whether the interaction is currently active.

Returns:
true if the interaction is active, false otherwise.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 163

Get a list of object property names.

Returns:
List of property names.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 173

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 82

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 95

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 108

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

set(key, value, opt_silent) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setActive(active) inherited experimental

src/ol/interaction/interaction.js, line 87

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setMouseAnchor(useAnchor) experimental

src/ol/interaction/mousewheelzoominteraction.js, line 139

Enable or disable using the mouse's location as an anchor when zooming

Name Type Description
useAnchor boolean

true to zoom to the mouse's location, false to zoom to the center of the map

setProperties(values, opt_silent) inherited

src/ol/object.js, line 221

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 121

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 134

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

unset(key, opt_silent) inherited

src/ol/object.js, line 235

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.