Class: DragToScroll

DragToScroll

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 5

Plugin used to scroll Handsontable by selecting a cell and dragging outside of the visible viewport.

Members

boundariesObject

DOMRect - size of an element and its position relative to the viewport,
e.g. {bottom: 449, height: 441, left: 8, right: 814, top: 8, width: 806, x: 8, y:8}.

callbackfunction

Callback function.

eventManagerEventManager

Instance of EventManager.

listeningBoolean

Flag indicates mouseDown/mouseUp.

Methods

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 111

check(x, y)

Check if mouse position (x, y) is outside of the viewport.

Parameters:
Name Type Description
x Number
y Number
handsontable/src/plugins/dragToScroll/dragToScroll.js, line 212

destroy()

Destroy instance.

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 81

disablePlugin()

Disable plugin for this Handsontable instance.

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 55

enablePlugin()

Enable plugin for this Handsontable instance.

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 48

isEnabled(){Boolean}

Check if the plugin is enabled in the Handsontable settings.

Returns: {Boolean}
handsontable/src/plugins/dragToScroll/dragToScroll.js, line 92

setBoundaries(boundaries)

Sets the value of the visible element.

Parameters:
Name Type Description
boundaries Object

compatible with getBoundingClientRect

handsontable/src/plugins/dragToScroll/dragToScroll.js, line 101

setCallback(callback)

Change callback function.

Parameters:
Name Type Description
callback function
handsontable/src/plugins/dragToScroll/dragToScroll.js, line 71

updatePlugin()

Updates the plugin to use the latest options you have specified.