Methods

Source code

destroy()

Destroys the plugin instance.

Source code

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

Source code

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

Source code

getCellValue(row, column){*}

Returns cell value (evaluated from formula expression) at specified cell coords.

Parameters:

Name	Type	Description
row	Number	Row index.
column	Number	Column index.

Returns: {*}

Source code

getVariable(name){*}

Returns variable name.

Parameters:

Name	Type	Description
name	String	Variable name.

Returns: {*}

Source code

hasComputedCellValue(row, column){Boolean}

Checks if there are any formula evaluations made under specific cell coords.

Parameters:

Name	Type	Description
row	Number	Row index.
column	Number	Column index.

Returns: {Boolean}

Source code

isEnabled(){Boolean}

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit
hook and if it returns true than the Formulas#enablePlugin method is called.

Returns: {Boolean}

Source code

recalculate()

Recalculates all formulas (an algorithm will choose the best method of calculation).

Source code

recalculateFull()

Recalculates all formulas (rebuild dependencies from scratch - slow approach).

Source code

recalculateOptimized()

Recalculates all formulas (recalculate only changed cells - fast approach).

Source code

setVariable(name, value)

Sets predefined variable name which can be visible while parsing formula expression.

Parameters:

Name	Type	Description
name	String	Variable name.
value	*	Variable value.