ag-grid-community/dist/types/src/api/gridApi.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import type { ApplyColumnStateParams, ColumnState } from '../columns/columnStateUtils';
import type { RowDropZoneEvents, RowDropZoneParams } from '../dragAndDrop/rowDragFeature';
import type { ColDef, ColGroupDef, ColumnChooserParams, HeaderLocation, IAggFunc } from '../entities/colDef';
import type { ChartRef, GridOptions, SelectAllMode } from '../entities/gridOptions';
import type { AgPublicEventType } from '../eventTypes';
import type { AgEvent, AgEventListener, AgGlobalEventListener, ColumnEventType, FilterChangedEventSourceType, SelectionEventSourceType } from '../events';
import type { ManagedGridOptionKey, ManagedGridOptions } from '../gridOptionsInitial';
import type { ChartDownloadParams, ChartModel, CloseChartToolPanelParams, CreateCrossFilterChartParams, CreatePivotChartParams, CreateRangeChartParams, GetChartImageDataUrlParams, OpenChartToolPanelParams, UpdateChartParams } from '../interfaces/IChartService';
import type { CellRange, CellRangeParams } from '../interfaces/IRangeService';
import type { ServerSideGroupLevelState } from '../interfaces/IServerSideStore';
import type { AdvancedFilterModel } from '../interfaces/advancedFilterModel';
import type { ISizeColumnsToFitParams } from '../interfaces/autoSize';
import type { CsvExportParams } from '../interfaces/exportParams';
import type { GridState } from '../interfaces/gridState';
import type { RenderedRowEvent } from '../interfaces/iCallbackParams';
import type { GetCellEditorInstancesParams, ICellEditor } from '../interfaces/iCellEditor';
import type { CellPosition } from '../interfaces/iCellPosition';
import type { FlashCellsParams, RefreshCellsParams } from '../interfaces/iCellsParams';
import type { ClientSideRowModelStep } from '../interfaces/iClientSideRowModel';
import type { IClipboardCopyParams, IClipboardCopyRowsParams } from '../interfaces/iClipboardService';
import type { Column, ColumnGroup, ColumnPinnedType, ProvidedColumnGroup } from '../interfaces/iColumn';
import type { IColumnToolPanel } from '../interfaces/iColumnToolPanel';
import type { IContextMenuParams } from '../interfaces/iContextMenu';
import type { ExcelExportMultipleSheetParams, ExcelExportParams } from '../interfaces/iExcelCreator';
import type { FilterModel, IFilter } from '../interfaces/iFilter';
import type { IFiltersToolPanel } from '../interfaces/iFiltersToolPanel';
import type { FindCellParams, FindCellValueParams, FindMatch, FindPart } from '../interfaces/iFind';
import type { AgModuleName } from '../interfaces/iModule';
import type { RedrawRowsParams } from '../interfaces/iRedrawRowsParams';
import type { IRowNode, RowPinnedType } from '../interfaces/iRowNode';
import type { LoadSuccessParams, RefreshServerSideParams } from '../interfaces/iServerSideRowModel';
import type { IServerSideGroupSelectionState, IServerSideSelectionState } from '../interfaces/iServerSideSelection';
import type { SideBarDef } from '../interfaces/iSideBar';
import type { IStatusPanel } from '../interfaces/iStatusPanel';
import type { IToolPanel } from '../interfaces/iToolPanel';
import type { RowDataTransaction } from '../interfaces/rowDataTransaction';
import type { RowNodeTransaction } from '../interfaces/rowNodeTransaction';
import type { ServerSideTransaction, ServerSideTransactionResult } from '../interfaces/serverSideTransaction';
import type { GetCellRendererInstancesParams, ICellRenderer } from '../rendering/cellRenderers/iCellRenderer';
export interface DetailGridInfo {
    /**
     * Id of the detail grid, the format is `detail_{ROW-ID}`,
     * where `ROW-ID` is the `id` of the parent row.
     */
    id: string;
    /** Grid api of the detail grid. */
    api?: GridApi;
}
export interface StartEditingCellParams {
    /** The row index of the row to start editing */
    rowIndex: number;
    /** The column key of the row to start editing */
    colKey: string | Column;
    /** Set to `'top'` or `'bottom'` to start editing a pinned row */
    rowPinned?: RowPinnedType;
    /** The key to pass to the cell editor */
    key?: string;
}
export interface GetCellValueParams<TValue = any> {
    /** The row node to get the value from */
    rowNode: IRowNode;
    /** The column to get the value from */
    colKey: string | Column<TValue>;
    /** If `true` formatted value will be returned. */
    useFormatter?: boolean;
}
export interface _CoreGridApi<TData = any> {
    /** Returns the `gridId` for the current grid as specified via the gridOptions property `gridId` or the auto assigned grid id if none was provided. */
    getGridId(): string;
    /** Will destroy the grid and release resources. If you are using a framework you do not need to call this, as the grid links in with the framework lifecycle. However if you are using Web Components or native JavaScript, you do need to call this, to avoid a memory leak in your application. */
    destroy(): void;
    /** Returns `true` if the grid has been destroyed. */
    isDestroyed(): boolean;
    /**
     * Returns the grid option value for a provided key.
     */
    getGridOption<Key extends keyof GridOptions<TData>>(key: Key): GridOptions<TData>[Key];
    /**
     * Updates a single gridOption to the new value provided. (Cannot be used on `Initial` properties.)
     * If updating multiple options, it is recommended to instead use `api.updateGridOptions()` which batches update logic.
     */
    setGridOption<Key extends ManagedGridOptionKey>(key: Key, value: GridOptions<TData>[Key]): void;
    /**
     * Updates the provided subset of gridOptions with the provided values. (Cannot be used on `Initial` properties.)
     */
    updateGridOptions<TDataUpdate extends TData>(options: ManagedGridOptions<TDataUpdate>): void;
    /**
     * Check if a Module is registered with the current grid instance via its equivalent string name.
     */
    isModuleRegistered(moduleName: AgModuleName): boolean;
}
export interface _RowSelectionGridApi<TData = any> {
    /**
     * Set all of the provided nodes selection state to the provided value.
     * @agModule `RowSelectionModule`
     */
    setNodesSelected(params: {
        nodes: IRowNode<TData>[];
        newValue: boolean;
        source?: SelectionEventSourceType;
    }): void;
    /**
     * Select all rows. By default this ignores filtering, expansion and pagination settings. Pass the appropriate select all mode as an
     * argument in order to select only rows that satisfy the filter, or those rows on the current page.
     *
     * @param mode SelectAll mode to use. See `SelectAllMode`
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAll'`
     *
     * @agModule `RowSelectionModule`
     */
    selectAll(mode?: SelectAllMode, source?: SelectionEventSourceType): void;
    /**
     * Clear all row selections. By default this ignores filtering, expansion and pagination settings. Pass the appropriate select all mode as an
     * argument in order to select only rows that satisfy the filter, or those rows on the current page.
     *
     * @param mode SelectAll mode to use. See `SelectAllMode`
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAll'`
     *
     * @agModule `RowSelectionModule`
     */
    deselectAll(mode?: SelectAllMode, source?: SelectionEventSourceType): void;
    /**
     * Select all filtered rows.
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAllFiltered'`
     *
     * @deprecated as of v33. Use `selectAll('filtered')` instead
     */
    selectAllFiltered(source?: SelectionEventSourceType): void;
    /**
     * Clear all filtered selections.
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAllFiltered'`
     *
     * @deprecated as of v33. Use `deselectAll('filtered')` instead
     */
    deselectAllFiltered(source?: SelectionEventSourceType): void;
    /**
     * Select all rows on the current page.
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAllCurrentPage'`
     *
     * @deprecated as of v33. Use `selectAll('currentPage')` instead
     */
    selectAllOnCurrentPage(source?: SelectionEventSourceType): void;
    /**
     * Clear all filtered on the current page.
     * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAllCurrentPage'`
     *
     * @deprecated as of v33. Use `deselectAll('currentPage')` instead
     */
    deselectAllOnCurrentPage(source?: SelectionEventSourceType): void;
    /**
     * Returns an unsorted list of selected nodes.
     * Getting the underlying node (rather than the data) is useful when working with tree / aggregated data,
     * as the node can be traversed.
     * @agModule `RowSelectionModule`
     */
    getSelectedNodes(): IRowNode<TData>[];
    /**
     * Returns an unsorted list of selected rows (i.e. row data that you provided).
     * @agModule `RowSelectionModule`
     */
    getSelectedRows(): TData[];
}
export interface _OverlayGridApi {
    /**
     * Show the 'loading' overlay.
     * @deprecated v32 `showLoadingOverlay` is deprecated. Use the grid option "loading"=true instead or setGridOption("loading", true).
     */
    showLoadingOverlay(): void;
    /** Show the no-rows overlay. If `suppressNoRowsOverlay` is set, or if `loading` is true, this will not do anything. */
    showNoRowsOverlay(): void;
    /** Hide the no-rows overlay if it is showing. */
    hideOverlay(): void;
}
export interface _RowGridApi<TData> {
    /**
     * Remove row(s) from the DOM and recreate them again from scratch.
     * @agModule `RowApiModule`
     */
    redrawRows(params?: RedrawRowsParams<TData>): void;
    /**
     * Expand or collapse a specific row node, optionally expanding/collapsing all of its parent nodes.
     * By default rows are expanded asynchronously for best performance. Set `forceSync: true` if you need to interact with the expanded row immediately after this function.
     * @agModule `RowApiModule`
     */
    setRowNodeExpanded(rowNode: IRowNode<TData>, expanded: boolean, expandParents?: boolean, forceSync?: boolean): void;
    /**
     * Returns the row node with the given ID.
     * The row node ID is the one you provide from the callback `getRowId(params)`,
     * otherwise the ID is a number (cast as string) auto-generated by the grid when
     * the row data is set.
     * @agModule `RowApiModule`
     */
    getRowNode(id: string): IRowNode<TData> | undefined;
    /**
     * Registers a callback to a virtual row.
     * A virtual row is a row that is visually rendered on the screen (rows that are not visible because of the scroll position are not rendered).
     * Unlike normal events, you do not need to unregister rendered row listeners.
     * When the rendered row is removed from the grid, all associated rendered row listeners will also be removed.
     * listen for this event if your `cellRenderer` needs to do cleanup when the row no longer exists.
     * @agModule `RowApiModule`
     */
    addRenderedRowListener(eventName: RenderedRowEvent, rowIndex: number, callback: (...args: any[]) => any): void;
    /**
     * Retrieve rendered nodes. Due to virtualisation this will contain only the current visible rows and those in the buffer.
     * @agModule `RowApiModule`
     */
    getRenderedNodes(): IRowNode<TData>[];
    /**
     * Iterates through each node (row) in the grid and calls the callback for each node.
     * This works similar to the `forEach` method on a JavaScript array.
     * This is called for every node, ignoring any filtering or sorting applied within the grid.
     * It is not called on any pinned row nodes.
     * If using the Infinite Row Model, then this gets called for each page loaded in the page cache.
     * @agModule `RowApiModule`
     */
    forEachNode(callback: (rowNode: IRowNode<TData>, index: number) => void, includeFooterNodes?: boolean): void;
    /**
     * Get the index of the first displayed row due to scrolling (includes invisible rendered rows in the buffer).
     * @agModule `RowApiModule`
     */
    getFirstDisplayedRowIndex(): number;
    /**
     * Get the index of the last displayed row due to scrolling (includes invisible rendered rows in the buffer).
     * @agModule `RowApiModule`
     */
    getLastDisplayedRowIndex(): number;
    /**
     * Returns the displayed `RowNode` at the given `index`.
     * @agModule `RowApiModule`
     */
    getDisplayedRowAtIndex(index: number): IRowNode<TData> | undefined;
    /**
     * Returns the total number of displayed rows.
     * @agModule `RowApiModule`
     */
    getDisplayedRowCount(): number;
}
export interface _ScrollGridApi<TData> {
    /**
     * Returns an object with two properties:
     *  - `top`: The top pixel position of the current scroll in the grid
     *  - `bottom`: The bottom pixel position of the current scroll in the grid
     * @agModule `ScrollApiModule`
     */
    getVerticalPixelRange(): {
        top: number;
        bottom: number;
    };
    /**
     * Returns an object with two properties:
     * - `left`: The left pixel position of the current scroll in the grid
     * - `right`: The right pixel position of the current scroll in the grid
     * @agModule `ScrollApiModule`
     */
    getHorizontalPixelRange(): {
        left: number;
        right: number;
    };
    /**
     *  Ensures the column is visible by scrolling the table if needed.
     *
     * This will have no effect before the firstDataRendered event has fired.
     *
     * @param key - The column to ensure visible
     * @param position - Where the column will be positioned. Defaults to `auto`
     * - `auto` - Scrolls the minimum amount to make sure the column is visible.
     * - `start` - Scrolls the column to the start of the viewport.
     * - `middle` - Scrolls the column to the middle of the viewport.
     * - `end` - Scrolls the column to the end of the viewport.
     * @agModule `ScrollApiModule`
     */
    ensureColumnVisible(key: string | Column, position?: 'auto' | 'start' | 'middle' | 'end'): void;
    /**
     * Vertically scrolls the grid until the provided row index is inside the visible viewport.
     * If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport.
     * This will have no effect before the firstDataRendered event has fired.
     * @agModule `ScrollApiModule`
     */
    ensureIndexVisible(index: number, position?: 'top' | 'bottom' | 'middle' | null): void;
    /**
     * Vertically scrolls the grid until the provided row (or a row matching the provided comparator) is inside the visible viewport.
     * If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport.
     * This will have no effect before the firstDataRendered event has fired.
     * @agModule `ScrollApiModule`
     */
    ensureNodeVisible(nodeSelector: TData | IRowNode<TData> | ((row: IRowNode<TData>) => boolean), position?: 'top' | 'bottom' | 'middle' | null): void;
}
export interface _KeyboardNavigationGridApi {
    /** Returns the focused cell (or the last focused cell if the grid lost focus). */
    getFocusedCell(): CellPosition | null;
    /** Clears the focused cell. */
    clearFocusedCell(): void;
    /** Sets the focus to the specified cell. `rowPinned` can be either 'top', 'bottom' or null (for not pinned). */
    setFocusedCell(rowIndex: number, colKey: string | Column, rowPinned?: RowPinnedType): void;
    /** Sets the focus to the specified header. If `floatingFilter` is true, the Column's floatingFilter element will be focused. */
    setFocusedHeader(colKey: string | Column | ColumnGroup, floatingFilter?: boolean): void;
    /** Navigates the grid focus to the next cell, as if tabbing. */
    tabToNextCell(event?: KeyboardEvent): boolean;
    /** Navigates the grid focus to the previous cell, as if shift-tabbing. */
    tabToPreviousCell(event?: KeyboardEvent): boolean;
}
export interface _EventGridApi<TData> {
    /**
     * Add an event listener for the specified `eventType`.
     * Listener will receive the `event` as a single parameter.
     * Listeners will be automatically removed when the grid is destroyed.
     * @example api.addEventListener('rowClicked', (event) => { console.log('Row clicked', event);});
     * @agModule `EventApiModule`
     */
    addEventListener<TEventType extends AgPublicEventType>(eventType: TEventType, listener: AgEventListener<TData, any, TEventType>): void;
    /**
     * Remove an event listener.
     * @agModule `EventApiModule`
     */
    removeEventListener<TEventType extends AgPublicEventType>(eventType: TEventType, listener: AgEventListener<TData, any, TEventType>): void;
    /**
     * Add an event listener for all event types coming from the grid.
     * Listener will receive `eventType` and `event` as parameters.
     * Listeners will be automatically removed when the grid is destroyed.
     * If handling multiple event types it is recommended to use `event.type` to enable TypeScript to infer the event parameters.
     * @example api.addGlobalListener((eventType, event) => { });
     * @agModule `EventApiModule`
     */
    addGlobalListener<TEventType extends AgPublicEventType>(listener: AgGlobalEventListener<TData, any, TEventType>): void;
    /**
     * Remove a global event listener.
     * @agModule `EventApiModule`
     */
    removeGlobalListener<TEventType extends AgPublicEventType>(listener: AgGlobalEventListener<TData, any, TEventType>): void;
}
export interface _ValueCacheApi {
    /**
     * Expire the value cache.
     *  @agModule `ValueCacheModule`
     */
    expireValueCache(): void;
}
export interface _ValueApi<TData> {
    /**
     * Gets the cell value for the given column and `rowNode` (row).
     * Based on params.useFormatter with either return the value as specified by the `field` or `valueGetter` on the column definition or the formatted value.
     * @agModule `CellApiModule`
     */
    getCellValue<TValue = any>(params: {
        rowNode: IRowNode<TData>;
        colKey: string | Column<TValue>;
        useFormatter: true;
    }): string | null | undefined;
    getCellValue<TValue = any>(params: GetCellValueParams<TValue>): TValue | null | undefined;
    getCellValue<TValue = any>(params: GetCellValueParams<TValue>): string | TValue | null | undefined;
    getCellValue<TValue = any>(params: GetCellValueParams<TValue>): string | TValue | null | undefined;
}
export interface _CommunityMenuGridApi {
    /** Show the column menu for the provided column. */
    showColumnMenu(colKey: string | Column): void;
    /** Hides any visible context menu or column menu. */
    hidePopupMenu(): void;
}
export interface _SortGridApi {
    /**
     * Gets the grid to act as if the sort was changed.
     * Useful if you update some values and want to get the grid to reorder them according to the new values.
     */
    onSortChanged(): void;
}
export interface _ClientSideRowModelGridApi<TData> {
    /**
     * Informs the grid that row group expanded state has changed and it needs to rerender the group nodes.
     * Typically called after updating the row node expanded state explicitly, i.e `rowNode.expanded = false`,
     * across multiple groups and you want to update the grid view in a single rerender instead of on every group change.
     * @agModule `ClientSideRowModelApiModule`
     */
    onGroupExpandedOrCollapsed(): void;
    /**
     * Refresh the Client-Side Row Model, executing the grouping, filtering and sorting again.
     * Optionally provide the step you wish the refresh to apply from. Defaults to `everything`.
     * @agModule `ClientSideRowModelApiModule`
     */
    refreshClientSideRowModel(step?: ClientSideRowModelStep): void;
    /**
     * Similar to `forEachNode`, except lists all the leaf nodes.
     * This effectively goes through all the data that you provided to the grid before the grid performed any grouping.
     * If using tree data, goes through all the nodes for the data you provided, including nodes that have children,
     * but excluding groups the grid created where gaps were missing in the hierarchy.
     * @agModule `ClientSideRowModelApiModule`
     */
    forEachLeafNode(callback: (rowNode: IRowNode<TData>) => void): void;
    /**
     * Similar to `forEachNode`, except skips any filtered out data.
     * @agModule `ClientSideRowModelApiModule`
     */
    forEachNodeAfterFilter(callback: (rowNode: IRowNode<TData>, index: number) => void): void;
    /**
     * Similar to `forEachNodeAfterFilter`, except the callbacks are called in the order the rows are displayed in the grid.
     * @agModule `ClientSideRowModelApiModule`
     */
    forEachNodeAfterFilterAndSort(callback: (rowNode: IRowNode<TData>, index: number) => void): void;
    /**
     * Tells the grid to recalculate the row heights.
     * @agModule `ClientSideRowModelApiModule`
     */
    resetRowHeights(): void;
    /**
     * Update row data. Pass a transaction object with lists for `add`, `remove` and `update`.
     * @agModule `ClientSideRowModelApiModule`
     */
    applyTransaction(rowDataTransaction: RowDataTransaction<TData>): RowNodeTransaction<TData> | null | undefined;
    /**
     * Same as `applyTransaction` except executes asynchronously for efficiency.
     * @agModule `ClientSideRowModelApiModule`
     */
    applyTransactionAsync(rowDataTransaction: RowDataTransaction<TData>, callback?: (res: RowNodeTransaction<TData>) => void): void;
    /**
     * Executes any remaining asynchronous grid transactions, if any are waiting to be executed.
     * @agModule `ClientSideRowModelApiModule`
     */
    flushAsyncTransactions(): void;
    /**
     * Returns a list of all selected nodes at 'best cost', a feature to be used with groups / trees.
     * If a group has all its children selected, then the group appears in the result, but not the children.
     * Designed for use with `'children'` as the group selection type, where groups don't actually appear in the selection normally.
     * @agModule `ClientSideRowModelApiModule`
     */
    getBestCostNodeSelection(): IRowNode<TData>[] | undefined;
    /**
     * Returns `true` if the Client-Side row model has no rows. It is not impacted by filtering and does not include pinned rows.
     * @agModule `ClientSideRowModelApiModule`
     */
    isRowDataEmpty(): boolean;
}
export interface _CsrmSsrmSharedGridApi {
    /** Expand all groups. */
    expandAll(): void;
    /** Collapse all groups. */
    collapseAll(): void;
    /** Tells the grid a row height has changed. To be used after calling `rowNode.setRowHeight(newHeight)`. */
    onRowHeightChanged(): void;
}
export interface _SsrmInfiniteSharedGridApi {
    /**
     * Sets the `rowCount` and `maxRowFound` properties.
     * The second parameter, `maxRowFound`, is optional and if left out, only `rowCount` is set.
     * Set `rowCount` to adjust the height of the vertical scroll.
     * Set `maxRowFound` to enable / disable searching for more rows.
     * Use this method if you add or remove rows into the dataset and need to reset the number of rows or instruct the grid that the entire row count is no longer known.
     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
     */
    setRowCount(rowCount: number, maxRowFound?: boolean): void;
    /**
     * Returns an object representing the state of the cache. This is useful for debugging and understanding how the cache is working.
     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
     */
    getCacheBlockState(): any;
    /**
     * Returns `false` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll.
     *
     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
     */
    isLastRowIndexKnown(): boolean | undefined;
}
export interface _ColumnAutosizeApi {
    /**
     * Adjusts the size of columns to fit the available horizontal space.
     *
     * Note: it is not recommended to call this method rapidly e.g. in response
     * to window resize events or as the container size is animated. This can
     * cause the scrollbar to flicker. Use column flex for smoother results.
     *
     * If inferring cell data types with custom column types
     * and row data is initially empty or yet to be set,
     * the column sizing will happen asynchronously when row data is added.
     * To always perform this synchronously, set `cellDataType = false` on the default column definition.
     * @agModule `ColumnAutoSizeModule`
     **/
    sizeColumnsToFit(paramsOrGridWidth?: ISizeColumnsToFitParams | number): void;
    /**
     * Auto-sizes columns based on their contents. If inferring cell data types with custom column types
     * and row data is initially empty or yet to be set,
     * the column sizing will happen asynchronously when row data is added.
     * To always perform this synchronously, set `cellDataType = false` on the default column definition.
     * @agModule `ColumnAutoSizeModule`
     */
    autoSizeColumns(keys: (string | ColDef | Column)[], skipHeader?: boolean): void;
    /**
     * Calls `autoSizeColumns` on all displayed columns. If inferring cell data types with custom column types
     * and row data is initially empty or yet to be set,
     * the column sizing will happen asynchronously when row data is added.
     * To always perform this synchronously, set `cellDataType = false` on the default column definition.
     * @agModule `ColumnAutoSizeModule`
     */
    autoSizeAllColumns(skipHeader?: boolean): void;
}
export interface _ColumnResizeApi {
    /** Sets the column widths of the columns provided. The finished flag gets included in the resulting event and not used internally by the grid. The finished flag is intended for dragging, where a dragging action will produce many `columnWidth` events, so the consumer of events knows when it receives the last event in a stream. The finished parameter is optional, and defaults to `true`. */
    setColumnWidths(columnWidths: {
        key: string | ColDef | Column;
        newWidth: number;
    }[], finished?: boolean, source?: ColumnEventType): void;
}
export interface _ColumnMoveApi {
    /** Moves the column at `fromIdex` to `toIndex`. The column is first removed, then added at the `toIndex` location, thus index locations will change to the right of the column after the removal. */
    moveColumnByIndex(fromIndex: number, toIndex: number): void;
    /** Moves columns to `toIndex`. The columns are first removed, then added at the `toIndex` location, thus index locations will change to the right of the column after the removal. */
    moveColumns(columnsToMoveKeys: (string | ColDef | Column)[], toIndex: number): void;
}
export interface _ColumnHoverApi {
    /**
     * Returns true if the column is currently hovered.
     * @agModule `ColumnHoverModule`
     */
    isColumnHovered(column: Column): boolean;
}
export interface _ColumnGridApi<TData> {
    /**
     * Returns the current column definitions.
     * @agModule `ColumnApiModule`
     */
    getColumnDefs(): (ColDef<TData> | ColGroupDef<TData>)[] | undefined;
    /**
     * Returns the column definition with the given `colKey`, which can either be the `colId` (a string) or the column instance.
     * @agModule `ColumnApiModule`
     */
    getColumnDef<TValue = any>(key: string | Column<TValue>): ColDef<TData, TValue> | null;
    /**
     * Returns the display name for a column. Useful if you are doing your own header rendering and want the grid to work out if `headerValueGetter` is used, or if you are doing your own column management GUI, to know what to show as the column name.
     * @agModule `ColumnApiModule`
     */
    getDisplayNameForColumn(column: Column, location: HeaderLocation): string;
    /**
     * Returns the column with the given `colKey`, which can either be the `colId` (a string) or the `colDef` (an object).
     * @agModule `ColumnApiModule`
     */
    getColumn<TValue = any>(key: string | ColDef<TData, TValue> | Column<TValue>): Column<TValue> | null;
    /**
     * Returns all the columns, regardless of visible or not.
     * @agModule `ColumnApiModule`
     */
    getColumns(): Column[] | null;
    /**
     * Applies the state of the columns from a previous state. Returns `false` if one or more columns could not be found.
     * @agModule `ColumnApiModule`
     */
    applyColumnState(params: ApplyColumnStateParams): boolean;
    /**
     * Gets the state of the columns. Typically used when saving column state.
     * @agModule `ColumnApiModule`
     */
    getColumnState(): ColumnState[];
    /**
     * Sets the state back to match the originally provided column definitions.
     * @agModule `ColumnApiModule`
     */
    resetColumnState(): void;
    /**
     * Returns `true` if pinning left or right, otherwise `false`.
     * @agModule `ColumnApiModule`
     */
    isPinning(): boolean;
    /**
     * Returns `true` if pinning left, otherwise `false`.
     * @agModule `ColumnApiModule`
     */
    isPinningLeft(): boolean;
    /**
     * Returns `true` if pinning right, otherwise `false`.
     * @agModule `ColumnApiModule`
     */
    isPinningRight(): boolean;
    /**
     * Returns the column to the right of the provided column, taking into consideration open / closed column groups and visible columns. This is useful if you need to know what column is beside yours e.g. if implementing your own cell navigation.
     * @agModule `ColumnApiModule`
     */
    getDisplayedColAfter<TValue = any>(col: Column): Column<TValue> | null;
    /**
     * Same as `getVisibleColAfter` except gives column to the left.
     * @agModule `ColumnApiModule`
     */
    getDisplayedColBefore<TValue = any>(col: Column): Column<TValue> | null;
    /**
     * Sets the visibility of columns. Key can be the column ID or `Column` object.
     * @agModule `ColumnApiModule`
     */
    setColumnsVisible(keys: (string | Column)[], visible: boolean): void;
    /**
     * Set a column's pinned / unpinned state. Key can be the column ID, field, `ColDef` object or `Column` object.
     * @agModule `ColumnApiModule`
     */
    setColumnsPinned(keys: (string | ColDef | Column)[], pinned: ColumnPinnedType): void;
    /**
     * Returns all the grid columns, same as `getColumns()`, except
     *
     *  a) it has the order of the columns that are presented in the grid
     *
     *  b) it's after the 'pivot' step, so if pivoting, has the value columns for the pivot.
     *
     * @agModule `ColumnApiModule`
     */
    getAllGridColumns(): Column[];
    /**
     * Same as `getAllDisplayedColumns` but just for the pinned left portion of the grid.
     * @agModule `ColumnApiModule`
     */
    getDisplayedLeftColumns(): Column[];
    /**
     * Same as `getAllDisplayedColumns` but just for the center portion of the grid.
     * @agModule `ColumnApiModule`
     */
    getDisplayedCenterColumns(): Column[];
    /**
     * Same as `getAllDisplayedColumns` but just for the pinned right portion of the grid.
     * @agModule `ColumnApiModule`
     */
    getDisplayedRightColumns(): Column[];
    /**
     * Returns all columns currently displayed (e.g. are visible and if in a group, the group is showing the columns) for the pinned left, centre and pinned right portions of the grid.
     * @agModule `ColumnApiModule`
     */
    getAllDisplayedColumns(): Column[];
    /**
     * Same as `getAllGridColumns()`, except only returns rendered columns, i.e. columns that are not within the viewport and therefore not rendered, due to column virtualisation, are not displayed.
     * @agModule `ColumnApiModule`
     */
    getAllDisplayedVirtualColumns(): Column[];
}
export interface _ColumnGroupGridApi {
    /** Call this if you want to open or close a column group. */
    setColumnGroupOpened(group: ProvidedColumnGroup | string, newValue: boolean): void;
    /** Returns the column group with the given name. */
    getColumnGroup(name: string, instanceId?: number): ColumnGroup | null;
    /** Returns the provided column group with the given name. */
    getProvidedColumnGroup(name: string): ProvidedColumnGroup | null;
    /** Returns the display name for a column group (when grouping columns). */
    getDisplayNameForColumnGroup(columnGroup: ColumnGroup, location: HeaderLocation): string;
    /** Gets the state of the column groups. Typically used when saving column group state. */
    getColumnGroupState(): {
        groupId: string;
        open: boolean;
    }[];
    /** Sets the state of the column group state from a previous state. */
    setColumnGroupState(stateItems: {
        groupId: string;
        open: boolean;
    }[]): void;
    /** Sets the state back to match the originally provided column definitions. */
    resetColumnGroupState(): void;
    /** Same as `getAllDisplayedColumnGroups` but just for the pinned left portion of the grid. */
    getLeftDisplayedColumnGroups(): (Column | ColumnGroup)[];
    /** Same as `getAllDisplayedColumnGroups` but just for the center portion of the grid. */
    getCenterDisplayedColumnGroups(): (Column | ColumnGroup)[];
    /** Same as `getAllDisplayedColumnGroups` but just for the pinned right portion of the grid. */
    getRightDisplayedColumnGroups(): (Column | ColumnGroup)[];
    /** Returns all 'root' column headers. If you are not grouping columns, these return the columns. If you are grouping, these return the top level groups - you can navigate down through each one to get the other lower level headers and finally the columns at the bottom. */
    getAllDisplayedColumnGroups(): (Column | ColumnGroup)[] | null;
}
export interface _DragGridApi {
    /**
     * Adds a drop zone outside of the grid where rows can be dropped.
     * @agModule `RowDragModule`
     */
    addRowDropZone(params: RowDropZoneParams): void;
    /**
     * Removes an external drop zone added by `addRowDropZone`.
     * @agModule `RowDragModule` */
    removeRowDropZone(params: RowDropZoneParams): void;
    /**
     * Returns the `RowDropZoneParams` to be used by another grid's `addRowDropZone` method.
     * @agModule `RowDragModule`
     */
    getRowDropZoneParams(events?: RowDropZoneEvents): RowDropZoneParams | undefined;
}
export interface _EditGridApi<TData> {
    /**
     * Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes.
     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
     */
    getCellEditorInstances(params?: GetCellEditorInstancesParams<TData>): ICellEditor[];
    /**
     * If the grid is editing, returns back details of the editing cell(s).
     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
     */
    getEditingCells(): CellPosition[];
    /**
     * If a cell is editing, it stops the editing. Pass `true` if you want to cancel the editing (i.e. don't accept changes).
     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
     */
    stopEditing(cancel?: boolean): void;
    /**
     * Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell.
     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
     */
    startEditingCell(params: StartEditingCellParams): void;
}
export interface _UndoRedoGridApi {
    /**
     * Reverts the last cell edit.
     * @agModule `UndoRedoEditModule`
     */
    undoCellEditing(): void;
    /**
     * Re-applies the most recently undone cell edit.
     * @agModule `UndoRedoEditModule`
     */
    redoCellEditing(): void;
    /**
     * Returns current number of available cell edit undo operations.
     * @agModule `UndoRedoEditModule`
     */
    getCurrentUndoSize(): number;
    /**
     * Returns current number of available cell edit redo operations.
     * @agModule `UndoRedoEditModule`
     */
    getCurrentRedoSize(): number;
}
export interface _FilterGridApi {
    /**
     * Returns `true` if any filter is set. This includes quick filter, column filter, external filter or advanced filter.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule` / `QuickFilterModule` / `ExternalFilterModule` / `AdvancedFilterModule`
     *  */
    isAnyFilterPresent(): boolean;
    /**
     * Informs the grid that a filter has changed. This is typically called after a filter change through one of the filter APIs.
     * @param source The source of the filter change event. If not specified defaults to `'api'`.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule` / `QuickFilterModule` / `ExternalFilterModule` / `AdvancedFilterModule`
     */
    onFilterChanged(source?: FilterChangedEventSourceType): void;
}
export interface _ColumnFilterGridApi {
    /**
     * Returns `true` if any column filter is set, otherwise `false`.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    isColumnFilterPresent(): boolean;
    /**
     * Returns the filter component instance for a column.
     * For getting/setting models for individual column filters, use `getColumnFilterModel` and `setColumnFilterModel` instead of this.
     * `key` can be a column ID or a `Column` object.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    getColumnFilterInstance<TFilter extends IFilter>(key: string | Column): Promise<TFilter | null | undefined>;
    /**
     * Destroys a filter. Useful to force a particular filter to be created from scratch again.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    destroyFilter(key: string | Column): void;
    /**
     * Sets the state of all the column filters. Provide it with what you get from `getFilterModel()` to restore filter state.
     * If inferring cell data types, and row data is initially empty or yet to be set,
     * the filter model will be applied asynchronously after row data is added.
     * To always perform this synchronously, set `cellDataType = false` on the default column definition,
     * or provide cell data types for every column.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    setFilterModel(model: FilterModel | null): void;
    /**
     * Gets the current state of all the column filters. Used for saving filter state.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    getFilterModel(): FilterModel;
    /**
     * Gets the current filter model for the specified column.
     * Will return `null` if no active filter.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    getColumnFilterModel<TModel>(column: string | Column): TModel | null;
    /**
     * Sets the filter model for the specified column.
     * Setting a `model` of `null` will reset the filter (make inactive).
     * Must wait on the response before calling `api.onFilterChanged()`.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    setColumnFilterModel<TModel>(column: string | Column, model: TModel | null): Promise<void>;
    /**
     * Show the filter for the provided column.
     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
     */
    showColumnFilter(colKey: string | Column): void;
}
export interface _QuickFilterGridApi {
    /**
     * Only supported for Client-Side Row Model.
     * Returns `true` if the Quick Filter is set, otherwise `false`.
     * @agModule `QuickFilterModule`
     */
    isQuickFilterPresent(): boolean;
    /**
     * Only supported for Client-Side Row Model.
     * Get the current Quick Filter text from the grid, or `undefined` if none is set.
     * @agModule `QuickFilterModule`
     */
    getQuickFilter(): string | undefined;
    /**
     * Only supported for Client-Side Row Model.
     * Reset the Quick Filter cache text on every rowNode.
     * @agModule `QuickFilterModule`
     */
    resetQuickFilter(): void;
}
export interface _FindApi<TData> {
    /**
     * Go to the next match.
     * @agModule `FindModule`
     */
    findNext(): void;
    /**
     * Go to the previous match.
     * @agModule `FindModule`
     */
    findPrevious(): void;
    /**
     * Get the total number of matches.
     * @agModule `FindModule`
     */
    findGetTotalMatches(): number;
    /**
     * Go to the provided match (first match is `1`).
     * By default, if the provided match is already active, this will do nothing.
     * If `force` is set to `true`, this will instead reset the active match to that provided
     * (e.g. scroll the grid).
     * @agModule `FindModule`
     */
    findGoTo(match: number, force?: boolean): void;
    /**
     * Clear the active match.
     * @agModule `FindModule`
     */
    findClearActive(): void;
    /**
     * Get the active match, or `undefined` if no active match.
     * @agModule `FindModule`
     */
    findGetActiveMatch(): FindMatch<TData> | undefined;
    /**
     * Get the number of matches within the provided cell.
     * @agModule `FindModule`
     */
    findGetNumMatches(params: FindCellParams<TData>): number;
    /**
     * Get the parts of a cell value, including matches and active match.
     * Used for custom cell components.
     * @agModule `FindModule`
     */
    findGetParts(params: FindCellValueParams<TData>): FindPart[];
    /**
     * This will re-run the search with the current value. This is normally done automatically.
     *
     * This should only be called in situations where data is mutated outside of the grid,
     * and `api.refreshCells()` or `api.redrawRows()` are being used (`api.findRefresh()` should be called after these).
     * @agModule `FindModule`
     */
    findRefresh(): void;
}
export interface _StateGridApi {
    /**
     * Get the current state of the grid. Can be used in conjunction with the `initialState` grid option to save and restore grid state.
     * @agModule `GridStateModule`
     */
    getState(): GridState;
}
export interface _PaginationGridApi {
    /**
     * Returns `true` when the last page is known.
     * This will always be `true` if you are using the Client-Side Row Model for pagination.
     * Returns `false` when the last page is not known; this only happens when using Infinite Row Model.
     * @agModule `PaginationModule`
     */
    paginationIsLastPageFound(): boolean;
    /**
     * Returns how many rows are being shown per page.
     * @agModule `PaginationModule`
     */
    paginationGetPageSize(): number;
    /**
     * Returns the 0-based index of the page which is showing.
     * @agModule `PaginationModule`
     */
    paginationGetCurrentPage(): number;
    /**
     * Returns the total number of pages.
     * @agModule `PaginationModule`
     */
    paginationGetTotalPages(): number;
    /**
     * Returns the total number of pageable rows, as impacted by `gridOptions.paginateChildRows: true`.
     *
     * It is recommended to instead use `gridApi.getDisplayedRowCount()` if not using pagination, or if `gridOption.paginateChildRows=true`.
     *
     * @agModule `PaginationModule`
     **/
    paginationGetRowCount(): number;
    /**
     * Navigates to the next page.
     * @agModule `PaginationModule`
     */
    paginationGoToNextPage(): void;
    /**
     * Navigates to the previous page.
     * @agModule `PaginationModule`
     */
    paginationGoToPreviousPage(): void;
    /**
     * Navigates to the first page.
     * @agModule `PaginationModule`
     */
    paginationGoToFirstPage(): void;
    /**
     * Navigates to the last page.
     * @agModule `PaginationModule`
     */
    paginationGoToLastPage(): void;
    /**
     * Goes to the specified page. If the page requested doesn't exist, it will go to the last page.
     * @agModule `PaginationModule`
     */
    paginationGoToPage(page: number): void;
}
export interface _PinnedRowGridApi {
    /**
     * Gets the number of top pinned rows.
     * @agModule `PinnedRowModule`
     */
    getPinnedTopRowCount(): number;
    /**
     * Gets the number of bottom pinned rows.
     * @agModule `PinnedRowModule`
     */
    getPinnedBottomRowCount(): number;
    /**
     * Gets the top pinned row with the specified index.
     * @agModule `PinnedRowModule`
     */
    getPinnedTopRow<TPinnedData = any>(index: number): IRowNode<TPinnedData> | undefined;
    /**
     * Gets the bottom pinned row with the specified index.
     * @agModule `PinnedRowModule`
     */
    getPinnedBottomRow<TPinnedData = any>(index: number): IRowNode<TPinnedData> | undefined;
    /**
     * Iterates over each pinned row, calling the provided callback for each row
     * @agModule `PinnedRowModule`
     */
    forEachPinnedRow<TPinnedData = any>(floating: NonNullable<RowPinnedType>, callback: (rowNode: IRowNode<TPinnedData>) => void): void;
}
export interface _RenderGridApi<TData> {
    /**
     * Sets an ARIA property in the grid panel (element with `role=\"grid\"` or `role=\"treegrid\"), and removes an ARIA property when the value is null.
     *
     * Example: `api.setGridAriaProperty('label', 'my grid')` will set `aria-label=\"my grid\"`.
     *
     * `api.setGridAriaProperty('label', null)` will remove the `aria-label` attribute from the grid element.
     * @agModule `RenderApiModule`
     */
    setGridAriaProperty(property: string, value: string | null): void;
    /**
     * Performs change detection on all cells, refreshing cells where required.
     * @agModule `RenderApiModule`
     */
    refreshCells(params?: RefreshCellsParams<TData>): void;
    /**
     * Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed.
     * @agModule `RenderApiModule`
     */
    refreshHeader(): void;
    /**
     * Returns `true` when there are no more animation frames left to process.
     * @agModule `RenderApiModule`
     */
    isAnimationFrameQueueEmpty(): boolean;
    /**
     * Flushes all animation frames.
     * @agModule `RenderApiModule`
     */
    flushAllAnimationFrames(): void;
    /**
     * Gets the sizes that various UI elements will be rendered at with the current theme.
     * If you override the row or header height using `gridOptions`, the override value you provided will be returned.
     * @agModule `RenderApiModule`
     */
    getSizesForCurrentTheme(): {
        rowHeight: number;
        headerHeight: number;
    };
    /**
     * Returns the list of active cell renderer instances.
     * @agModule `RenderApiModule`
     */
    getCellRendererInstances(params?: GetCellRendererInstancesParams<TData>): ICellRenderer<TData>[];
}
export interface _HighlightChangesGridApi<TData> {
    /**
     * Flash rows, columns or individual cells.
     * @agModule `HighlightChangesModule`
     */
    flashCells(params?: FlashCellsParams<TData>): void;
}
export interface _SideBarGridApi<TData> {
    /**
     * Returns `true` if the side bar is visible.
     * @agModule `SideBarModule`
     */
    isSideBarVisible(): boolean;
    /**
     * Show/hide the entire side bar, including any visible panel and the tab buttons.
     * @agModule `SideBarModule`
     */
    setSideBarVisible(show: boolean): void;
    /**
     * Sets the side bar position relative to the grid. Possible values are `'left'` or `'right'`.
     * @agModule `SideBarModule`
     */
    setSideBarPosition(position: 'left' | 'right'): void;
    /**
     * Opens a particular tool panel. Provide the ID of the tool panel to open.
     * @agModule `SideBarModule`
     */
    openToolPanel(key: string): void;
    /**
     * Closes the currently open tool panel (if any).
     * @agModule `SideBarModule`
     */
    closeToolPanel(): void;
    /**
     * Returns the ID of the currently shown tool panel if any, otherwise `null`.
     * @agModule `SideBarModule`
     */
    getOpenedToolPanel(): string | null;
    /**
     * Force refreshes all tool panels by calling their `refresh` method.
     * @agModule `SideBarModule`
     */
    refreshToolPanel(): void;
    /**
     * Returns `true` if the tool panel is showing, otherwise `false`.
     * @agModule `SideBarModule`
     */
    isToolPanelShowing(): boolean;
    getToolPanelInstance(id: 'columns'): IColumnToolPanel | undefined;
    getToolPanelInstance(id: 'filters'): IFiltersToolPanel | undefined;
    getToolPanelInstance<TToolPanel = IToolPanel<TData>>(id: string): TToolPanel | undefined;
    /**
     * Gets the tool panel instance corresponding to the supplied