-
Name Type Description condition
Condition | undefined A function that takes an
MapBrowserEvent
and returns a boolean to indicate whether that event should be handled. Default isshiftKeyOnly
.duration
number (defaults to 400) Animation duration in milliseconds.
Fires:
-
change
(BaseEvent) - Generic change event. Triggered when the revision counter is increased. -
change:active
(ObjectEvent) -
error
(BaseEvent) - Generic error event. Triggered when an error occurs. -
propertychange
(ObjectEvent) - Triggered when a property is changed.
-
Extends
Observable Properties
Name | Type | Settable | ObjectEvent type | Description |
---|---|---|---|---|
active |
boolean | yes | change:active |
|
Methods
-
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
BaseEvent | string Event object.
Returns:
false
if anyone called preventDefault on the event object or if any of the listeners returned false.
-
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.
-
Returns the current number of pointers involved in the interaction, e.g.
2
when two fingers are used.Returns:
The number of pointers.
-
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.
-
Handles the
map browser event
and may call into other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are detected.Name Type Description mapBrowserEvent
MapBrowserEvent Map browser event.
Returns:
false
to stop event propagation.
-
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.
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.
-
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.
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 | undefined 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 | undefined 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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean | undefined Unset without triggering an event.