API REFERENCE

getDataAsCsv

Returns an object with CSV text and output row/column counts. Read the string from its csv field.

What does this API do?

Returns an object with CSV text and output row/column counts. Read the string from its csv field.

Exact input and result types

typescript

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

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

The return type is Promise<CsvExportResult>.

Usage flow

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

Read related types

CsvExportOptions
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.