Formulas

This plugin allows you to perform Excel-like calculations in your business applications. It does it by an
integration with our other product, HyperFormula, which is a
powerful calculation engine with an extensive number of features.

Members

engineHyperFormula null

The engine instance that will be used for this instance of Handsontable.

sheetIdnumber null

HyperFormula's sheet id.

sheetNamestring null

HyperFormula's sheet name.

Methods

addSheet(sheetName, sheetData){boolean|string}

Add a sheet to the shared HyperFormula instance.

Parameters:
Name Type Description
sheetName string | null optional

The new sheet name. If not provided (or a null is passed), will be
auto-generated by HyperFormula.

sheetData Array optional

Data passed to the shared HyperFormula instance. Has to be declared as an array of
arrays - array of objects is not supported in this scenario.

Returns: {boolean|string} false if the data format is unusable or it is impossible to add a new sheet to the
engine, the created sheet name otherwise.

destroy()

Destroys the plugin instance.

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getCellType(row, column, sheet){string}

Get the cell type under specified visual coordinates.

Parameters:
Name Type Description
row number

Visual row index.

column number

Visual column index.

sheet number optional

The target sheet id, defaults to the current sheet.

Returns: {string} Possible values: 'FORMULA' | 'VALUE' | 'MATRIX' | 'EMPTY'.

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}

isFormulaCellType(row, column, sheet){boolean}

Returns true if under specified visual coordinates is formula.

Parameters:
Name Type Description
row number

Visual row index.

column number

Visual column index.

sheet number optional

The target sheet id, defaults to the current sheet.

Returns: {boolean}

switchSheet(sheetName)

Switch the sheet used as data in the Handsontable instance (it loads the data from the shared HyperFormula
instance).

Parameters:
Name Type Description
sheetName string

Sheet name used in the shared HyperFormula instance.

Class: Formulas