@adaptabletools/adaptable/src/Api/CellSummaryApi.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { CustomCellSummaryOperation } from '../AdaptableState/Common/CellSummary';
/**
 *  Provides run-time access to the Cell Summary Module
 */
export interface CellSummaryApi {
    /**
     * Retrieves all Custom Cell Summary Operations
     */
    getCustomCellSummaryOperations(): CustomCellSummaryOperation[];
    /**
     * Retrieves currently selected Cell Summary Operation
     */
    getCurrentCellSummaryOperation(): CustomCellSummaryOperation | string;
    /**
     * Sets the currently selected Cell Summary Operation
     */
    setCurrentCellSummaryOperation(operation: CustomCellSummaryOperation | string): void;
    /**
     * Opens Cell Summary Settings Panel with
     */
    openCellSummaryPopupSettingsPanel(): void;
    /**
     * Retrieves the value of the current selected Cell Summary Operation
     */
    getCurrentCellSummaryOperationValue(): number;
    /**
     * Retrieves the value of the given Cell Summary Operation
     */
    getCellSummaryOperationValue(operation: CustomCellSummaryOperation | string): any;
}