OpenLayers 3 API Documentation

Class: Modify

ol.interaction.Modify

Interaction for modifying vector data.

new ol.interaction.Modify(options) experimental

src/ol/interaction/modifyinteraction.js, line 48
Name Type Description
options

Options.

Name Type Description
deleteCondition ol.events.ConditionType | undefined optional

Condition that determines which event results in a vertex deletion. Default is a singleclick event with no modifier keys.
pixelTolerance number | undefined optional

Pixel tolerance for considering the pointer close enough to a segment or vertex for editing. Default is 10 pixels.
style ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined optional

FeatureOverlay style.
features ol.Collection

The features the interaction works on.

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 41

Dispatches a change event.

Fires:
  • change experimental

on(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 63

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.
this Object optional

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 76

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.
this Object optional

The object to use as this in listener.
Returns:
Unique key for the listener.

un(type, listener, opt_this) inherited experimental

src/ol/observable.js, line 88

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.
this Object optional

The object to use as this in listener.

unByKey(key) inherited experimental

src/ol/observable.js, line 98

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.