ColumnSummary

Options

columnSummary

Ask AI

Source code

columnSummary.columnSummary : Array<object> | function

The columnSummary option configures the ColumnSummary plugin.

You can set the columnSummary option to an array of objects. Each object configures a single column summary, using the following properties:

Property	Possible values	Description
sourceColumn	A number	Column to summarize
ranges	An array	Ranges of rows to summarize
type	'sum' | 'min' | 'max' | 'count' | 'average' | 'custom'	Summary function
destinationRow	A number	Destination cell’s row coordinate
destinationColumn	A number	Destination cell’s column coordinate
forceNumeric	true | false	Treat non-numerics as numerics
reversedRowCoords	true | false	Reverse row coordinates
suppressDataTypeErrors	true | false	Suppress data type errors
readOnly	true | false	Make summary cell read-only
roundFloat	true | false | A number	Round summary result
customFunction	A function	Custom summary function

Read more:

• Column summary

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: undefined
Example

columnSummary: [
  {
    sourceColumn: 0,
    ranges: [
      [0, 2], [4], [6, 8]
    ],
    type: 'custom',
    destinationRow: 4,
    destinationColumn: 1,
    forceNumeric: true,
    reversedRowCoords: true,
    suppressDataTypeErrors: false,
    readOnly: true,
    roundFloat: false,
    customFunction(endpoint) {
       return 100;
    }
  }
],

Members

PLUGIN_KEY

Ask AI

Source code

ColumnSummary.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

ColumnSummary.PLUGIN_PRIORITY

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

Methods

disablePlugin

Ask AI

Source code

columnSummary.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

columnSummary.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

Source code

columnSummary.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 then the ColumnSummary#enablePlugin method is called.

updatePlugin

Ask AI

Source code

columnSummary.updatePlugin()

Updates the plugin’s state.

This method is executed when updateSettings() is invoked with any of the following configuration options:

• columnSummary