Interface GridCsvExportApi

The CSV export API interface that is available in the grid [[apiRef]].

interface GridCsvExportApi {
exportDataAsCsv: ((options?: GridCsvExportOptions) => void);
getDataAsCsv: ((options?: GridCsvExportOptions) => string);
}

Properties

exportDataAsCsv: ((options?: GridCsvExportOptions) => void)

Downloads and exports a CSV of the grid's data.

- (options?): void
- Parameters
  - Optionaloptions: GridCsvExportOptions
    The options to apply on the export.
  Returns void

getDataAsCsv: ((options?: GridCsvExportOptions) => string)

Returns the grid data as a CSV string. This method is used internally by exportDataAsCsv.