All Components
Components

Components / Grid / API

ExcelComponent

Configures the Excel export settings of the Kendo UI Grid.

For more information, refer to the article on
exporting the Grid to Excel.

Selector

kendo-grid-excel

Inputs

creator? string

The creator of the workbook.

date? Date

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

fetchData (component: GridComponent) => ExcelExportData | Promise | Observable

The function that is used to get the exported data options. By default, the current data and group of the Grid are used.
To export data that is different from the current Grid data, provide a custom function.

fileName string (default: "Export.xlsx")

Specifies the file name of the exported Excel file.

filterable boolean

Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the Grid.

forceProxy boolean

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

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 streams the file to the end user.
You need to use a proxy if the browser is not capable of saving files locally—for example, Internet Explorer 9 and Safari.
The responsibility for implementing the server-side proxy is yours.

In the request body, the proxy receives a POST request with the following parameters:

  • 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 returns the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.xslx>".

In this article