io.udash.wrappers.highcharts.config.series.bubble
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Enable or disable the initial animation when a series is displayed.
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.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
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 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.
A class name to apply to the series' graphical elements.
The main color or the series.
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.
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.
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.
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.
Pointer cursor on line graph, on columns, on scatter markers
A name for the dash style to use for the graph.
A name for the dash style to use for the graph. Applies only to series type having a graph,
like line
, spline
, area
and scatter
in
case it has a lineWidth
. The value for the dashStyle
include:
An array of data points for the series.
An array of data points for the series. For the area
series type, points can be given in the following ways:
y
options. The x
values will be automatically calculated,
either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis
has categories, these will be used. Example:
data: [0, 5, 3, 5]
-
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is
applied as the name of the point, and the x
value is inferred.
data: [ [0, 9], [1, 7], [2, 6] ]
-
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: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
The demos use a line series, but the principle is the same for all types.
Options for the series data labels, appearing next to each data point.
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
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Whether to display negative sized bubbles.
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.
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.
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.
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 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.
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.
The width of the line connecting the data points.
The width of the line connecting the data points.
The id of another series to link to.
Maximum bubble size.
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.
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.
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.
When a point's Z value is below the zThreshold setting, this color is used.
Properties for each single point
Properties for each single point
If no x values are given for the points in a series, pointInterval defines the interval of the x values.
If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
Since Highcharts 4.1, it can be combined with pointIntervalUnit
to draw irregular intervals.
On datetime series, this allows for setting the pointInterval
to irregular time units, day
, month
and year
.
On datetime series, this allows for setting the pointInterval
to irregular time units, day
, month
and year
. A day is usually the same as
24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time.
Combine this option with pointInterval
to draw weeks, quarters, 6 months, 10 years etc.
If no x values are given for the points in a series, pointStart defines on what value to start.
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
Whether to select the series initially.
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 graph line.
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration
containing color
, offsetX
, offsetY
, opacity
and width
.
If true, a checkbox is displayed next to the legend item to allow selecting the 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.
Whether to display this particular series or series type in the legend. The default value
is true
for standalone series, false
for linked series.
Whether the bubble's value should be represented by the area or the width of the bubble.
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.
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
.
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if softThreshold
is false
, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding
option. If softThreshold
is true
, the Y axis starts at 0.
A wrapper object for all the series options in specific states.
A wrapper object for all the series options in specific states.
Sticky tracking of mouse events.
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.
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.
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
When a series contains a data array that is longer than this, only one dimensional arrays of numbers,
or two dimensional arrays with x and y values are allowed. Also, only the first
point is tested, and the rest are assumed to be the same format. This saves expensive
data checking and indexing in long series. Set it to 0
disable.
Set the initial visibility of the series.
Set the initial visibility of the series.
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
Define the visual z index of the series.
Define the visual z index of the series.
The minimum for the Z value range.
The minimum for the Z value range. Defaults to the highest Z value in the data.
The minimum for the Z value range.
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 false
, bubbles with lower Z values
are skipped. When displayNegative
is true
and a negativeColor
is given, points with lower Z is colored.
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
An array defining zones within a series.
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles,
according to the zoneAxis
option.