SeriesHeatmap
Related Docs:
object SeriesHeatmap
| package config
Allow this series' points to be selected by clicking on the shapes.
Allow this series' points to be selected by clicking on the shapes. Selected points can be read through the Chart.getSelectedPoints() method.
Allow select on map area, map bubble
Enable or disable the initial animation when a series is displayed.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported: <dl> <dt>duration</dt>
Math object. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for map series, but enabled on mapbubble series.
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.
The border color of the map areas.
The border color of the map areas.
In styled mode, the border stroke is given in the .highcharts-point class.
The border width of each map area.
The border width of each map area.
In styled mode, the border stroke width is given in the .highcharts-point class.
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.
5.0.0
The main color of the series.
The main color of the series. In maps, this color is rarely used, as most choropleth maps use the color to denote the value of each point. The series color can however be used in a map with multiple series holding categorized data. The default value is pulled from the options.colors array.
In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.
Set this option to false to prevent a series from connecting to the global color axis.
Set this option to false to prevent a series from connecting to the global color axis. This will cause the series to have its own legend item.
Styled mode only.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
5.0.0
The column size - how many X axis units each column in the heatmap should span.
The column size - how many X axis units each column in the heatmap should span.
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.
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.
Pointer cursor on map area, map bubble
An array of data points for the series.
An array of data points for the series. For the heatmap series type, points can be given in the following ways:
-
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.
data: [
[0, 9, 5],
[1, 3, 5],
[2, 8, 8]
]
-
An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{
x: 1,
y: 3,
value: 1,
name: "Point2",
color: "#00FF00"
}, {
x: 1,
y: 1,
value: 2,
name: "Point1",
color: "#FF00FF"
}]
Options for the series data labels, appearing next to each data point.
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
5.0.0
Enable or disable the mouse tracking for a specific series.
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.
By default, series are exposed to screen readers as regions.
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
5.0.12
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.
Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
5.0.10
An id for the series.
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
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.
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.
The sequential index of the series in the legend.
An array of objects containing a path definition and optionally a code or property to join in the data as per the joinBy option.
An array of objects containing a path definition and optionally a code or property to join in the data as per the joinBy option.
The name of the series as shown in the legend, tooltip etc.
The name of the series as shown in the legend, tooltip etc.
The color for the parts of the graph or points that are below the threshold.
The color for the parts of the graph or points that are below the threshold.
3.0
The color to apply to null points.
The color to apply to null points.
In styled mode, the null point fill is set in the .highcharts-null-point class.
Whether to allow pointer interaction like tooltips and mouse events on null points.
Whether to allow pointer interaction like tooltips and mouse events on null points.
4.2.7
Properties for each single point
Same as accessibility.pointDescriptionFormatter, but for an individual series.
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
5.0.12
The row size - how many Y axis units each heatmap row should span.
The row size - how many Y axis units each heatmap row should span.
Whether to select the series initially.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
Whether to apply a drop shadow to the shapes.
Whether to apply a drop shadow to the shapes. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
If true, and the series has a unique legend item, a checkbox is displayed next to the legend item to allow selecting the series.
If true, and the series has a unique legend item, 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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.
Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
5.0.12
A wrapper object for all the series options in specific states.
Sticky tracking of mouse events.
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.
A configuration object for the tooltip rendering of each single series.
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
The type of series.
The type of series. Can be one of area, areaspline,
bar, column, line, pie,
scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
Set the initial visibility of the series.
Define the z index of the series.
JavaScript name:
series<heatmap>