HighchartsHLCSeriesDataOptions class

An array of data points for the series. For the hlc series type, points can be given in the following ways:

  1. An array of arrays with 4 or 3 values. In this case, the values correspond to x,high,low,close. If the first value is a string, it is applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length of 3. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options.

  2. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.

API Docs: https://api.highcharts.com/highstock/series.hlc.data

Inheritance

Constructors

HighchartsHLCSeriesDataOptions.new({HighchartsHLCSeriesDataAccessibilityOptions? accessibility, double? close, String? color, Map<String, dynamic>? custom, HighchartsHLCSeriesDataDataLabelsOptions? dataLabels, String? description, HighchartsHLCSeriesDataDragDropOptions? dragDrop, HighchartsHLCSeriesDataEventsOptions? events, double? high, String? id, double? labelrank, double? low, String? name, bool? selected, dynamic x})
An array of data points for the series. For the hlc series type, points can be given in the following ways:

Properties

accessibility ↔ HighchartsHLCSeriesDataAccessibilityOptions?
Accessibility options for a data point.
getter/setter pair
close ↔ double?
The closing value of each data point.
getter/setter pair
color ↔ String?
Individual color for the point. By default the color is pulled from the global colors array.
getter/setter pair
custom ↔ Map<String, dynamic>?
A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
getter/setter pair
dataLabels ↔ HighchartsHLCSeriesDataDataLabelsOptions?
Highcharts Options Widget.
getter/setter pair
description ↔ String?
A description of the point to add to the screen reader information about the point.
getter/setter pair
dragDrop ↔ HighchartsHLCSeriesDataDragDropOptions?
Point specific options for the draggable-points module. Overrides options on series.dragDrop.
getter/setter pair
events ↔ HighchartsHLCSeriesDataEventsOptions?
The individual point events.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
high ↔ double?
The high or maximum value for each data point.
getter/setter pair
id ↔ String?
An id for the point. This can be used after render time to get a pointer to the point object through chart.get().
getter/setter pair
labelrank ↔ double?
The rank for this point's data label in case of collision. If two data labels are about to overlap, only the one with the highest labelrank will be drawn.
getter/setter pair
low ↔ double?
The low or minimum value for each data point.
getter/setter pair
name ↔ String?
The name of the point as shown in the legend, tooltip, dataLabels, etc.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether the data point is selected initially.
getter/setter pair
x ↔ dynamic
The x value of the point.
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