Interface CsvExportOptions

interface CsvExportOptions {
    includeHiddenHeaders?: boolean;
    papaParseConfig?: UnparseConfig;
    sheetKey?: SheetKey;
    trimLeadingBlankColumn?: boolean;
    trimLeadingBlankRow?: boolean;
}

Hierarchy

  • ExportWorkbookOptions
    • CsvExportOptions

Properties

includeHiddenHeaders? papaParseConfig? sheetKey? trimLeadingBlankColumn? trimLeadingBlankRow?

Properties

Optional includeHiddenHeaders

includeHiddenHeaders?: boolean

Indicate whether hidden columns and rows are skipped in the CSV output

Default Value

true

Optional papaParseConfig

papaParseConfig?: UnparseConfig

configuration for csv export

Remarks

CSV parse delegates to the excellent Papa Parse library. All options are exposes via papParseConfig.

See

https://www.papaparse.com/docs#unparse-config-default

Optional sheetKey

sheetKey?: SheetKey

Specify the tab to export

Remarks

CSV Will only export one tab. By default this is the active tab. To change this pass a SheetKey.

Default Value

'the current active tab'

Optional trimLeadingBlankColumn

trimLeadingBlankColumn?: boolean

Indicates whether the leading blank columns should be trimmed.

Default Value

true

Optional trimLeadingBlankRow

trimLeadingBlankRow?: boolean

Indicates whether the leading blank rows should be trimmed.

Default Value

false

Settings

Member Visibility

Theme

On This Page

includeHiddenHeaderspapaParseConfigsheetKeytrimLeadingBlankColumntrimLeadingBlankRow