OpenLayers 3 API Documentation

Class: Pointer

ol.interaction.Pointer

Base class that calls user-defined functions on down, move and up events. This class also manages "drag sequences".

When the handleDownEvent user function returns true a drag sequence is started. During a drag sequence the handleDragEvent user function is called on move events. The drag sequence ends when the handleUpEvent user function is called and returns false.

new ol.interaction.Pointer(opt_options) experimental

src/ol/interaction/pointerinteraction.js, line 27
Name Type Description
options

Options.

Name Type Description
handleDownEvent function | undefined experimental

Function handling "down" events. If the function returns true then a drag sequence is started.
handleDragEvent function | undefined experimental

Function handling "drag" events. This function is called on "move" events during a drag sequence.
handleEvent function | undefined experimental

Method called by the map to notify the interaction that a browser event was dispatched to the map. The function may return false to prevent the propagation of the event to other interactions in the map's interactions chain.
handleMoveEvent function | undefined experimental

Function handling "move" events. This function is called on "move" events, also during a drag sequence (so during a drag sequence both the handleDragEvent function and this function are called).
handleUpEvent function | undefined experimental

Function handling "up" events. If the function returns false then the current drag sequence is stopped.
Fires:

Subclasses

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.Pointer.handleEvent(mapBrowserEvent){boolean} experimental

src/ol/interaction/pointerinteraction.js, line 179
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

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to 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

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited experimental

src/ol/object.js, line 354

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited experimental

src/ol/interaction/interaction.js, line 64
Returns:
true if the interaction is active, false otherwise.

getKeys(){Array.<string>} inherited experimental

src/ol/object.js, line 373

Get a list of object property names.

Returns:
List of property names.

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

src/ol/object.js, line 405

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

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

src/ol/observable.js, line 75

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 88

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) inherited experimental

src/ol/object.js, line 437

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setActive(active) inherited experimental

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

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

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.

unbind(key) inherited experimental

src/ol/object.js, line 470

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

src/ol/object.js, line 487

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 114

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().