ExcelExportComponent

Represents the Kendo UI Excel Export component for Angular. Configures the settings for the Excel export of the Kendo UI Grid.

Selector

kendo-excelexport

Export Name

Accessible in templates as #kendoExcelExportInstance="kendoExcelExport"

Inputs

Name	Type	Default	Description
collapsible	boolean		Specifies if groups are collapsible in the excel file.
creator?	string		The author of the workbook.
data	any[]		The exported data. If grouped, the data must be structured as described by the GroupResult option of the Kendo UI Data Query component.
date?	Date		The date on which the workbook is created. The default value is new Date().
fileName	string	"Export.xlsx"	Specifies the name of the file that is exported to Excel.
filterable	boolean		Enables or disables the column filtering in the Excel file (see example).
forceProxy	boolean		If forceProxy is set to true, the content is forwarded to proxyURL even if the browser supports the local saving of files.
group	any[]		The exported data groups. The groups must be compatible with the GroupDescriptor option of the Kendo UI Data Query component.
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 (see example).
paddingCellOptions	CellOptions		The options of the cells that are inserted before the data, group, and footer cells to indicate the group hierarchy when the data is grouped (see example).
proxyURL	string		The URL of the server-side proxy which will stream the file to the end user. When the browser is not capable of saving files locally—for example, Internet Explorer 9 and earlier, and Safari—a proxy is used. 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[] | WorkbookOptions | ExcelExportData An optional parameter. Can be the data that will be exported or WorkbookOptions.

toDataURL
Returns a promise which will be resolved with the file data URI (see example).
Parameters exportData? any[] | WorkbookOptions | ExcelExportData The optional data or WorkbookOptions that will be used to generate the data URI.
Returns Promise<string> The promise that will be resolved by the file data URI.

workbookOptions
Based on the specified columns and data, returns WorkbookOptions (see example).
Parameters exportData? any[] | ExcelExportData The optional data to be exported.
Returns WorkbookOptions The workbook options.