Skip to main content

CsvExportOptions

Defined in: src/dataframe/types.ts:21

Csv export options to be used in DataFrame.toCsv

Properties

PropertyTypeDescriptionDefined in
columnFormats?ColumnsFormatCsvExportOptionsColumn-specific formats (column name -> format). For format examples, see [dateTimeFormatters].src/dataframe/types.ts:61
columns?string[]Column ordersrc/dataframe/types.ts:51
delimiter?stringField delimiter; comma if not specifiedsrc/dataframe/types.ts:24
filteredRowsOnly?booleanWhether only filtered rows are included. Will be combined with [selectedRowsOnly].src/dataframe/types.ts:42
includeHeader?booleanWhether the header row containing column names is included. True if not specified.src/dataframe/types.ts:33
includeUtf8Bom?booleanWhether to include UTF-8 BOM marker at the beginning of the file. Helps Excel correctly detect UTF-8 encoding for multibyte characters.src/dataframe/types.ts:67
missingValue?stringTextual representation of the missing value. Empty string if not specified.src/dataframe/types.ts:30
moleculesAsSmiles?boolean-src/dataframe/types.ts:57
newLine?stringNew line character; \n if not specifiedsrc/dataframe/types.ts:27
qualifierAsColumn?booleanExpands qualified numbers into two columns: qual(column) and columnsrc/dataframe/types.ts:54
rowIndexes?number[]Explicitly defined order of rows. Mutually exclusive with [selectedRowsOnly] or [filteredRowsOnly].src/dataframe/types.ts:48
selectedColumnsOnly?booleanWhether only selected columns are included. False if not specified.src/dataframe/types.ts:36
selectedRowsOnly?booleanWhether only selected rows are included. Will be combined with [filteredRowsOnly].src/dataframe/types.ts:45
visibleColumnsOnly?booleanWhether only visible columns are included. False if not specified.src/dataframe/types.ts:39