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,