Report Format Type - CSV

Summary

AdapTable offers a CSV Report Format which allows grid data to be exported in CSV format

Reports can be given a Report Format of CSV.

CSV formatted Reports can be exported to all destinations.

CSV Separator

By default AdapTable will use a comma (',') to separate the values, but this can be changed by developers using the csvSeparator property in Export Options.

csvSeparator

Default: ','

string

Separator to use in CSV format

This property allows developers to change the default CSV separator value of a comma.

The property can return either a string, or function which takes a BaseExportContext object and returns a string.

csvSeparator?: string | ((csvSeparatorContext: BaseExportContext) => string);

The BaseExportContext contains these properties:

Property	Description
exportDestination	Export Destination for the Report
report	The Report Configuration being run
reportFormat	Format of the Report being run
reportName	Name of the Report being run
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

// Use a pipe to separate values in the CSV file
const adaptableOptions: AdaptableOptions = {
  exportOptions: {
   csvSeparator: '|'
  }
}

CSV Report Format

Fork Fork

This demo sets the Current Report Format in Initial State to CSV, and changed the CSV separator to be a '|'
Exporting a report will send the data in CSV format with the custom delimiter

PreviousVisual Excel NextJSON