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

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

import { DataSet } from '../types';
/**
 *  Provides run-time access to Data Sets
 */
export interface DataSetApi {
    /**
     * Retrieves the Data Sets from Data Set Options
     * @returns data Sets
     */
    getDataSets(): DataSet[];
    /**
     * Retrieves the currently applied Data Set
     * @returns data Set
     */
    getCurrentDataSet(): DataSet | undefined;
    /**
     * Retreives Data Set from State with given name
     * @param dataSetName name of Data Set to retrieve
     * @returns data Set
     */
    getDataSetByName(dataSetName: string): DataSet;
    /**
     * Loads the given Data Set (makes it the Current one)
     * @param dataSetName Name of Data Set to load
     */
    setDataSet(dataSetName: string): void;
    /**
     * Clears currently selected Data Set
     */
    clearCurrentDataSet(): void;
    /**
     * Opens Settings Panel with Data Set section selected and visible
     */
    openDataSetSettingsPanel(): void;
}