API REFERENCE

exportDataAsCsv

Downloads CSV using current export conditions and returns the export result.

What does this API do?

Downloads CSV using current export conditions and returns the export result.

Exact input and result types

typescript

exportDataAsCsv(options?: Omit<CsvDownloadOptions<GridRow>, 'columns' | 'rows'>): Promise<CsvExportResult>

Arguments	Required	Type
options	Optional	Omit<CsvDownloadOptions<GridRow>, 'columns' \| 'rows'>

The return type is Promise<CsvExportResult>.

Usage flow

After registering and initializing the Grid element, call grid.exportDataAsCsv(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

CsvDownloadOptions
GridRow
CsvExportResult

Feature explanations and examples

CSV export
CSV export creates a text file for exchanging table data with other tools. It does not preserve cell colors, column widths, detail panels, or other visual layout.