UNPKG

3.02 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 { GridSerializer, RowAccumulator, BaseGridSerializingSession, RowSpanningAccumulator, GridSerializingSession } from "./gridSerializer";
5import { Downloader } from "./downloader";
6import { Column } from "./entities/column";
7import { ColumnController } from "./columnController/columnController";
8import { ValueService } from "./valueService/valueService";
9import { GridOptionsWrapper } from "./gridOptionsWrapper";
10import { CsvExportParams, ExportParams, ProcessCellForExportParams, ProcessHeaderForExportParams } from "./exportParams";
11export declare class CsvSerializingSession extends BaseGridSerializingSession<string> {
12 private suppressQuotes;
13 private columnSeparator;
14 private result;
15 private lineOpened;
16 constructor(columnController: ColumnController, valueService: ValueService, gridOptionsWrapper: GridOptionsWrapper, processCellCallback: (params: ProcessCellForExportParams) => string, processHeaderCallback: (params: ProcessHeaderForExportParams) => string, suppressQuotes: boolean, columnSeparator: string);
17 prepare(columnsToExport: Column[]): void;
18 addCustomHeader(customHeader: string): void;
19 addCustomFooter(customFooter: string): void;
20 onNewHeaderGroupingRow(): RowSpanningAccumulator;
21 private onNewHeaderGroupingRowColumn(header, index, span);
22 onNewHeaderRow(): RowAccumulator;
23 private onNewHeaderRowColumn(column, index, node?);
24 onNewBodyRow(): RowAccumulator;
25 private onNewBodyRowColumn(column, index, node?);
26 private putInQuotes(value, suppressQuotes);
27 parse(): string;
28}
29export interface BaseCreatorBeans {
30 downloader: Downloader;
31 gridSerializer: GridSerializer;
32 gridOptionsWrapper: GridOptionsWrapper;
33}
34export declare abstract class BaseCreator<T, S extends GridSerializingSession<T>, P extends ExportParams<T>> {
35 private beans;
36 protected setBeans(beans: BaseCreatorBeans): void;
37 export(userParams?: P): string;
38 getData(params: P): string;
39 private getMergedParamsAndData(userParams);
40 private mergeDefaultParams(userParams);
41 abstract createSerializingSession(params?: P): S;
42 abstract getMimeType(): string;
43 abstract getDefaultFileName(): string;
44 abstract getDefaultFileExtension(): string;
45 abstract isExportSuppressed(): boolean;
46}
47export declare class CsvCreator extends BaseCreator<string, CsvSerializingSession, CsvExportParams> {
48 private columnController;
49 private valueService;
50 private downloader;
51 private gridSerializer;
52 gridOptionsWrapper: GridOptionsWrapper;
53 postConstruct(): void;
54 exportDataAsCsv(params?: CsvExportParams): string;
55 getDataAsCsv(params?: CsvExportParams): string;
56 getMimeType(): string;
57 getDefaultFileName(): string;
58 getDefaultFileExtension(): string;
59 createSerializingSession(params?: CsvExportParams): CsvSerializingSession;
60 isExportSuppressed(): boolean;
61}