Class: Modify

ol/interaction/Modify~Modify 


import Modify from 'ol/interaction/Modify';

Interaction for modifying feature geometries. To modify features that have been added to an existing source, construct the modify interaction with the source option. If you want to modify features in a collection (for example, the collection used by a select interaction), construct the interaction with the features option. The interaction must be constructed with either a source or features option.

By default, the interaction will allow deletion of vertices when the alt key is pressed. To configure the interaction with a different condition for deletion, use the deleteCondition option.

new Modify(options)

interaction/Modify.js, line 174
Name Type Description
options

Options.

Name Type Description
condition module:ol/events/condition~Condition

A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event will be considered to add or move a vertex to the sketch. Default is module:ol/events/condition~primaryAction.
deleteCondition module:ol/events/condition~Condition

A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. By default, module:ol/events/condition~singleClick with module:ol/events/condition~altKeyOnly results in a vertex deletion.
insertVertexCondition module:ol/events/condition~Condition

A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether a new vertex should be added to the sketch features. Default is module:ol/events/condition~always.
pixelTolerance number (defaults to 10)

Pixel tolerance for considering the pointer close enough to a segment or vertex for editing.
style module:ol/style/Style~StyleLike

Style used for the features being modified. By default the default edit style is used (see module:ol/style).
source module:ol/source/Vector~VectorSource

The vector source with features to modify. If a vector source is not provided, a feature collection must be provided with the features option.
features module:ol/Collection~Collection.<module:ol/Feature~Feature>

The features the interaction works on. If a feature collection is not provided, a vector source must be provided with the source option.
wrapX boolean (defaults to false)

Wrap the world horizontally on the sketch overlay.
Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
active boolean yes change:active

true if the interaction is active, false otherwise.

Methods

changed() inherited

Observable.js, line 34

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 module:ol/events/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 113

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited

interaction/Interaction.js, line 58

Return whether the interaction is currently active.

Returns:
true if the interaction is active, false otherwise.

getKeys(){Array.<string>} inherited

Object.js, line 126

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap} inherited

interaction/Interaction.js, line 67

Get the map associated with this interaction.

Returns:
Map.

getOverlay(){module:ol/layer/Vector~VectorLayer}

interaction/Modify.js, line 467

Get the overlay layer that this interaction renders sketch features to.

Returns:
Overlay layer.

getPointerCount(){number} inherited

interaction/Pointer.js, line 102

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

Returns:
The number of pointers.

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

Object.js, line 135

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 45

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

Returns:
Revision.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 58

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 80

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.

removePoint(){boolean}

interaction/Modify.js, line 1194

Removes the vertex currently being pointed.

Returns:
True when a vertex was removed.

set(key, value, opt_silent) inherited

Object.js, line 165

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setActive(active)

interaction/Modify.js, line 443

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values, opt_silent) inherited

Object.js, line 185

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

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.

unset(key, opt_silent) inherited

Object.js, line 197

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.