DragToScroll

Options

dragToScroll

dragToScroll.dragToScroll : boolean | object

The dragToScroll option configures the DragToScroll plugin.

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

Setting	Description
`true` (default)	Enable with default auto-scroll settings
`false`	Disable the plugin entirely
Object	Enable with custom auto-scroll settings (see below)

When passing an object, the following properties control the auto-scroll speed:

1
dragToScroll: {
2
  interval: {
3
    min: 20,   // Fastest scroll interval in ms (reached at rampDistance)
4
    max: 500,  // Slowest scroll interval in ms (applied at the viewport edge)
5
  },
6
  rampDistance: 120,  // Pixels outside the edge over which speed ramps up
7
},

The viewport scrolls periodically while the mouse pointer stays outside the viewport edge. Speed follows a logarithmic curve: slow at the edge, fast when far outside. The active selection (regular drag-select or autofill drag) extends to follow the scroll.

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: true
Example

1
// Enable with default settings
2
dragToScroll: true,
3

4
// Enable with custom scroll speed
5
dragToScroll: {
6
  interval: { min: 60, max: 300 },
7
  rampDistance: 60,
8
},
9

10
// Disable
11
dragToScroll: false,

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}.

DEFAULT_SETTINGS

Source code

DragToScroll.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Source code

DragToScroll.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Source code

DragToScroll.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

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