Cell Summaries Technical Reference
Cell Summary Options
CellSummaryOptions
Options to provide custom Cell Summary Operations & Display Formats
Custom Numeric Cell Summary Operations to add to set shipped by AdapTable
NumberFormatterOptions| ((columnContext:AdaptableColumnContext) =>NumberFormatterOptions)
Numeric format to use for summary value; a Format Column DisplayFormat will take precedence
FractionDigits: 2
numericDisplayFormat is a NumberFormatterOptions:
NumberFormatterOptions
Formatter Options for Numeric Columns
BaseFormatterOptions
boolean
Returns absolute value of cell value
boolean
Returns smallest integer greater than cell value
string | number
Replaces cell value with supplied value (that can contain Template Literals)
boolean
Show nothing in cell (but underlying value remains)
boolean
Returns largest integer cell value
number
Number of digits to show in Fractions (up to 20)
string
Separator to use in fractions
number
Number of digits to show for Integers (up to 20)
string
Separator to use in Integers
number
Multiplier to use on cell value
'standard' | 'scientific'
Numeric notation to use when rendering the value.
- 'standard' (default) — renders the number normally.
- 'scientific' — renders the number in scientific notation
(e.g. 1.23e+5). When set, IntegerSeparator is ignored
and FractionDigits controls the number of mantissa digits.
boolean
Shows negative numbers in parentheses
string
Prefix to use before cell value
boolean
Rounds cell value
string
Suffix to use after cell value
boolean
Truncates cell value
string
When the numeric value is zero (after multiplier and rounding):
- omitted / undefined, or '0' — use normal formatting (e.g. 0, 0.00)
- '' — show a blank cell (user cleared the default 0 in the wizard)
- any other string — show that text (e.g. -, —)
Cell Summary Operation
CustomCellSummaryOperation
Defines a Custom Cell Summary operation provided by a user
(operationContext:CustomCellSummaryOperationContext<TData>) => any
Function to run when a summary result is required
string
Name of the Operation - will be displayed in the Cell Summary components
operationFunction receives a CustomCellSummaryOperationContext:
CustomCellSummaryOperationContext
Context provided to a custom Cell Summary Operation function
Currently selected cells
Currently selected Column
Custom application Context provided in AdaptableOptions.adaptableContext
Cell Summary API
CellSummaryApi
The summary calculated for the selected cells, such as sum or average, and the value it produces.
any
The result of a summary operation for the current selection.
CustomCellSummaryOperation | string
Retrieves currently selected Cell Summary Operation
number
Retrieves the value of the current selected Cell Summary Operation
Retrieves all Custom Cell Summary Operations
void
Opens Cell Summary Settings Panel with
void
Selects which summary to show for the current cell selection.
Row Summary Definition
Row Summaries are provided as part of Layout Initial Adaptable State.
Each Row Summary is defined as follows:
RowSummary
A pinned row of column summaries in a table layout.
ColumnsMap is required: each key is a column id and each value is a summary name such as 'SUM' or 'AVG'. Position is 'Top' or 'Bottom'; omit it to pin the row to the bottom. IncludeOnlyFilteredRows defaults to true, so the summary uses the rows that pass the current filter. Suspend with IsSuspended. Requires AG Grid PinnedRowModule.
Record<string, SummarySupportedExpression>
Column id to summary name. Each value is a , for example 'SUM' or 'AVG'.
'Top' pins the summary above the rows. 'Bottom' pins it below them. When omitted, the summary is pinned to the bottom.
boolean
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
boolean
Suspends (i.e. turns off) an Adaptable Object
Position is a RowSummaryPosition:
| Value |
|---|
'Top' |
'Bottom' |