React Data GridDragToScroll

On this page

• Description
• Options
  • dragToScroll
• Members
  • boundaries
• Methods
  • check
  • destroy
  • disablePlugin
  • enablePlugin
  • isEnabled
  • setBoundaries
  • setCallback
  • updatePlugin

Description

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

Options

dragToScroll

Source code

dragToScroll.dragToScroll : boolean

The dragToScroll option configures the DragToScroll plugin.

You can set the dragToScroll option to one of the following:

Setting	Description
true (default)	When selection reaches the edge of the grid's viewport, scroll the viewport
false	Don't scroll the viewport

Read more:

• Plugins: DragToScroll

Default: true
Example

// when selection reaches the edge of the grid's viewport, scroll the viewport
dragToScroll: true,

Members

boundaries

Source code

dragToScroll.boundaries : 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}.

Methods

check

Source code

dragToScroll.check(x, y)

Checks if the mouse position (X, Y) is outside the viewport and fires a callback with calculated X an Y diffs between passed boundaries.

Param	Type	Description
x	number	Mouse X coordinate to check.
y	number	Mouse Y coordinate to check.

destroy

Source code

dragToScroll.destroy()

Destroys the plugin instance.

disablePlugin

Source code

dragToScroll.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

dragToScroll.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Source code

dragToScroll.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true then the DragToScroll#enablePlugin method is called.

setBoundaries

Source code

dragToScroll.setBoundaries([boundaries])

Sets the boundaries/dimensions of the scrollable viewport.

Param	Type	Description
[boundaries]	DOMRect Object	optional An object with coordinates. Contains the window boundaries by default. The object is compatible with DOMRect.

setCallback

Source code

dragToScroll.setCallback(callback)

Changes callback function.

Param	Type	Description
callback	function	The callback function.

updatePlugin

Source code

dragToScroll.updatePlugin()

Updates the plugin's state.

This method is executed when updateSettings() is invoked with any of the following configuration options:

• dragToScroll