@helix-x/datagrid-ui - v0.2.0
    Preparing search index...

    Interface ExportCsvOptions

    Options for GridApi.exportCsv.

    interface ExportCsvOptions {
        chunkSize?: number;
        fileName?: string;
        maxRows?: number;
        onlySelected?: boolean;
        scope?: ExportScope;
        separator?: string;
    }
    Index
    chunkSize? fileName? maxRows? onlySelected? scope? separator?
    chunkSize?: number

    Rows asked for per request while fetching for the 'all' and 'selected' scopes.

    1000
    fileName?: string

    File name, with or without the .csv suffix.

    the grid's exportFileName prop

    maxRows?: number

    Most rows fetched for the 'all' and 'selected' scopes. The server is never asked for rows past this. Raise it deliberately: every row is held in memory to build the file.

    1000
    onlySelected?: boolean

    Export only the selected rows.

    false

    Use scope: 'selected', which also covers rows selected on other pages.

    scope?: ExportScope

    Which rows to export. See ExportScope.

    'all'
    separator?: string

    Field separator.

    ','

    Settings
    Member Visibility

    On This Page
    Properties