UNPKG

1.54 kBTypeScriptView Raw
1// Type definitions for ag-grid v18.1.2
2// Project: http://www.ag-grid.com/
3// Definitions by: Niall Crosby <https://github.com/ag-grid/>
4import { Column } from "./entities/column";
5import { RowNode } from "./entities/rowNode";
6import { GridApi } from "./gridApi";
7import { ColumnApi } from "./columnController/columnApi";
8export interface BaseExportParams {
9 skipHeader?: boolean;
10 columnGroups?: boolean;
11 skipFooters?: boolean;
12 skipGroups?: boolean;
13 skipPinnedTop?: boolean;
14 skipPinnedBottom?: boolean;
15 suppressQuotes?: boolean;
16 columnKeys?: (string | Column)[];
17 fileName?: string;
18 allColumns?: boolean;
19 onlySelected?: boolean;
20 onlySelectedAllPages?: boolean;
21 shouldRowBeSkipped?(params: ShouldRowBeSkippedParams): boolean;
22 processCellCallback?(params: ProcessCellForExportParams): string;
23 processHeaderCallback?(params: ProcessHeaderForExportParams): string;
24}
25export interface ExportParams<T> extends BaseExportParams {
26 customHeader?: T;
27 customFooter?: T;
28}
29export interface CsvExportParams extends ExportParams<string> {
30 columnSeparator?: string;
31}
32export interface ShouldRowBeSkippedParams {
33 node: RowNode;
34 api: GridApi;
35 context: any;
36}
37export interface ProcessCellForExportParams {
38 value: any;
39 node: RowNode;
40 column: Column;
41 api: GridApi;
42 columnApi: ColumnApi;
43 context: any;
44 type: string;
45}
46export interface ProcessHeaderForExportParams {
47 column: Column;
48 api: GridApi;
49 columnApi: ColumnApi;
50 context: any;
51}