PlotOptionsMapline
Related Docs:
class PlotOptionsMapline
| 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.
A class name to apply to the series' graphical elements.
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. 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.
A name for the dash style to use for the map area outline or the map line. The value for the dashStyle include:. .
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.
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.
Fill color for the map line shapes
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.
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 width of the map line.
The color for the parts of the graph or points that are below the threshold.
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.
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.