ExportOptions

Options regarding Exporting data from AdapTable

export interface

Properties

Property Details

appendFileTimestamp

Whether to add a timestamp as a suffix to exported file name

appendFileTimestamp?: boolean;

Default Value

false

Property Value

boolean

csvSeparator

Separator for CSV exports

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

Default Value

','

Property Value

string | ((csvSeparatorContext:BaseExportContext) => string)

customDestinations

User-provided Report Destinations (in addition to those shipped in AdapTable)

customDestinations?: CustomDestination[] | ((context: CustomDestinationsContext) => CustomDestination[]);

Property Value

CustomDestination[] | ((context:CustomDestinationsContext) =>CustomDestination[])

excelSheetName

Provides a custom name for the Excel sheet when exporting to Excel

excelSheetName?: string | ((excelSheetNameContext: BaseExportContext) => string);

Default Value

'Sheet 1'

Property Value

string | ((excelSheetNameContext:BaseExportContext) => string)

exportDataFormat

Sets 'rawValue' or 'formattedValue' as Data format in Reports; can be set for whole grid, per Data Type, or per Column (via a function)

exportDataFormat?: DataFormatType | DataFormatDataType | ((context: ExportDataFormatContext<TData>) => DataFormatType);

Default Value

rawValue

Property Value

DataFormatType|DataFormatDataType| ((context:ExportDataFormatContext<TData>) =>DataFormatType)

exportDateFormat

Optional custom format for Date columns when exporting

exportDateFormat?: string | ((context: ExportDateFormatContext<TData>) => string);

Default Value

undefined

Property Value

string | ((context:ExportDateFormatContext<TData>) => string)

getDetailRows

Function to provide the Detail Rows when exporting in Master-Detail grids. This function will be invoked for each master row node.

getDetailRows?: (context: GetDetailRowsContext<TData>) => CsvDetailRow[] | ExcelDetailRow[] | undefined;

Property Value

(context:GetDetailRowsContext<TData>) => CsvDetailRow[] | ExcelDetailRow[] | undefined

isColumnExportable

Whether a Column is included in System Reports and available in UI for selection

isColumnExportable?: (context: AdaptableColumnContext) => boolean;

Default Value

true

Property Value

(context:AdaptableColumnContext) => boolean

processExport

Provides custom handling of the Export process before the default export is executed.

processExport?: (processExportContext: ProcessExportContext) => Promise<ExportResultData | boolean>;

Property Value

(processExportContext:ProcessExportContext) => Promise<ExportResultData | boolean>

reportFilename

Provide a bespoke file name for the Report

reportFilename?: (reportFileNameContext: ReportFileNameContext) => string;

Property Value

(reportFileNameContext:ReportFileNameContext) => string

skipColumnHeaders

Whether to exclude Column Headers from the exported data

skipColumnHeaders?: boolean | ((skipColumnHeadersContext: BaseExportContext) => boolean);

Default Value

false

Property Value

boolean | ((skipColumnHeadersContext:BaseExportContext) => boolean)

systemExportDestinations

Export destinations to use; leave unset for all, empty array for none

systemExportDestinations?: SystemExportDestination[] | ((context: SystemExportDestinationsContext) => SystemExportDestination[]);

Default Value

'Download', 'Clipboard'

Property Value

SystemExportDestination[] | ((context:SystemExportDestinationsContext) =>SystemExportDestination[])

systemReportFormats

System Report Formats to use; leave unset for all, empty array for none

systemReportFormats?: SystemReportFormat[] | ((context: SystemReportFormatsContext) => SystemReportFormat[]);

Default Value

'Excel', 'VisualExcel', 'CSV', 'JSON'

Property Value

SystemReportFormat[] | ((context:SystemReportFormatsContext) =>SystemReportFormat[])

systemReportNames

System Reports to use; leave unset for all, empty array for none

systemReportNames?: SystemReportName[] | ((context: SystemReportNamesContext) => SystemReportName[]);

Default Value

'All Data', 'Current Layout', 'Selected Data',

Property Value

SystemReportName[] | ((context:SystemReportNamesContext) =>SystemReportName[])