new ol.interaction.MouseWheelZoom(opt_options)
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change:active
(ol.ObjectEvent) -
propertychange
(ol.ObjectEvent) experimental - Triggered when a property is changed.
Extends
Observable Properties
Name | Type | Settable | ol.ObjectEvent type | Description |
---|---|---|---|---|
active |
boolean | yes | change:active |
|
Methods
-
ol.interaction.MouseWheelZoom.handleEvent(mapBrowserEvent){boolean} experimental
-
This:
Name Type Description mapBrowserEvent
ol.MapBrowserEvent Map browser event.
Returns:
false
to stop event propagation.
-
bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental
-
The bindTo method allows you to set up a two-way binding between a
source
andtarget
object. The method returns an object with atransform
method that you can use to providefrom
andto
functions to transform values on the way from the source to the target and on the way back.For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:
sourceView.bindTo('resolution', targetView) .transform( function(sourceResolution) { // from sourceView.resolution to targetView.resolution return 2 * sourceResolution; }, function(targetResolution) { // from targetView.resolution to sourceView.resolution return targetResolution / 2; } );
Name Type Description key
string Key name.
target
ol.Object Target.
targetKey
string Target key.
-
changed() inherited experimental
-
Increases the revision counter and disptches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited experimental
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getActive(){boolean} inherited experimental
-
Returns:
true
if the interaction is active,false
otherwise.
-
getKeys(){Array.<string>} inherited experimental
-
Get a list of object property names.
Returns:
List of property names.
-
getProperties(){Object.<string, *>} inherited experimental
-
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
-
Returns:
Revision.
-
on(type, listener, opt_this){goog.events.Key} inherited
-
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
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
-
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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited experimental
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setActive(active) inherited experimental
-
Activate or deactivate the interaction.
Name Type Description active
boolean Active.
-
setProperties(values) inherited experimental
-
Sets a collection of key-value pairs.
Name Type Description values
Object.<string, *> Values.
-
un(type, listener, opt_this) inherited
-
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 thelistener
. -
unbind(key) inherited experimental
-
Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.
Name Type Description key
string Key name.
-
unbindAll() inherited experimental
-
Removes all bindings.
-
unByKey(key) inherited
-
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
.