OpenLayers v5.3.0 API - Class: Modify

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 153

Name Type Description

options

Options.

Name	Type	Default	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 can be added to the sketch features. Default is `module:ol/events/condition~always`.
`pixelTolerance`	number	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	false	Wrap the world horizontally on the sketch overlay.

Fires:

ModifyEvent
change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
change:active (module:ol/Object.ObjectEvent)
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.

Extends

module:ol/interaction/Pointer~PointerInteraction

Observable Properties

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

Methods

getOverlay(){module:ol/layer/Vector~VectorLayer} interaction/Modify.js, line 423

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

Returns:

Overlay layer.

handleEvent() inherited interaction/Pointer.js, line 120

Handles the map browser event and may call into other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are detected.

removePoint(){boolean} interaction/Modify.js, line 1015

Removes the vertex currently being pointed.

Returns:

True when a vertex was removed.

setActive(active) interaction/Modify.js, line 402

Activate or deactivate the interaction.

Name	Type	Description
`active`	boolean	Active.