HighchartsDataOptions class

The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views. See also the tutorial article on the Data module.

It requires the modules/data.js file to be loaded.

Please note that the default way of adding data in Highcharts, without the need of a module, is through the series.type.data option.

API Docs: https://api.highcharts.com/highcharts/data

Inheritance

Constructors

HighchartsDataOptions.new({dynamic beforeParse, List? columnTypes, List<List>? columns, String? columnsURL, dynamic complete, String? csv, String? csvURL, double? dataRefreshRate, String? dateFormat, dynamic decimalPoint, bool? enablePolling, double? endColumn, double? endRow, bool? firstRowAsNames, String? googleAPIKey, String? googleSpreadsheetKey, String? googleSpreadsheetRange, String? googleSpreadsheetWorksheet, String? itemDelimiter, String? lineDelimiter, dynamic parseDate, dynamic parsed, List<List>? rows, String? rowsURL, List<Map<String, double>>? seriesMapping, double? startColumn, double? startRow, bool? switchRowsAndColumns, String? table})
The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views. See also the tutorial article on the Data module.

Properties

beforeParse ↔ dynamic
A callback function to modify the CSV before parsing it. Return the modified string.
getter/setter pair
columns ↔ List<List>?
A two-dimensional array representing the input data on tabular form. This input can be used when the data is already parsed, for example from a grid view component. Each cell can be a string or number. If not switchRowsAndColumns is set, the columns are interpreted as series.
getter/setter pair
columnsURL ↔ String?
A URL to a remote JSON dataset, structured as a column array. Will be fetched when the chart is created using Ajax.
getter/setter pair
columnTypes ↔ List?
An array option that specifies the data type for each column in the series loaded within the data module.
getter/setter pair
complete ↔ dynamic
The callback that is evaluated when the data is finished loading, optionally from an external source, and parsed. The first argument passed is a finished chart options object, containing the series. These options can be extended with additional options and passed directly to the chart constructor.
getter/setter pair
csv ↔ String?
A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.
getter/setter pair
csvURL ↔ String?
An URL to a remote CSV dataset. Will be fetched when the chart is created using Ajax.
getter/setter pair
dataRefreshRate ↔ double?
Sets the refresh rate for data polling when importing remote dataset by setting data.csvURL, data.rowsURL, data.columnsURL, or data.googleSpreadsheetKey.
getter/setter pair
dateFormat ↔ String?
Which of the predefined date formats in Date.prototype.dateFormats to use to parse date values. Defaults to a best guess based on what format gives valid and ordered dates. Valid options include: YYYY/mm/dd, dd/mm/YYYY, mm/dd/YYYY, dd/mm/YY, mm/dd/YY.
getter/setter pair
decimalPoint ↔ dynamic
The decimal point used for parsing numbers in the CSV.
getter/setter pair
enablePolling ↔ bool?
Enables automatic refetching of remote datasets every n seconds (defined by setting data.dataRefreshRate).
getter/setter pair
endColumn ↔ double?
In tabular input data, the last column (indexed by 0) to use. Defaults to the last column containing data.
getter/setter pair
endRow ↔ double?
In tabular input data, the last row (indexed by 0) to use. Defaults to the last row containing data.
getter/setter pair
firstRowAsNames ↔ bool?
Whether to use the first row in the data set as series names.
getter/setter pair
googleAPIKey ↔ String?
The Google Spreadsheet API key required for access generated at API Services / Credentials. See a comprehensive tutorial for setting up the key at the Hands-On Data Visualization book website.
getter/setter pair
googleSpreadsheetKey ↔ String?
The key or spreadsheetId value for a Google Spreadsheet to load. See developers.google.com for how to find the spreadsheetId.
getter/setter pair
googleSpreadsheetRange ↔ String?
The Google Spreadsheet range to use in combination with googleSpreadsheetKey. See developers.google.com for details.
getter/setter pair
googleSpreadsheetWorksheet ↔ String?
No longer works since v9.2.2, that uses Google Sheets API v4. Instead, use the googleSpreadsheetRange option to load a specific sheet.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
itemDelimiter ↔ String?
Item or cell delimiter for parsing CSV. Defaults to the tab character \t if a tab character is found in the CSV string, if not it defaults to ,.
getter/setter pair
lineDelimiter ↔ String?
Line delimiter for parsing CSV.
getter/setter pair
parsed ↔ dynamic
A callback function to access the parsed columns, the two-dimensional input data array directly, before they are interpreted into series data and categories. Return false to stop completion, or call this.complete() to continue async.
getter/setter pair
parseDate ↔ dynamic
A callback function to parse string representations of dates into JavaScript timestamps. Should return an integer timestamp on success.
getter/setter pair
rows ↔ List<List>?
The same as the columns input option, but defining rows instead of columns.
getter/setter pair
rowsURL ↔ String?
A URL to a remote JSON dataset, structured as a row array. Will be fetched when the chart is created using Ajax.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seriesMapping ↔ List<Map<String, double>>?
An array containing dictionaries for each series. A dictionary exists of Point property names as the key and the CSV column index as the value.
getter/setter pair
startColumn ↔ double?
In tabular input data, the first column (indexed by 0) to use.
getter/setter pair
startRow ↔ double?
In tabular input data, the first row (indexed by 0) to use.
getter/setter pair
switchRowsAndColumns ↔ bool?
Switch rows and columns of the input data, so that this.columns effectively becomes the rows of the data set, and the rows are interpreted as series.
getter/setter pair
table ↔ String?
An HTML table or the id of such to be parsed as input data. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used.
getter/setter pair

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