CellSummaryApi
The summary calculated for the selected cells, such as sum or average, and the value it produces.
TypeScript
export interfaceMethods
| Method | Returns | Description |
|---|---|---|
| getCellSummaryOperationValue(operation) | any | The result of a summary operation for the current selection. |
| getCurrentCellSummaryOperation() | CustomCellSummaryOperation | string | Retrieves currently selected Cell Summary Operation |
| getCurrentCellSummaryOperationValue() | number | Retrieves the value of the current selected Cell Summary Operation |
| getCustomCellSummaryOperations() | CustomCellSummaryOperation[] | Retrieves all Custom Cell Summary Operations |
| openCellSummaryPopupSettingsPanel() | void | Opens Cell Summary Settings Panel with |
| setCurrentCellSummaryOperation(operation) | void | Selects which summary to show for the current cell selection. |
Method Details
getCellSummaryOperationValue
The result of a summary operation for the current selection.
TypeScript
getCellSummaryOperationValue(operation: CustomCellSummaryOperation | string): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| operation | CustomCellSummaryOperation | string | Operation to evaluate |
Returns
The result of a summary operation for the current selection
any
getCurrentCellSummaryOperation
Retrieves currently selected Cell Summary Operation
TypeScript
getCurrentCellSummaryOperation(): CustomCellSummaryOperation | string;Returns
Currently selected Cell Summary Operation
CustomCellSummaryOperation | string
getCurrentCellSummaryOperationValue
Retrieves the value of the current selected Cell Summary Operation
TypeScript
getCurrentCellSummaryOperationValue(): number;Returns
The value of the current selected Cell Summary Operation
number
getCustomCellSummaryOperations
Retrieves all Custom Cell Summary Operations
TypeScript
getCustomCellSummaryOperations(): CustomCellSummaryOperation[];Returns
All Custom Cell Summary Operations
openCellSummaryPopupSettingsPanel
Opens Cell Summary Settings Panel with
TypeScript
openCellSummaryPopupSettingsPanel(): void;Returns
void
setCurrentCellSummaryOperation
Selects which summary to show for the current cell selection.
TypeScript
setCurrentCellSummaryOperation(operation: CustomCellSummaryOperation | string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| operation | CustomCellSummaryOperation | string | Operation name, or a custom operation |
Returns
void