Module: ol/interaction/Modify

Classes

ModifyEvent

Modify

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
condition	module:ol/events/condition~Condition	<optional>		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	<optional>		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	<optional>		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	<optional>	10	Pixel tolerance for considering the pointer close enough to a segment or vertex for editing.
style	module:ol/style/Style~StyleLike	<optional>		Style used for the modification point or vertex. For linestrings and polygons, this will be the affected vertex, for circles a point along the circle, and for points the actual point. If not configured, the default edit style is used (see module:ol/style). When using a style function, the point feature passed to the function will have a features property - an array whose entries are the features that are being modified, and a geometries property - an array whose entries are the geometries that are being modified. Both arrays are in the same order. The geometries are only useful when modifying geometry collections, where the geometry will be the particular geometry from the collection that is being modified.
source	module:ol/source/Vector~VectorSource	<optional>		The vector source with features to modify. If a vector source is not provided, a feature collection must be provided with the features option.
hitDetection	boolean | module:ol/layer/BaseVector~BaseVectorLayer	<optional>		When configured, point features will be considered for modification based on their visual appearance, instead of being within the pixelTolerance from the pointer location. When a module:ol/layer/BaseVector is provided, only the rendered representation of the features on that layer will be considered.
features	module:ol/Collection~Collection.<module:ol/Feature~Feature>	<optional>		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	<optional>	false	Wrap the world horizontally on the sketch overlay.
snapToPointer	boolean	<optional>	!hitDetection	The vertex, point or segment being modified snaps to the pointer coordinate when clicked within the pixelTolerance.

SegmentData{Object}

Properties:

Name	Type	Argument	Description
depth	Array.<number>	<optional>	Depth.
feature	module:ol/Feature~FeatureLike		Feature.
geometry	module:ol/geom/SimpleGeometry~SimpleGeometry		Geometry.
index	number	<optional>	Index.
segment	Array.<Array.<number>>		Segment.
featureSegments	Array.<module:ol/interaction/Modify~SegmentData>	<optional>	FeatureSegments.