new ol.interaction.Translate(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. -
translateend(ol.interaction.Translate.Event) - Triggered upon feature translation end. -
translatestart(ol.interaction.Translate.Event) - Triggered upon feature translation start. -
translating(ol.interaction.Translate.Event) - Triggered upon feature translation.
Extends
Classes
Observable Properties
| Name | Type | Settable | ol.Object.Event 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
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
Return whether the interaction is currently active.
Returns:
trueif the interaction is active,falseotherwise.
-
getHitTolerance(){number}
src/ol/interaction/translate.js, line 212 -
Returns the Hit-detection tolerance.
Returns:
Hit tolerance in pixels.
-
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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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 keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
Activate or deactivate the interaction.
Name Type Description activeboolean Active.
-
setHitTolerance(hitTolerance)
src/ol/interaction/translate.js, line 224 -
Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features. This only works for the canvas renderer and not for WebGL.
Name Type Description hitTolerancenumber Hit tolerance in pixels.
-
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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers