PlotOptionsArea
Related Docs:
object PlotOptionsArea
| package config
Allow this series' points to be selected by clicking on the markers or bars.
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.
5.0.0
The main color of the series.
The main color of 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.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
5.0.0
Compare the values of the series against the first non-null, non-zero value in the visible range.
Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will
show percentage or absolute change depending on whether compare is set to "percent"
or "value". When this is applied to multiple series, it allows comparing the development
of the series against each other.
1.0.1
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
5.0.6
Whether to draw a line between points on either side of a null point, or render a gap between them.
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.
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:
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option.
If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.
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.
5.0.0
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. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.
By default, series are exposed to screen readers as regions.
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.
5.0.12
Fill color or gradient for the area.
Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.
Fill opacity for the area.
Fill opacity for the area. When you set an explicit fillColor, the fillOpacity is not applied. Instead, you should define the opacity in the fillColor with an rgba color definition. The fillOpacity setting, also the default setting, overrides the alpha component of the color setting.
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
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.
5.0.10
Defines when to display a gap in the graph.
Defines when to display a gap in the graph. A gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken.
In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.
Together with gapSize, this option defines where to draw gaps in the graph.
Together with gapSize, this option defines where to draw gaps in the graph.
5.0.13
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.
2.1.6
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.
2.1.6
The sequential index of the series within the legend.
A separate color for the graph line.
A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.
Pixel with of the graph line.
The line cap used for line ends and line joins on the graph.
The id of another series to link to.
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.
1.3
Options for the point markers of line-type series.
Options for the point markers of line-type series. Properties like fillColor, lineColor and lineWidth define the visual appearance of the markers. Other series types, like column series, don't have markers, but have visual options on the series level instead.
In styled mode, the markers can be styled with the .highcharts-point, .highcharts-point-hover and .highcharts-point-select class names.
Options for the corresponding navigator series if showInNavigator is true for this series.
Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.
These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.
5.0.0
The color for the parts of the graph or points that are below the threshold.
The color for the parts of the graph or points that are below the threshold.
3.0
Properties for each single point
Same as accessibility.pointDescriptionFormatter, but for an individual series.
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
5.0.12
If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds.
If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds. For example, if a series contains one value each day, set pointInterval to 24 * 3600 * 1000.
Since Highstock 2.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.
2.1.0
Possible values: null, "on", "between".
Possible values: null, "on", "between".
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
Defaults to null in cartesian charts, "between" in polar charts.
1.2.0
The width of each point on the x axis.
The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value.
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. On a datetime X axis, the number will be given as milliseconds since 1970-01-01, for example Date.UTC(2011, 0, 1).
Whether to select the series initially.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend 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 1.1.7 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 or not to show the series in the navigator.
Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
5.0.0
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
5.0.12
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.
2.1.9
Whether to stack the values of each series on top of each other.
Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent". When stacking is enabled, data must be sorted in ascending X order.
Area with "normal" stacking.
A wrapper object for all the series options in specific states.
Whether to apply steps to the line.
Whether to apply steps to the line. Possible values are left, center and right. Prior to 1.2.5, only left was supported.
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 not shared. When stickyTracking 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, candlesticks etc.
The Y axis value to serve as the base for the area, for distinguishing between values above and below a threshold.
The Y axis value to serve as the base for the area, for distinguishing between values above and below a threshold. If null, the area behaves like a line series with fill between the graph and the Y axis minimum.
A configuration object for the tooltip rendering of each single 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.
Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.
Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.
2.2.4
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.
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
2.1.0
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.
In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).
2.1.0
JavaScript name:
plotOptions-area