Module: ol/interaction/DragBox

ol/interaction/DragBox


Classes

DragBox
DragBoxEvent

Members

DragBoxEventType{string}

Properties:
Name Type Default Description
BOXSTART string boxstart
BOXDRAG string boxdrag
BOXEND string boxend

Type Definitions

EndCondition()

interaction/DragBox.js, line 12

A function that takes a module:ol/MapBrowserEvent and two module:ol/pixel~Pixels and returns a {boolean}. If the condition is met, true should be returned.

Options{Object}

Properties:
Name Type Argument Default Description
className string <optional>
'ol-dragbox'

CSS class name for styling the box.

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 ol/events/condition~always.

minArea number <optional>
64

The minimum area of the box in pixel, this value is used by the default boxEndCondition function.

boxEndCondition module:ol/interaction/DragBox~EndCondition <optional>

A function that takes a module:ol/MapBrowserEvent~MapBrowserEvent and two module:ol/pixel~Pixels to indicate whether a boxend event should be fired. Default is true if the area of the box is bigger than the minArea option.

onBoxEnd function <optional>

Code to execute just before boxend is fired.