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

ExcelExportOptions

Represents the props of the KendoVue ExcelExport component.

NameTypeDefaultDescription

collapsible?

boolean

Enables or disables collapsible (grouped) rows in the exported file.

columns?

any[] | ExcelExportColumnOptions[]

You can pass the columns through the props of the component. If both the columns prop and the child column components are presented, the columns from props will be used.

creator?

string

The creator 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().

dir?

string

If set to rtl, the Excel file will be rendered in the right-to-left mode.

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.

forceProxy?

boolean

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

group?

GroupDescriptor[]

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

hierarchy?

boolean

If set to true the data will be exported as a tree based on the level property of each data record.

onExportComplete?

(event: ExcelExportExportEvent) => void

Triggered after the export is complete.

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

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