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




allPages boolean (default: true)

Specifies if export should include all pages

collapsible boolean

Specifies if the item levels in the Excel file are collapsible.

Applicable only if the treelist has footers.

creator? string

The author of the workbook.

date? Date

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

expandAll boolean (default: true)

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

fetchData (component: TreeListComponent) => ExcelExportData

The function that is used to get the exported data options. By default, uses the current data of the TreeList.
To export data that is different from the current TreeList 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 TreeList.

forceProxy boolean

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

paddingCellOptions CellOptions

The options of the cells that are inserted before the data to indicate the hierarchy.

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