Components / Excel Export / API / ExcelExport / 

ExcelExport

A subclass of React.Component.

NameTypeDefaultDescription

props

Readonly<ExcelExportProps>

The props of the ExcelExport component.

Methods

save

Saves the data to Excel.

Parameters

exportData?

any[] | WorkbookOptions | ExcelExportData

An optional parameter. Can be the data that will be exported or the WorkbookOptions.

columns?

ExcelExportColumnProps[] | ReactElement<ExcelExportColumnProps>[]

An optional parameter. If present, it will be used instead of the columns prop or the child column components.

toDataURL

Returns a promise which will be resolved with the file data URI.

Parameters

exportData?

any[] | WorkbookOptions | ExcelExportData

The optional data or the WorkbookOptions that will be used to generate the data URI.

columns?

any[]
Returns

Promise<string>
  • The promise that will be resolved by the file data URI.

workbookOptions

Based on the specified columns and data, returns WorkbookOptions.

Parameters

exportData?

any[] | ExcelExportData

The optional data that will be exported.

externalColumns?

ExcelExportColumnProps[] | ReactElement<ExcelExportColumnProps>[]

The optional columns that will be used.

Returns

WorkbookOptions
  • The workbook options.

In this article

Not finding the help you need?

Contact Support