BasePlugin

Members

DEFAULT_SETTINGS

Ask AI

Source code

BasePlugin.DEFAULT_SETTINGS ⇒ object

The DEFAULT_SETTINGS getter defines the plugin default settings.

enabled

Ask AI

Source code

basePlugin.enabled : boolean

eventManager

Ask AI

Source code

basePlugin.eventManager : EventManager

The instance of the EventManager class.

initialized

Ask AI

Source code

basePlugin.initialized : boolean

isPluginsReady

Ask AI

Source code

basePlugin.isPluginsReady : boolean

pluginName

Ask AI

Source code

basePlugin.pluginName : string

pluginsInitializedCallbacks

Ask AI

Source code

basePlugin.pluginsInitializedCallbacks : Array<function()>

SETTING_KEYS

Ask AI

Source code

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.

SETTINGS_VALIDATORS

Ask AI

Source code

BasePlugin.SETTINGS_VALIDATORS : function | object | null

Validators for plugin settings.

Methods

callOnPluginsReady

Ask AI

Source code

basePlugin.callOnPluginsReady(callback)

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

Param	Type	Description
callback	function	The listener function to add.

clearHooks

Ask AI

Source code

basePlugin.clearHooks()

Clear all hooks.

destroy

Ask AI

Source code

basePlugin.destroy()

Destroy plugin.

disablePlugin

Ask AI

Source code

basePlugin.disablePlugin()

Disable plugin for this Handsontable instance.

enablePlugin

Ask AI

Source code

basePlugin.enablePlugin()

Enable plugin for this Handsontable instance.

getSetting

Ask AI

Source code

basePlugin.getSetting([settingName]) ⇒ T

Gets the plugin settings. If there is no setting under the provided key, it returns the default setting provided by the DEFAULT_SETTINGS static property of the class.

Param	Type	Description
[settingName]	string	optional The setting name. If the setting name is not provided, it returns the whole plugin’s settings object.

isHardConflictBlocked

Ask AI

Source code

basePlugin.isHardConflictBlocked() ⇒ boolean

Whether this plugin is blocked by a registered hard conflict (another top-level setting is truthy; for example nestedRows blocks pagination, or manualRowMove blocks dataProvider). Emits a console warning when blocked.

Returns: boolean - true if the plugin must not enable.

removeHooks

Ask AI

Source code

basePlugin.removeHooks(name)

Remove all hooks listeners by hook name.

Param	Type	Description
name	string	The hook name.

updatePluginSettings

Ask AI

Source code

basePlugin.updatePluginSettings(newSettings) ⇒ object

Update plugin settings.

Param	Type	Description
newSettings	*	New settings.

Returns: object - Updated settings object.