# BasePlugin

# Members

# SETTING_KEYS

Source code (opens new window)

BasePlugin.SETTING_KEYS ⇒ Array<string> | boolean

The SETTING_KEYS getter defines the keys that, when present in the config object, trigger the plugin update after the updateSettings calls.

  • When it returns true, the plugin updates after all updateSettings calls, regardless of the contents of the config object.
  • When it returns false, the plugin never updates on updateSettings calls.

# Methods

# addHook

Source code (opens new window)

basePlugin.addHook(name, callback)

Add listener to plugin hooks system.

Param Type Description
name string The hook name.
callback function The listener function to add.

# callOnPluginsReady

Source code (opens new window)

basePlugin.callOnPluginsReady(callback)

Register function which will be immediately called after all plugins initialized.

Param Type Description
callback function The listener function to call.

# clearHooks

Source code (opens new window)

basePlugin.clearHooks()

Clear all hooks.

# destroy

Source code (opens new window)

basePlugin.destroy()

Destroy plugin.

# disablePlugin

Source code (opens new window)

basePlugin.disablePlugin()

Disable plugin for this Handsontable instance.

# enablePlugin

Source code (opens new window)

basePlugin.enablePlugin()

Enable plugin for this Handsontable instance.

# removeHooks

Source code (opens new window)

basePlugin.removeHooks(name)

Remove all hooks listeners by hook name.

Param Type Description
name string The hook name.
Last Updated: May 24, 2022