Class: PinchZoom

ol.interaction.PinchZoom

Allows the user to zoom the map by pinching with two fingers on a touch screen.

new ol.interaction.PinchZoom(opt_options)

src/ol/interaction/pinchzoom.js, line 20
Name Type Description
options

Options.

Name Type Description
duration number | undefined experimental

Animation duration in milliseconds. Default is 400.

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

changed() inherited experimental

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 75

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.

get(key){*} inherited

src/ol/object.js, line 148

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getActive(){boolean} inherited experimental

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

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 162

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.Map} inherited experimental

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

Get the map associated with this interaction.

Returns:
Map.

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

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 84

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 in listener.

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 in listener.

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.

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

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 86

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

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 147

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 168

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 ol.EventsKey | Array.<ol.EventsKey>

The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.