Skip to content

Autofill

See the Autofill values guide for examples and configuration details.

Members

DEFAULT_SETTINGS

Source code

Autofill.DEFAULT_SETTINGS

The default values of the fillHandle object form: { direction: undefined, autoInsertRow: true }.

They fill in each property the option value leaves out (true, 'vertical', 'horizontal', or an object):

  • direction: undefined: autofill works in both directions.
  • autoInsertRow: true: dragging the fill handle below the last row adds new rows. direction: 'horizontal' turns it off.

If you don’t set fillHandle at all, the grid’s default ({ autoInsertRow: false }) goes through the same merge, so autofill still works in both directions, but no rows are added.

Example

// vertical autofill only; `autoInsertRow` keeps its default, `true`
fillHandle: { direction: 'vertical' },

LICENSE

Source code

Autofill.LICENSE

Returns the license token of the plugin, its display name, where it is checked, and the tokens it requires.

PLUGIN_KEY

Source code

Autofill.PLUGIN_KEY

The key the plugin is registered under: 'autofill'. Pass it to Core#getPlugin to get the plugin instance: hot.getPlugin('autofill').

The key is not the option name. To turn the plugin on and configure it, use the fillHandle option.

PLUGIN_PRIORITY

Source code

Autofill.PLUGIN_PRIORITY

The plugin’s priority: 20. Plugins with a lower priority are enabled first.

SETTING_KEYS

Source code

Autofill.SETTING_KEYS

The options that update the plugin when you pass them to Core#updateSettings: ['fillHandle'].

SETTINGS_VALIDATORS

Source code

Autofill.SETTINGS_VALIDATORS

Returns validator functions for each plugin setting to verify their values are valid before applying them.

Methods

destroy

Source code

autofill.destroy()

Destroys the plugin instance.

disablePlugin

Source code

autofill.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

autofill.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Source code

autofill.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the Handsontable settings.

onUpdateSettings

Source code

autofill.onUpdateSettings(newSettings)

Applies new settings, marking the call so the plugin toggles it causes leave the render to updateSettings().

ParamTypeDescription
newSettingsobjectNew set of settings passed to the updateSettings() method.

updatePlugin

Source code

autofill.updatePlugin()

Updates the plugin’s state.

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