SeriesHeatmap
Related Docs:
class SeriesHeatmap
| package config
Allow this series' points to be selected by clicking on the shapes. Selected points can be read through the Chart.getSelectedPoints() method.
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.The border color of the map areas.
The border width of each map area.
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.
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.
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". }]
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.
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 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.
The name of the series as shown in the legend, tooltip etc.
The color to apply to null points.
Properties for each single point
The row size - how many Y axis units each heatmap row should span.
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. 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. 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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.
A wrapper object for all the series options in specific states.
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. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
Set the initial visibility of the series.
Define the z index of the series.