new ol.interaction.DoubleClickZoom(opt_options)
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change
(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:active
(ol.Object.Event) -
propertychange
(ol.Object.Event) - Triggered when a property is changed.
Extends
Observable Properties
Name | Type | Settable | ol.Object.Event type | Description |
---|---|---|---|---|
active |
boolean | yes | change:active |
|
Methods
-
ol.interaction.DoubleClickZoom.handleEvent(mapBrowserEvent){boolean}
src/ol/interaction/doubleclickzoom.js, line 49 -
Handles the
map browser event
(if it was a doubleclick) and eventually zooms the map.This:
Name Type Description mapBrowserEvent
ol.MapBrowserEvent Map browser event.
Returns:
false
to stop event propagation.
-
Increases the revision counter and dispatches a 'change' event.
-
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
Object | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
Return whether the interaction is currently active.
Returns:
true
if the interaction is active,false
otherwise.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the map associated with this interaction.
Returns:
Map.
-
Get an object of all property names and values.
Returns:
Object.
-
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){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
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. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
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. If called with an array of event types as the first argument, the return will be an array of keys.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
Activate or deactivate the interaction.
Name Type Description active
boolean Active.
-
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.
-
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
. -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.