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

CSVComponent

Component

The component is required when exporting the data to a CSV file. The component provides different options to customize the exported file and its content.

Definition

Package:@progress/kendo-angular-grid

Selector:kendo-grid-csv

Syntax:

html

<kendo-grid>
  <kendo-grid-csv fileName="Export.csv"></kendo-grid-csv>
</kendo-grid>

Inputs

delimiter

string

Sets the character used to separate values in a row. Must be a single character.

Default:

','

Provides a function to get the exported data. By default, uses the data displayed in the Grid in accordance with the currently applied State. Supply a custom function to export a different data set. Typically used to export all data, not just the current page.

fileName

string

Sets the file name for the exported CSV file.

Default:

'Export.csv'

forceProxy

boolean

Forwards the content to proxyURL even if the browser supports local file saving when set to true.

groupHeaderFormatter

Provides a custom formatter for group headers in grouped data exports. Receives the display names of grouped fields and returns the formatted header.

Parameters:displayNamesstring[]Returns:

string

Default:

Joins display names with '/' separator

groupValueFormatter

Provides a custom formatter for group value rows in grouped data exports. Receives the values and field names, and returns the formatted group value.

Parameters:valuesany[]groupNamesstring[]Returns:

string

Default:

Joins values with '/' separator

includeUTF8BOM

boolean

When true, adds a UTF-8 Byte Order Mark (BOM) at the beginning of the file. Helps applications like Microsoft Excel correctly recognize UTF-8 encoding.

Default:

false

keys

string[]

Sets property names to extract from object or Map rows, in order. By default, these are the properties used as field binding values in the Grid's column definitions.

lineSeparator

string

Sets the string used to terminate each line.

Default:

'\r\n'

maxCellLength

number

Sets the maximum number of characters allowed per cell. Values exceeding this limit are truncated.

Default:

32767

maxColumns

number

Maximum number of columns to export. Keys/columns exceeding this limit are automatically truncated. Default: 1000 (prevents memory exhaustion and DoS attacks).

Default:

1000

maxRows

number

Maximum number of rows to export. Data exceeding this limit is automatically truncated. Default: 1000000 (prevents memory exhaustion and DoS attacks).

Default:

1000000

names

string[]

Sets optional column headers to render on the first line. By default, column names are extracted from each column's title or field properties.

preventFormulaInjection

boolean

When true, prefixes potentially dangerous formula characters (=, +, -, @, tab, \r) with a single quote (') to prevent formula injection attacks in spreadsheet applications.

Default:

true

proxyURL

string

Sets the URL of the server-side proxy that streams the file to the user. Use a proxy if the browser cannot save files locally. Set forceProxy to true to skip client-side saving. The proxy receives a POST request with specific parameters and returns the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.csv>". For more details, see the File Saver documentation.