SeriesMapbubble
Related Docs:
class SeriesMapbubble
| package config
Whether all areas of the map defined in mapData should be rendered. If true, areas which don't correspond to a data point, are rendered as null points. If false, those areas are skipped.
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.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.. .
In styled mode, the border stroke is given in the .highcharts-point class.
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.
The main color of the series. This color affects both the fill and the stroke of the bubble. For enhanced control, use marker options.
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. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
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 mapbubble series type, points can be given in the following ways:. .
z options. Example:.
data: [0, 5, 3, 5]- 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: [{. z: 9,. name: "Point2",. color: "#00FF00". }, {. z: 10,. name: "Point1",. color: "#FF00FF". }]
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. A description of the series to add to the screen reader information about the series.
Whether to display negative sized bubbles. The threshold is given by the zThreshold option, and negative bubbles can be visualized by setting negativeColor.
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 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.
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.
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.
What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object.. .
The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data.. .
When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.
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.
Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.
Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.
The name of the series as shown in the legend, tooltip etc.
When a point's Z value is below the zThreshold setting, this color is used.
Properties for each single point
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
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.
Whether the bubble's value should be represented by the area or the width of the bubble. The default, area, corresponds best to the human perception of the size of each bubble.
When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
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.
The minimum for the Z value range. Defaults to the highest Z value in the data.
The minimum for the Z value range. Defaults to the lowest Z value in the data.
When displayNegative is false, bubbles with lower Z values are skipped. When displayNegative is true and a negativeColor is given, points with lower Z is colored.