HighchartsHeatmapSeriesDataOptions class

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

  1. An array of arrays with 3 or 2 values. In this case, the values correspond to x,y,value. 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 2. 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/highcharts/series.heatmap.data

Inheritance

Constructors

HighchartsHeatmapSeriesDataOptions.new({HighchartsHeatmapSeriesDataAccessibilityOptions? accessibility, String? className, String? color, double? colorIndex, Map<String, dynamic>? custom, List<HighchartsHeatmapSeriesDataDataLabelsOptions>? dataLabels, String? description, HighchartsHeatmapSeriesDataDragDropOptions? dragDrop, String? drilldown, HighchartsHeatmapSeriesDataEventsOptions? events, String? id, double? labelrank, HighchartsHeatmapSeriesDataMarkerOptions? marker, String? name, double? pointPadding, bool? selected, double? value, double? x, double? y})
An array of data points for the series. For the heatmap series type, points can be given in the following ways:

Properties

accessibility ↔ HighchartsHeatmapSeriesDataAccessibilityOptions?
Accessibility options for a data point.
getter/setter pair
className ↔ String?
An additional, individual class name for the data point's graphic representation. Changes to a point's color will also be reflected in a chart's legend and tooltip.
getter/setter pair
color ↔ String?
The color of the point. In heat maps the point color is rarely set explicitly, as we use the color to denote the value. Options for this are set in the colorAxis configuration.
getter/setter pair
colorIndex ↔ double?
A specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}. In styled mode this will change the color of the graphic. In non-styled mode, the color is set by the fill attribute, so the change in class name won't have a visual effect by default.
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 ↔ List<HighchartsHeatmapSeriesDataDataLabelsOptions>?
Individual data label for each point. The options are the same as the ones for plotOptions.series.dataLabels.
getter/setter pair
description ↔ String?
A description of the point to add to the screen reader information about the point.
getter/setter pair
dragDrop ↔ HighchartsHeatmapSeriesDataDragDropOptions?
Point specific options for the draggable-points module. Overrides options on series.dragDrop.
getter/setter pair
drilldown ↔ String?
The id of a series in the drilldown.series array to use for a drilldown for this point.
getter/setter pair
events ↔ HighchartsHeatmapSeriesDataEventsOptions?
The individual point events.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
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
marker ↔ HighchartsHeatmapSeriesDataMarkerOptions?
Highcharts Options Widget.
getter/setter pair
name ↔ String?
The name of the point as shown in the legend, tooltip, dataLabels, etc.
getter/setter pair
pointPadding ↔ double?
Point padding for a single point.
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
value ↔ double?
The value of the point, resulting in a color controlled by options as set in the colorAxis configuration.
getter/setter pair
x ↔ double?
The x value of the point. For datetime axes, the X value is the timestamp in milliseconds since 1970.
getter/setter pair
y ↔ double?
The y 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