Module: ol/interaction/Extent

ol/interaction/Extent


Classes

ExtentEvent
Extent

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 should be handled. Default is module:ol/events/condition.always.

extent module:ol/extent~Extent <optional>

Initial extent. Defaults to no initial extent.

boxStyle module:ol/style/Style~StyleLike <optional>

Style for the drawn extent box. Defaults to module:ol/style/Style~createEditing()['Polygon']

pixelTolerance number <optional>
10

Pixel tolerance for considering the pointer close enough to a segment or vertex for editing.

pointerStyle module:ol/style/Style~StyleLike <optional>

Style for the cursor used to draw the extent. Defaults to module:ol/style/Style~createEditing()['Point']

wrapX boolean <optional>
false

Wrap the drawn extent across multiple maps in the X direction? Only affects visuals, not functionality.