SeriesGauge
Related Docs:
class SeriesGauge
| package config
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 or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. 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.
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 gauge series type, points can be given in the following ways:. .
y 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: [{. y: 6,. name: "Point2",. color: "#00FF00". }, {. y: 8,. name: "Point1",. color: "#FF00FF". }]
The typical gauge only contains a single data value.Data labels for the gauge. For gauges, the data labels are enabled by default and shown in a bordered box below the point.
Requires Accessibility module. A description of the series to add to the screen reader information about the series.
Options for the dial or arrow pointer of the gauge.. .
In styled mode, the dial is styled with the .highcharts-gauge-series .highcharts-dial rule.
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.
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
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.
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.
The sequential index of the series in the legend. Try it: Legend in opposite order .
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.
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.
Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis.
Options for the pivot or the center point of the gauge.. .
In styled mode, the pivot is styled with the .highcharts-gauge-series .highcharts-pivot rule.
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.
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.
Whether to display this particular series or series type in the legend. Defaults to false for gauge series.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
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. Defaults to true for line and area type series, but to false for columns, pies etc.
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
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.
When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.
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.
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.
Define the visual z index of the series.