IExportingCSVOptions

Type interface

Sources

IExportingCSVOptions is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IExportingCSVOptions extends IExportingDataOptions.

IExportingCSVOptions is not extended by any other symbol.

Properties

#addBOM

Type undefined | false | trueDefault trueSince 5.1.0

Starts the file with a byte order mark, so that Excel reads its UTF-8 characters correctly.

#escapeFormulas

Type undefined | false | trueDefault trueSince 5.19.0

Protects against spreadsheet formula injection ("CSV injection"): text values that start with =, +, -, @, a tab or a carriage return get a single quote in front, so they are read as plain text.

#forceQuotes

Type undefined | false | trueDefault false

Quotes all values, numbers too.

#reverse

Type undefined | false | trueDefault false

Exports the rows in reverse order.

#separator

Type undefined | stringDefault ","

Column separator.

6 inherited items

#addColumnNames

Type undefined | false | trueDefault trueInherited from IExportingDataOptions

Adds the column names as the first row (or column, with pivot) in CSV, HTML, XLSX and PDF tables.

#disabled

Type undefined | false | trueInherited from IExportingFormatOptions

Leaves this format out of the ExportingMenu.

#emptyAs

Type undefined | stringInherited from IExportingDataOptions

Text for empty values: "-" in HTML by default, an empty string in the other formats.

#pivot

Type undefined | false | trueInherited from IExportingDataOptions

Swaps rows and columns, so that each field is a row.

#useLocale

Type undefined | false | trueDefault falseInherited from IExportingDataOptions

Formats dates in the browser's locale instead of with dateFormat.

#useTimestamps

Type undefined | false | trueDefault falseInherited from IExportingDataOptions

Exports dates as timestamps instead of formatted dates.