JavaScript Data GridBasePlugin
Members
DEFAULT_SETTINGS
Source codeBasePlugin.DEFAULT_SETTINGS ⇒ object
The DEFAULT_SETTINGS
getter defines the plugin default settings.
enabled
Source codebasePlugin.enabled : boolean
eventManager
Source codebasePlugin.eventManager : EventManager
The instance of the EventManager class.
initialized
Source codebasePlugin.initialized : boolean
isPluginsReady
Source codebasePlugin.isPluginsReady : boolean
pluginName
Source codebasePlugin.pluginName : string
pluginsInitializedCallbacks
Source codebasePlugin.pluginsInitializedCallbacks : Array<function()>
SETTING_KEYS
Source codeBasePlugin.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 allupdateSettings
calls, regardless of the contents of the config object. - When it returns
false
, the plugin never updates onupdateSettings
calls.
Methods
addHook
Source codebasePlugin.addHook(name, callback, [orderIndex])
Add listener to plugin hooks system.
Param | Type | Description |
---|---|---|
name | string | The hook name. |
callback | function | The listener function to add. |
[orderIndex] | number | optional Order index of the callback. If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower. If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher. If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes. |
callOnPluginsReady
Source codebasePlugin.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 codebasePlugin.clearHooks()
Clear all hooks.
destroy
Source codebasePlugin.destroy()
Destroy plugin.
disablePlugin
Source codebasePlugin.disablePlugin()
Disable plugin for this Handsontable instance.
enablePlugin
Source codebasePlugin.enablePlugin()
Enable plugin for this Handsontable instance.
getSetting
Source codebasePlugin.getSetting([settingName]) ⇒ *
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. |
removeHooks
Source codebasePlugin.removeHooks(name)
Remove all hooks listeners by hook name.
Param | Type | Description |
---|---|---|
name | string | The hook name. |