The Cell Summary Module allows you to see - at a glance - summary information about the cells (and rows) you have selected in AdapTable.
Simply select a group of cells and you can see the summary information about those cells in the Cell Summary Toolbar and / or Tool Panel
AdapTable Cell Summary Operations
AdapTable ships with a large set of common Summary Operations.
If you have installed the Finance Plugin then extra finance-related Operations are available.
You can provide your own Summary Operations in General Options
|Sum||Numeric||Total of all selected cells|
|Average||Numeric||Average of all selected cells|
|Median||Numeric||Middle (value) of all selected cells (when ordered)|
|Mode||Numeric||Most common value|
|Distinct||All||Count of distinct selected cell values|
|Max||Numeric||Highest selected Cell Value|
|Min||Numeric||Lowest selected Cell Value|
|Count||All||Number of selected cells|
If using the Finance Plugin the additional Cell Summary Operations are available:
|Only||Numeric||Returns true if all selected cells match (single column only)|
|WeightedAverage||Numeric||Calculates the Weighted Average (is using a Weighted Average Column)|
Custom Cell Summary Operations
Developers can provide custom Cell Summary Operations at design-time via the
cellSummaryOperations property in General Options.
The CellSummaryOperation is defined as follows:
|operationFunction||Function to run when summary result is required|
|operationName||Name of the Operation - will be displayed in the Cell Summary dropdowns.|
operationFunction receives the following information about what is currently selected:
- a Selected Cell Info object
- list of values
- numeric columns
- numeric values and much else
- count of selected items
and returns a single value to be displayed in the dropdown:
Custom Cell Summary Example
Cell Summary includes the following UI Elements:
Popup - Shows all the Cell Summary Operation results for the selected cells
Toolbar - Displays the result of the curently selected Cell Summary Operation (available through a dropdown). Choose a different item in the dropdown to see a different operation, or click on the 'info' button to see all the Operations.
Tool Panel - Same as Toolbar above.
Context Menu -
See Cell SummaryMenu Item opens Cell Summary popup (only visible if selected cells are editable).
The ReadOnly Entitlement behaviour is the same as if the Access Level was
Cell Summary API Methods
|getCellSummaryOperationDefinitions()||Retrieves all Cell Summary Definitions from Cell Summary State|
|getCurrentCellSummaryOperation()||Retrieves currently selected Cell Summary Operation|
|showCellSummaryPopup()||Opens Cell Summary popup screen|
See API documentation for full details of all available functions with lists of parameters
Can we add our own Summary Operations?
Yes, you can provide them in
cellSummaryOperationDefinitions property ofGeneral Options.
Can we see Financial Operations?
Yes, if you use the AdapTable Finance Plugin