All Components

ExcelExportComponent

Configures the settings for the Excel export of the Kendo UI Grid.

Selector

kendo-excelexport

Export Name

Accessible in templates as #kendoExcelExportInstance="kendoExcelExport"

Inputs

creator? string

The creator of the workbook.

data any[]

The exported data.
If grouped, the data must have the structure described by the GroupResult option of the Kendo UI DataQuery.

date? Date

The date on which the workbook is created. Defaults to new Date().

fileName string (default: "Export.xlsx")

Specifies the file name of the file exported to Excel.

filterable boolean

Enables or disables the filtering for columns in the Excel file.

forceProxy boolean

If set to true, the content is forwarded to proxyURL even if the browser supports the saving of files locally.

group any[]

The exported data groups.
The groups must be compatible with the GroupDescriptor option of the Kendo UI DataQuery.

headerPaddingCellOptions CellOptions

The options of the cells that are inserted before the header cells to align the headers and the column values when the data is grouped.

paddingCellOptions CellOptions

The options of the cells that are inserted before the data, group, and footer cells to indicate the group hierarchy if the data is grouped.

proxyURL string

The URL of the server-side proxy which will stream the file to the end user.
A proxy is used when the browser is not capable of saving files locally. For example, Internet Explorer 9 and earlier, and Safari.
The implementation of the server-side proxy has to be done by you.
The proxy receives a POST request with the following parameters in the request body:

  • contentType—The MIME type of the file.
  • base64—The base-64 encoded file content.
  • fileName—The file name, as requested by the caller.

The proxy is expected to return the decoded file with the Content-Disposition header set to attachment; filename="<fileName.xslx>".

Methods

save

Saves the data to Excel.

Parameters

exportData? any[] | ExcelExportData | WorkbookOptions

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

toDataURL

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

Parameters

exportData? any[] | ExcelExportData | WorkbookOptions

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

Returns

Promise - The promise that will be resolved by the file data URI.

workbookOptions

Returns WorkbookOptions based on the specified columns and data.

Parameters

exportData? any[] | ExcelExportData

The optional data to be exported.

Returns

WorkbookOptions - The workbook options.

In this article