# exportDataAsCsv

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

Canonical: https://grid.syidax.com/docs/methods/exportDataAsCsv/

<a id="meaning"></a>

## What does this API do?

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

<a id="contract"></a>

## 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>`.

<a id="usage"></a>

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

<a id="types"></a>

## Read related types

- [CsvDownloadOptions](https://grid.syidax.com/docs/types/CsvDownloadOptions.md)
- [GridRow](https://grid.syidax.com/docs/types/GridRow.md)
- [CsvExportResult](https://grid.syidax.com/docs/types/CsvExportResult.md)

<a id="recipes"></a>

## Feature explanations and examples

- [CSV export](https://grid.syidax.com/docs/features/csv-export.md) — 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.
