New to Kendo UI for Angular? Start a free 30-day trial

ExcelComponent

Component

Configures the settings for exporting the TreeList to Excel. See example.

Definition

Package:@progress/kendo-angular-treelist

Selector:kendo-treelist-excel

Syntax:

html

<kendo-treelist [data]="data" [height]="500">
   <kendo-treelist-excel fileName="Employees.xlsx"></kendo-treelist-excel>
</kendo-treelist>

Inputs

allPages

boolean

Specifies if export should include all pages.

Default:

true

collapsible

boolean

Specifies if item levels in the Excel file are collapsible. Applies only if the TreeList has footers.

date?

Date

Sets the date the workbook was created. Defaults to new Date().

expandAll

boolean

Specifies if the export should expand all items or use the current TreeList state.

Default:

true

fetchData

The function used to get the exported data options. By default, uses the current TreeList data. To export data different from the current TreeList data, provide a custom function.

Parameters:componentTreeListComponentReturns:

ExcelExportData

fileName

string

Specifies the file name of the exported Excel file.

Default:

'Export.xlsx'

filterable

boolean

Enables or disables column filtering in the Excel file. This is different from the TreeList filtering feature.

forceProxy

boolean

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

paddingCellOptions

CellOptions

The options for the cells inserted before the data to indicate the hierarchy.

proxyURL

string

The URL of the server-side proxy that streams the file to the user. Use a proxy if the browser cannot save files locally.

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

The proxy receives a POST request with specific parameters in the request body. See example. The proxy returns the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.xslx>".

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