OpenLayers 3 API Documentation

Class: Modify

ol.interaction.Modify

Interaction for modifying vector data.

new ol.interaction.Modify(options)

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

Options.

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

A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled. By default, ol.events.condition.singleClick with ol.events.condition.noModifierKeys results in a vertex deletion.
pixelTolerance number | undefined experimental

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.style.StyleFunction | undefined experimental

FeatureOverlay style.
features ol.Collection.<ol.Feature> experimental

The features the interaction works on.

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

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

src/ol/observable.js, line 65

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

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

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

src/ol/observable.js, line 78

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

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

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 101

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

Name Type Description
key goog.events.Key

Key.