TypeDefs

DefaultsOptions

Stability: experimental

Interactions for the map. Default is true for all options.

Properties:

Name	Type	Description
altShiftDragRotate	boolean | undefined	Whether Alt-Shift-drag rotate is desired. Default is true.
doubleClickZoom	boolean | undefined	Whether double click zoom is desired. Default is true.
dragPan	boolean | undefined	Whether drag-pan is desired. Default is true.
keyboard	boolean | undefined	Whether keyboard interaction is desired. Default is true.
mouseWheelZoom	boolean | undefined	Whether mousewheel zoom is desired. Default is true.
shiftDragZoom	boolean | undefined	Whether Shift-drag zoom is desired. Default is true.
touchPan	boolean | undefined	Whether touch pan is desired. Default is true.
touchRotate	boolean | undefined	Whether touch rotate is desired. Default is true.
touchZoom	boolean | undefined	Whether touch zoom is desired. Default is true.
zoomDelta	number | undefined	Zoom delta.
zoomDuration	number | undefined	Zoom duration.

Source:

• objectliterals.jsdoc, line 71

DoubleClickZoomOptions

Stability: experimental

Properties:

Name	Type	Description
duration	number | undefined	Animation duration in milliseconds. Default is 250.
delta	number | undefined	The zoom delta applied on each double click, default is 1.

Source:

• objectliterals.jsdoc, line 57

DragAndDropOptions

Stability: not documented

Properties:

Name	Type	Description
formatConstructors	Array.<function(new:ol.format.Feature)> | undefined	Format constructors.
reprojectTo	ol.proj.ProjectionLike	Target projection. By default, the map's view's projection is used.

Source:

• objectliterals.jsdoc, line 59

DragBoxOptions

Stability: experimental

Properties:

Name	Type	Description
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is always.
style	ol.style.Style	Style for the box.

Source:

• objectliterals.jsdoc, line 67

DragPanOptions

Stability: experimental

Properties:

Name	Type	Description
kinetic	ol.Kinetic | undefined	Kinetic inertia to apply to the pan.
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is no modifiers.

Source:

• objectliterals.jsdoc, line 61

DragRotateAndZoomOptions

Stability: experimental

Properties:

Name	Type	Description
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is shify key.

Source:

• objectliterals.jsdoc, line 65

DragRotateOptions

Stability: experimental

Properties:

Name	Type	Description
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is both shift and alt keys.

Source:

• objectliterals.jsdoc, line 63

DragZoomOptions

Stability: experimental

Properties:

Name	Type	Description
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is shift key.
style	ol.style.Style	Style for the box.

Source:

• objectliterals.jsdoc, line 69

DrawOptions

Stability: experimental

Properties:

Name	Type	Description
features	ol.Collection | undefined	Destination collection for the drawn features.
source	ol.source.Vector | undefined	Destination source for the drawn features.
snapTolerance	number | undefined	Pixel distance for snapping to the drawing finish (default is 12).
type	ol.geom.GeometryType	Drawing type ('Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', or 'MultiPolygon').
style	ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined	Style for sketch features.

Source:

• objectliterals.jsdoc, line 73

KeyboardPanOptions

Stability: experimental

Properties:

Name	Type	Description
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is no modifiers.
pixelDelta	number | undefined	Pixel The amount to pan on each key press. Default is 128 pixels.

Source:

• objectliterals.jsdoc, line 75

KeyboardZoomOptions

Stability: experimental

Properties:

Name	Type	Description
duration	number | undefined	Animation duration in milliseconds. Default is 100.
condition	ol.events.ConditionType | undefined	A conditional modifier (i.e. Shift key) that determines if the interaction is active or not, default is no modifiers.
delta	number | undefined	The amount to zoom on each key press. Default is 1.

Source:

• objectliterals.jsdoc, line 77

ModifyOptions

Stability: not documented

Properties:

Name	Type	Description
pixelTolerance	number | undefined	Pixel tolerance for considering the pointer close enough to a vertex for editing. Default is 20 pixels.
style	ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined	FeatureOverlay style.
features	ol.Collection	The features the interaction works on.

Source:

• objectliterals.jsdoc, line 85

MouseWheelZoomOptions

Stability: experimental

Properties:

Name	Type	Description
duration	number | undefined	Animation duration in milliseconds. Default is 250.

Source:

• objectliterals.jsdoc, line 79

SelectOptions

Stability: not documented

Properties:

Name	Type	Description
addCondition	ol.events.ConditionType | undefined	A conditional modifier (e.g. shift key) that determines if the selection is added to the current selection. By default, a shift-click adds to the current selection.
condition	ol.events.ConditionType | undefined	A conditional modifier (e.g. shift key) that determines if the interaction is active (i.e. selection occurs) or not. By default, a click with no modifier keys toggles the selection.
layerFilter	function	Filter function to restrict selection to a subset of layers.
layer	ol.layer.Layer | undefined	Layer. The single layer from which features should be selected.
layers	Array.<ol.layer.Layer> | undefined	Layers. Zero or more layers from which features should be selected.
style	ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined	FeatureOverlay style.

Source:

• objectliterals.jsdoc, line 81

TouchPanOptions

Stability: experimental

Properties:

Name	Type	Description
kinetic	ol.Kinetic | undefined	Kinetic inertia to apply to the pan.

Source:

• objectliterals.jsdoc, line 83

TouchRotateOptions

Stability: experimental

Properties:

Name	Type	Description
threshold	number | undefined	Minimal angle in radians to start a rotation. Default is 0.3.

Source:

• objectliterals.jsdoc, line 87

TouchZoomOptions

Stability: experimental

Properties:

Name	Type	Description
duration	number | undefined	Animation duration in milliseconds. Default is 400.

Source:

• objectliterals.jsdoc, line 89