Interface GridFileExportOptions<Api>

The options applicable to any document export format (CSV and Excel).

interface GridFileExportOptions<Api> {
    allColumns?: boolean;
    escapeFormulas?: boolean;
    fields?: string[];
    fileName?: string;
    getRowsToExport?: ((params: GridGetRowsToExportParams<Api>) => GridRowId[]);
    includeHeaders?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

allColumns? escapeFormulas? fields? fileName? getRowsToExport? includeHeaders?

Properties

OptionalallColumns

allColumns?: boolean

If true, the hidden columns will also be exported.

Default

false

OptionalescapeFormulas

escapeFormulas?: boolean

If false, the formulas in the cells will not be escaped. It is not recommended to disable this option as it exposes the user to potential CSV injection attacks. See https://owasp.org/www-community/attacks/CSV_Injection for more information.

Default

true

Optionalfields

fields?: string[]

The columns exported. This should only be used if you want to restrict the columns exports.

OptionalfileName

fileName?: string

The string used as the file name.

Default

document.title

OptionalgetRowsToExport

getRowsToExport?: ((params: GridGetRowsToExportParams<Api>) => GridRowId[])

Function that returns the list of row ids to export on the order they should be exported.

Type declaration

OptionalincludeHeaders

includeHeaders?: boolean

If true, the first row of the file will include the headers of the grid.

Default

true

Settings

Member Visibility

On This Page

Properties