io.udash.wrappers.highcharts.config.series.guage
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.
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 solidgauge
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: 5,. name: "Point2",. color: "#00FF00". }, {. y: 7,. 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.
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.
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 .
Whether the strokes of the solid gauge should be round
or square
.
The name of the series as shown in the legend, tooltip etc.
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.
Properties for each single point
Wether to draw rounded edges on the gauge. Defaults to false.
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.
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.