ColumnSummary
See the Column summary guide for examples and configuration details.
Options
columnSummary
Can be set at: grid
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 |
includeSummaryResults | true | false | Include other summary results |
customFunction | A function | Custom summary function |
Read more:
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
LICENSE
ColumnSummary.LICENSE
Returns the license token of the plugin, its display name, where it is checked, and the tokens it requires.
PLUGIN_KEY
ColumnSummary.PLUGIN_KEY
Returns the plugin key used to identify this plugin in Handsontable settings.
PLUGIN_PRIORITY
ColumnSummary.PLUGIN_PRIORITY
Returns the priority order used to determine the order in which plugins are initialized.
Methods
disablePlugin
columnSummary.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
When the settings turn the plugin off (not the disable step of updatePlugin()), the data the grid
holds gets its destination values back, so it sums the same input when the plugin comes back.
enablePlugin
columnSummary.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
isEnabled
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
columnSummary.updatePlugin()
Updates the plugin’s state.
This method is executed when updateSettings() is invoked with any of the following configuration options:
The endpoints are computed in the ready step, once the call returns and the data is loaded. While
core applies the settings ahead of their data (isDataWorkDeferred()), onDataReady() computes them.