Methods

private _fireEvent(type, e) → {Map}

index.js, line 232

Fire the event on the map.

The event is wrapped in a object providing the following fields:

• originalEvent the browser event
• startPoint the point where the drag starts
• point the current point
• feature the feature on which the drag starts
• handler this handler instance

Parameters:

Name	Type	Description
type	string	event type
e	Event	browser event

Returns:

Map -

the map instance

private _ignoreEvent(e) → {boolean}

index.js, line 104

Tells if the event is processed by this handler or not.

Parameters:

Name	Type	Description
e	Event	any browser event but probably on MouseEvent or TouchEvent.

Returns:

boolean -

true is event ignored

private _onDown(e)

index.js, line 135

Triggered when a mouse button is pressed on the canvas.

Parameters:

Name	Type	Description
e	MouseEvent | TouchEvent	mouse or touch browser event

private _onMouseUp(e)

index.js, line 195

Triggered when a mouse button is released or the mouse leave the window.

Parameters:

Name	Type	Description
e	MouseEvent | FocusEvent	mouse browser event

private _onMove(e)

index.js, line 163

Triggered when the mouse move on the document.

Parameters:

Name	Type	Description
e	MouseEvent | TouchEvent	mouse or touch browser event

private _onTouchEnd(e)

index.js, line 209

Triggered when the touch event ends.

Parameters:

Name	Type	Description
e	FocusEvent	touch browser event

private _onUp(e)

index.js, line 181

Triggered when a mouse button is released or the touch event ends.

Parameters:

Name	Type	Description
e	MouseEvent | TouchEvent | FocusEvent	mouse or touch browser event

_pointToArray(point) → {Array}

index.js, line 126

Convert a local Point instance into a [x, y] Array.

Parameters:

Name	Type	Description
point	Point	local Point instance

Returns:

Array

disable()

index.js, line 73

Disables this handler

enable()

index.js, line 62

Enables this handler

featureNotDraggable()

index.js, line 84

Call by external code when a feature-is-draggable event is triggered and the feature should not be draggable

getFeature() → {Object}

index.js, line 94

Returns the feature on which the drag starts.

Returns:

Object -

the feature on which the drag starts.

isActive() → {boolean}

index.js, line 55

Returns a boolean indicating whether this handler is in a dragging state or not.

Returns:

boolean -

true if dragging.

isEnabled() → {boolean}

index.js, line 46

Returns a boolean indicating whether this handler is enabled or not.

Returns:

boolean -

true if the drag and drop enabled.