Components / Grid / API

ExcelComponent

Configures the settings for the export of Grid in Excel (see example).

Selector

kendo-grid-excel

Inputs

collapsible boolean

Specifies if the groups in the Excel file are collapsible.

creator? string

The author of the workbook.

date? Date

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

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

The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
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

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

paddingCellOptions CellOptions

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

proxyURL string

The URL of the server-side proxy which streams the file to the end user.

Using a proxy is required if the browser is not capable of saving files locally—for example,
Internet Explorer 9 and Safari.

Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents in memory,
but transmits it over the network instead. For this use case, set forceProxy to true
to skip client-side saving even in browser that support it.

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>".

For details on the server-side proxy usage and implementation, see the File Saver documentation.