Skip to content

Members

DEFAULT_SETTINGS

Source code

Loading.DEFAULT_SETTINGS

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

PLUGIN_KEY

Source code

Loading.PLUGIN_KEY

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

PLUGIN_PRIORITY

Source code

Loading.PLUGIN_PRIORITY

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

SETTINGS_VALIDATORS

Source code

Loading.SETTINGS_VALIDATORS

Returns an object of validator functions used to type-check each settings property at runtime.

Methods

destroy

Source code

loading.destroy()

Destroy plugin instance.

disablePlugin

Source code

loading.disablePlugin()

Disable plugin for this Handsontable instance.

enablePlugin

Source code

loading.enablePlugin()

Enable plugin for this Handsontable instance.

hide

Source code

loading.hide()

Hide loading dialog.

isEnabled

Source code

loading.isEnabled() ⇒ boolean

Check if the plugin is enabled in the handsontable settings.

isVisible

Source code

loading.isVisible() ⇒ boolean

Check if loading dialog is currently visible.

show

Source code

loading.show(options)

Show loading dialog with optional custom options.

ParamTypeDescription
optionsobjectCustom loading options.
options.iconstringCustom loading icon.
options.titlestringCustom loading title.
options.descriptionstringCustom loading description.

update

Source code

loading.update(options)

Update loading description without hiding/showing the dialog.

ParamTypeDescription
optionsobjectCustom loading options.
options.iconstringCustom loading icon.
options.titlestringCustom loading title.
options.descriptionstringCustom loading description.

updatePlugin

Source code

loading.updatePlugin()

Update plugin state after Handsontable settings update.