HighchartsExportingCsvOptions class

Options for exporting data to CSV or ExCel, or displaying the data in a HTML table or a JavaScript structure.

This module adds data export options to the export menu and provides functions like Chart.getCSV, Chart.getTable, Chart.getDataRows and Chart.viewData.

The XLS converter is limited and only creates a HTML string that is passed for download, which works but creates a warning before opening. The workaround for this is to use a third party XLSX converter, as demonstrated in the sample below.

API Docs: https://api.highcharts.com/highcharts/exporting.csv

Inheritance

Constructors

HighchartsExportingCsvOptions.new({HighchartsExportingCsvAnnotationsOptions? annotations, dynamic columnHeaderFormatter, String? dateFormat, String? decimalPoint, String? itemDelimiter, String? lineDelimiter})
Options for exporting data to CSV or ExCel, or displaying the data in a HTML table or a JavaScript structure.

Properties

annotations ↔ HighchartsExportingCsvAnnotationsOptions?
Options for annotations in the export-data table.
getter/setter pair
columnHeaderFormatter ↔ dynamic
Formatter callback for the column headers. Parameters are:
getter/setter pair
dateFormat ↔ String?
Which date format to use for exported dates on a datetime X axis. See Highcharts.dateFormat.
getter/setter pair
decimalPoint ↔ String?
Which decimal point to use for exported CSV. Defaults to the same as the browser locale, typically . (English) or , (German, French etc).
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
itemDelimiter ↔ String?
The item delimiter in the exported data. Use ; for direct exporting to Excel. Defaults to a best guess based on the browser locale. If the locale decimal point is ,, the itemDelimiter defaults to ;, otherwise the itemDelimiter defaults to ,.
getter/setter pair
lineDelimiter ↔ String?
The line delimiter in the exported data, defaults to a newline.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited