# CsvExportOptions

Fields, allowed values, and APIs that use CsvExportOptions.

Canonical: https://grid.syidax.com/docs/types/CsvExportOptions/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface CsvExportOptions<TRow = Record<string, unknown>> {
  columns: ReadonlyArray<CsvExportColumn>;
  rows: ReadonlyArray<TRow>;
  delimiter?: string;
  lineTerminator?: string;
  includeHeaders?: boolean;
  bom?: boolean;
  locale?: string;
  blankForNullish?: boolean;
  escapeFormulae?: boolean;
}
```

<a id="used-by"></a>

## APIs using this type

- [getDataAsCsv](https://grid.syidax.com/docs/methods/getDataAsCsv.md) — Returns an object with CSV text and output row/column counts. Read the string from its csv field.

<a id="parents"></a>

## Contracts containing this type

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

<a id="related"></a>

## Related types

- [CsvExportColumn](https://grid.syidax.com/docs/types/CsvExportColumn.md)