Columns
The Excel Export component supports options for customization of the columns that will be exported to Excel.
You can specify the following column options:
Hidden State
To hide a particular column from the exported file, use the hidden
column configuration.
To hide a particular columns from the exported file, you can also use the
*ngIf
directive.
Locked State
The Excel Export enables you to lock columns by using the locked
property of the columns. As a result, you can display specific columns at all times while the user scrolls the Excel file.
Templates
The Excel Export supports templates that you can use for customizing the group and footer elements.
Only the text content of the templates is exported. HTML elements cannot be converted to Excel column values.
Group Header Template
You can use the group header template to customize the header rows of the groups. To define a custom template, nest a <ng-template>
tag with the kendoExcelExportGroupHeaderTemplate
directive inside the <kendo-excelexport-column>
tag.
The template context is set to the group item and the following additional fields are passed:
group
—The current group item.field
—The name of the field by which data is grouped.value
—The current group value.aggregates
—All aggregate values for the current group.
If a template is not specified, the group header content is set to
" { title / field }: { value }"
.
Group Header Column Template
You can use the group header column template to customize the column group header cells. To define a template, nest a <ng-template>
tag with the kendoExcelExportGroupHeaderColumnTemplate
directive inside the <kendo-excelexport-column>
tag.
The template context is set to the group item and the following additional fields are passed:
group
—The current group item.field
—The name of the field by which data is grouped.value
—The current group value.aggregates
—All aggregate values for the current group.
Group Footer Template
You can use the group footer template to customize the footer rows of the groups. To define a custom template, nest a <ng-template>
tag with the kendoExcelExportGroupFooterTemplate
directive inside the <kendo-excelexport-column>
tag.
The template context is set to the current aggregates and the following additional fields are passed:
column
—Defines an instance of theColumnComponent
option.field
—The current column field name.group
—The current group data item.
If a template is not specified for any of the columns, the exported Excel file will not render a group footer row.
Footer Template
You can use the footer template to customize the column footer. To define a footer template, nest a <ng-template>
tag with the kendoExcelExportFooterTemplate
directive inside the <kendo-excelexport-column>
tag.
The template context is set to the current column and the following additional fields are passed:
column
—Defines an instance of theColumnComponent
.columnIndex
—Defines the current column index.
If a template is not specified for any of the columns, the exported Excel file will not render a footer row.
Multi-Column Headers
The Excel Export supports multi-column headers by using column groups, which are defined declaratively by using the <kendo-excelexport-column-group>
tag, that incorporate inner column structures.