Translate — OpenLayers API reference

new Translate(options) interaction/Translate.js, line 134

Name	Type	Description
`condition`	Condition \| undefined	A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. Default is `always`.
`features`	Collection<Feature> \| undefined	Features contained in this collection will be able to be translated together.
`layers`	Array<Layer> \| function \| undefined	A list of layers from which features should be translated. Alternatively, a filter function can be provided. The function will be called for each layer in the map and should return `true` for layers that you want to be translatable. If the option is absent, all visible layers will be considered translatable. Not used if `features` is provided.
`filter`	FilterFunction \| undefined	A function that takes a `Feature` and an `Layer` and returns `true` if the feature may be translated or `false` otherwise. Not used if `features` is provided.
`hitTolerance`	number (defaults to 0)	Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features.

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.
translateend (TranslateEvent) - Triggered upon feature translation end.
translatestart (TranslateEvent) - Triggered upon feature translation start.
translating (TranslateEvent) - Triggered upon feature translation.

Extends

PointerInteraction

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
`active`	boolean	yes	`change:active`	`true` if the interaction is active, `false` otherwise.

Methods

changed() inherited Observable.js, line 72

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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.

get(key){*} inherited Object.js, line 136

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getActive(){boolean} inherited interaction/Interaction.js, line 82

Return whether the interaction is currently active.

Returns:

true if the interaction is active, false otherwise.

getHitTolerance(){number} interaction/Translate.js, line 399

Returns the Hit-detection tolerance.

Returns:

Hit tolerance in pixels.

getKeys(){Array.<string>} inherited Object.js, line 149

Get a list of object property names.

Returns:

List of property names.

getMap(){Map | null} inherited interaction/Interaction.js, line 91

Get the map associated with this interaction.

Returns:

Map.

getPointerCount(){number} inherited interaction/Pointer.js, line 95

Returns the current number of pointers involved in the interaction, e.g. 2 when two fingers are used.

Returns:

The number of pointers.

getProperties(){NoInfer.<Properties>} inherited Object.js, line 158

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 83

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

handleEvent(mapBrowserEvent){boolean} inherited interaction/Pointer.js, line 125

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.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 156

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.

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 168

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.

set(key, value, silent) inherited Object.js, line 218

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean \| undefined	Update without triggering an event.

setActive(active) inherited interaction/Interaction.js, line 111

Activate or deactivate the interaction.

Name	Type	Description
`active`	boolean	Active.

setHitTolerance(hitTolerance) interaction/Translate.js, line 409

Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features.

Name	Type	Description
`hitTolerance`	number	Hit tolerance in pixels.

setProperties(values, silent) inherited Object.js, line 241

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`	Partial.<NoInfer.<Properties>>	Values.
`silent`	boolean \| undefined	Update without triggering an event.

un(type, listener) inherited Observable.js, line 177

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.

unset(key, silent) inherited Object.js, line 265

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.