# Cell Summaries Technical Reference Canonical page: https://www.adaptabletools.com/docs/technical-reference-summarising ## Cell Summary Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [customCellSummaryOperations](https://www.adaptabletools.com/docs/reference/cellsummaryoptions.md#customcellsummaryoperations) | [`CustomCellSummaryOperation`](https://www.adaptabletools.com/docs/reference/customcellsummaryoperation.md)`[]` | Custom Numeric Cell Summary Operations to add to set shipped by AdapTable | | | [numericDisplayFormat](https://www.adaptabletools.com/docs/reference/cellsummaryoptions.md#numericdisplayformat) | [`NumberFormatterOptions`](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md)` \| ((columnContext: `[`AdaptableColumnContext`](https://www.adaptabletools.com/docs/reference/adaptablecolumncontext.md)`) => `[`NumberFormatterOptions`](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md)`)` | Numeric format to use for summary value; a Format Column DisplayFormat will take precedence | FractionDigits: 2 | `numericDisplayFormat` is a [`NumberFormatterOptions`](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md): | Property | Type | Description | | --- | --- | --- | | [Abs](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#abs) | `boolean` | Returns absolute value of cell value | | [Ceiling](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#ceiling) | `boolean` | Returns smallest integer greater than cell value | | [Content](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#content) | `string \| number` | Replaces cell value with supplied value (that can contain Template Literals) | | [Empty](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#empty) | `boolean` | Show nothing in cell (but underlying value remains) | | [Floor](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#floor) | `boolean` | Returns largest integer cell value | | [FractionDigits](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#fractiondigits) | `number` | Number of digits to show in Fractions (up to 20) | | [FractionSeparator](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#fractionseparator) | `string` | Separator to use in fractions | | [IntegerDigits](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#integerdigits) | `number` | Number of digits to show for Integers (up to 20) | | [IntegerSeparator](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#integerseparator) | `string` | Separator to use in Integers | | [Multiplier](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#multiplier) | `number` | Multiplier to use on cell value | | [Notation](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#notation) | `'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. | | [Parentheses](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#parentheses) | `boolean` | Shows negative numbers in parentheses | | [Prefix](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#prefix) | `string` | Prefix to use before cell value | | [Round](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#round) | `boolean` | Rounds cell value | | [Suffix](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#suffix) | `string` | Suffix to use after cell value | | [Truncate](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#truncate) | `boolean` | Truncates cell value | | [ZeroDisplay](https://www.adaptabletools.com/docs/reference/numberformatteroptions.md#zerodisplay) | `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 | Property | Type | Description | | --- | --- | --- | | [operationFunction](https://www.adaptabletools.com/docs/reference/customcellsummaryoperation.md#operationfunction) | `(operationContext: `[`CustomCellSummaryOperationContext`](https://www.adaptabletools.com/docs/reference/customcellsummaryoperationcontext.md)`) => any` | Function to run when a summary result is required | | [operationName](https://www.adaptabletools.com/docs/reference/customcellsummaryoperation.md#operationname) | `string` | Name of the Operation - will be displayed in the Cell Summary components | `operationFunction` receives a [`CustomCellSummaryOperationContext`](https://www.adaptabletools.com/docs/reference/customcellsummaryoperationcontext.md): | Property | Type | Description | | --- | --- | --- | | [selectedCellInfo](https://www.adaptabletools.com/docs/reference/customcellsummaryoperationcontext.md#selectedcellinfo) | [`SelectedCellInfo`](https://www.adaptabletools.com/docs/reference/selectedcellinfo.md)`` | Currently selected cells | | [selectedColumn](https://www.adaptabletools.com/docs/reference/customcellsummaryoperationcontext.md#selectedcolumn) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md) | Currently selected Column | | [adaptableContext](https://www.adaptabletools.com/docs/reference/customcellsummaryoperationcontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | -------------- ## Cell Summary API | Method | Returns | Description | | --- | --- | --- | | [getCellSummaryOperationValue(operation)](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#getcellsummaryoperationvalue) | `any` | The result of a summary operation for the current selection. | | [getCurrentCellSummaryOperation()](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#getcurrentcellsummaryoperation) | [`CustomCellSummaryOperation`](https://www.adaptabletools.com/docs/reference/customcellsummaryoperation.md)` \| string` | Retrieves currently selected Cell Summary Operation | | [getCurrentCellSummaryOperationValue()](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#getcurrentcellsummaryoperationvalue) | `number` | Retrieves the value of the current selected Cell Summary Operation | | [getCustomCellSummaryOperations()](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#getcustomcellsummaryoperations) | [`CustomCellSummaryOperation`](https://www.adaptabletools.com/docs/reference/customcellsummaryoperation.md)`[]` | Retrieves all Custom Cell Summary Operations | | [openCellSummaryPopupSettingsPanel()](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#opencellsummarypopupsettingspanel) | `void` | Opens Cell Summary Settings Panel with | | [setCurrentCellSummaryOperation(operation)](https://www.adaptabletools.com/docs/reference/cellsummaryapi.md#setcurrentcellsummaryoperation) | `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](https://www.adaptabletools.com/docs/technical-reference-layouts/index.md). Each Row Summary is defined as follows: | Property | Type | Description | Default | | --- | --- | --- | --- | | [ColumnsMap](https://www.adaptabletools.com/docs/reference/rowsummary.md#columnsmap) | `Record` | Column id to summary name. Each value is a , for example `'SUM'` or `'AVG'`. | | | [IncludeOnlyFilteredRows](https://www.adaptabletools.com/docs/reference/rowsummary.md#includeonlyfilteredrows) | `boolean` | Evaluates only currently filtered rows in the summary | true | | [Position](https://www.adaptabletools.com/docs/reference/rowsummary.md#position) | [`RowSummaryPosition`](https://www.adaptabletools.com/docs/reference/rowsummaryposition.md) | `'Top'` pins the summary above the rows. `'Bottom'` pins it below them. When omitted, the summary is pinned to the bottom. | | | [IsReadOnly](https://www.adaptabletools.com/docs/reference/rowsummary.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') | | | [IsSuspended](https://www.adaptabletools.com/docs/reference/rowsummary.md#issuspended) | `boolean` | Suspends (i.e. turns off) an Adaptable Object | | `Position` is a [`RowSummaryPosition`](https://www.adaptabletools.com/docs/reference/rowsummaryposition.md): [See API: rowsummaryposition](https://www.adaptabletools.com/docs/reference/rowsummaryposition.md)