Plugin used to scroll Handsontable by selecting a cell and dragging outside of the visible viewport.
Members
-
boundariesDOMRect
-
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}.
Methods
-
check(x, y)
-
Checks if the mouse position (X, Y) is outside of the viewport and fires a callback with calculated X an Y diffs
between passed boundaries.Parameters:
Name Type Description x
number Mouse X coordinate to check.
y
number Mouse Y coordinate to check.
-
destroy()
-
Destroys the plugin instance.
-
disablePlugin()
-
Disables the plugin functionality for this Handsontable instance.
-
enablePlugin()
-
Enables the plugin functionality for this Handsontable instance.
-
isEnabled(){boolean}
-
Checks if the plugin is enabled in the handsontable settings. This method is executed in
Hooks#beforeInit
hook and if it returnstrue
than theDragToScroll#enablePlugin
method is called.Returns: {boolean}
-
setBoundaries(boundaries)
-
Sets the value of the visible element.
Parameters:
Name Type Description boundaries
DOMRect An object with coordinates compatible with DOMRect.
-
setCallback(callback)
-
Changes callback function.
Parameters:
Name Type Description callback
function The callback function.
-
updatePlugin()
-
Updates the plugin state. This method is executed when
Core#updateSettings
is invoked.