UNPKG

ag-grid-community

Version:

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

28 lines (27 loc) 1.2 kB
import type { SortModelItem } from './iSortModelItem'; /** Datasource used by both PaginationController and InfiniteRowModel */ export interface IDatasource { /** If you know up front how many rows are in the dataset, set it here. Otherwise leave blank. */ rowCount?: number; /** Callback the grid calls that you implement to fetch rows from the server. */ getRows(params: IGetRowsParams): void; /** Optional destroy method, if your datasource has state it needs to clean up. */ destroy?(): void; } /** Params for the above IDatasource.getRows() */ export interface IGetRowsParams { /** The first row index to get. */ startRow: number; /** The first row index to NOT get. */ endRow: number; /** Callback to call for the result when successful. */ successCallback(rowsThisBlock: any[], lastRow?: number): void; /** Callback to call when the request fails. */ failCallback(): void; /** If doing server side sorting, contains the sort model */ sortModel: SortModelItem[]; /** If doing server side filtering, contains the filter model */ filterModel: any; /** The context as provided on `gridOptions.context` */ context: any; }