HighchartsTilemapSeriesOptions class

A tilemap series. If the type option is not specified, it is inherited from chart.type.

Configuration options for the series are given in three levels:

  1. Options for all series in a chart are defined in the plotOptions.series object.
  2. Options for all tilemap series are defined in plotOptions.tilemap.
  3. Options for one single series are given in the series instance array.

API Docs: https://api.highcharts.com/highcharts/series.tilemap

Inheritance

Constructors

HighchartsTilemapSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, bool? animation, double? borderRadius, double? borderWidth, String? className, bool? clip, String? color, dynamic colorAxis, double? colorIndex, String? colorKey, double? colsize, bool? crisp, String? cursor, Map<String, dynamic>? custom, HighchartsTilemapSeriesDataLabelsOptions? dataLabels, String? description, bool? enableMouseTracking, HighchartsSeriesEventsOptions? events, String? id, bool? inactiveOtherPoints, bool? includeInDataExport, double? index, bool? interpolation, List<String>? keys, HighchartsSeriesLabelOptions? label, double? legendIndex, String? legendSymbol, String? linkedTo, String? negativeColor, String? nullColor, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, double? pointPadding, bool? relativeXValue, double? rowsize, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, HighchartsSeriesSonificationOptions? sonification, HighchartsTilemapSeriesStatesOptions? states, bool? stickyTracking, String? tileShape, HighchartsTilemapSeriesTooltipOptions? tooltip, double? turboThreshold, bool? visible, dynamic xAxis, dynamic yAxis, double? zIndex, String? zoneAxis, List<HighchartsSeriesZonesOptions>? zones})
A tilemap series. If the type option is not specified, it is inherited from chart.type.

Properties

accessibility ↔ HighchartsSeriesAccessibilityOptions?
Accessibility options for a series.
getter/setter pair
allowPointSelect ↔ bool?
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
getter/setter pair
animation ↔ bool?
Animation is disabled by default on the heatmap series.
getter/setter pair
borderRadius ↔ double?
The border radius for each heatmap item. The border's color and width can be set in marker options.
getter/setter pair
borderWidth ↔ double?
The border width for each heatmap item.
getter/setter pair
className ↔ String?
An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
getter/setter pair
clip ↔ bool?
Highcharts Options Widget.
getter/setter pair
color ↔ String?
The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
getter/setter pair
colorAxis ↔ dynamic
When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series from connecting to the default color axis.
getter/setter pair
colorIndex ↔ double?
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
getter/setter pair
colorKey ↔ String?
Highcharts Options Widget.
getter/setter pair
colsize ↔ double?
The column size - how many X axis units each column in the tilemap should span. Works as in Heatmaps.
getter/setter pair
crisp ↔ bool?
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.
getter/setter pair
cursor ↔ String?
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
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 ↔ HighchartsTilemapSeriesDataLabelsOptions?
Highcharts Options Widget.
getter/setter pair
description ↔ String?
A description of the series to add to the screen reader information about the series.
getter/setter pair
enableMouseTracking ↔ bool?
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
getter/setter pair
events ↔ HighchartsSeriesEventsOptions?
General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
getter/setter pair
inactiveOtherPoints ↔ bool?
Highlight only the hovered point and fade the remaining points.
getter/setter pair
includeInDataExport ↔ bool?
When set to false will prevent the series data from being included in any form of data export.
getter/setter pair
index ↔ double?
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
getter/setter pair
interpolation ↔ bool?
Make the heatmap render its data points as an interpolated image.
getter/setter pair
keys ↔ List<String>?
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
getter/setter pair
label ↔ HighchartsSeriesLabelOptions?
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
getter/setter pair
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
Highcharts Options Widget.
getter/setter pair
linkedTo ↔ String?
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
getter/setter pair
negativeColor ↔ String?
The color for the parts of the graph or points that are below the threshold. Note that zones takes precedence over the negative color. Using negativeColor is equivalent to applying a zone with value of 0.
getter/setter pair
nullColor ↔ String?
The color applied to null points. In styled mode, a general CSS class is applied instead.
getter/setter pair
nullInteraction ↔ bool?
Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline.
getter/setter pair
onPoint ↔ HighchartsSeriesOnPointOptions?
Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
getter/setter pair
opacity ↔ double?
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
getter/setter pair
point ↔ HighchartsSeriesPointOptions?
Properties for each single point.
getter/setter pair
pointDescriptionFormat ↔ dynamic
Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointDescriptionFormatter ↔ dynamic
Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointPadding ↔ double?
The padding between points in the tilemap.
getter/setter pair
relativeXValue ↔ bool?
When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
getter/setter pair
rowsize ↔ double?
The row size - how many Y axis units each tilemap row should span. Analogous to colsize.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
getter/setter pair
showCheckbox ↔ bool?
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
getter/setter pair
showInLegend ↔ bool?
Whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. Since v7.2.0 it is possible to show series that use colorAxis by setting this option to true.
getter/setter pair
skipKeyboardNavigation ↔ bool?
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
getter/setter pair
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
states ↔ HighchartsTilemapSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
stickyTracking ↔ bool?
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
getter/setter pair
tileShape ↔ String?
The shape of the tiles in the tilemap. Possible values are hexagon, circle, diamond, and square.
getter/setter pair
tooltip ↔ HighchartsTilemapSeriesTooltipOptions?
Highcharts Options Widget.
getter/setter pair
turboThreshold ↔ double?
When a series contains a data array that is longer than this, the Series class looks for data configurations of plain numbers or arrays of numbers. The first and last valid points are checked. If found, the rest of the data is assumed to be the same. This saves expensive data checking and indexing in long series, and makes data-heavy charts render faster.
getter/setter pair
visible ↔ bool?
Set the initial visibility of the series.
getter/setter pair
xAxis ↔ dynamic
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
getter/setter pair
yAxis ↔ dynamic
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the series.
getter/setter pair
zoneAxis ↔ String?
Defines the Axis on which the zones are applied.
getter/setter pair
zones ↔ List<HighchartsSeriesZonesOptions>?
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option. The zone definitions have to be in ascending order regarding to the value.
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