Set the overall animation for all chart updating.
Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to false here. It can be overridden for each individual API method as a function parameter. The only animation not affected by this option is the initial series animation, see plotOptions.series.animation.
The animation can either be set as a boolean or a configuration object. If true
,
it will use the 'swing' jQuery easing and a duration of 500 ms. If used as a configuration object,
the following properties are supported:
<dl>
<dt>duration</dt>
<dt>easing</dt>
Math
object. See the easing demo.The background color or gradient for the outer chart area.
The color of the outer chart border.
The color of the outer chart border.
The corner radius of the outer chart border.
The corner radius of the outer chart border.
The pixel width of the outer chart border.
The pixel width of the outer chart border.
A CSS class name to apply to the charts container div
, allowing unique CSS styling for each chart.
A CSS class name to apply to the charts container div
, allowing unique CSS styling for each chart.
In styled mode, this sets how many colors the class names should rotate between.
In styled mode, this sets how many colors the class names should rotate between. With ten colors, series (or points) are given class names like highcharts-color-0
, highcharts-color-0
[...] highcharts-color-9
. The equivalent in non-styled mode is to set colors using the colors setting.
5.0.0
A text description of the chart.
A text description of the chart.
If the Accessibility module is loaded, this is included by default as a long description of the chart and its contents in the hidden screen reader information region.
5.0.0
Event listeners for the chart.
An explicit height for the chart.
An explicit height for the chart. If a number, the height is given in pixels. If given a percentage string (for example '56%'
), the height is given as the percentage of the actual chart width. This allows for preserving the aspect ratio across responsive sizes.
By default (when null
) the height is calculated from the offset height of the containing element, or 400 pixels if the containing element's height is 0.
Default mapData
for all series.
Default mapData
for all series.
If set to a string, it functions as an index into the Highcharts.maps
array.
Otherwise it is interpreted as map data.
5.0.0
Set lat/lon transformation definitions for the chart.
Set lat/lon transformation definitions for the chart. If not defined, these are extracted from the map data.
5.0.0
The margin between the outer edge of the chart and the plot area.
The margin between the outer edge of the chart and the plot area. The numbers in the array designate top, right, bottom and left respectively. Use the options marginTop
, marginRight
, marginBottom
and marginLeft
for shorthand setting of one option.
By default there is no margin. The actual space is dynamically calculated from the offset of axis labels, axis title, title, subtitle and legend in addition to the spacingTop
, spacingRight
, spacingBottom
and spacingLeft
options.
Defaults to [null]
.
The margin between the bottom outer edge of the chart and the plot area.
The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed
pixel value for the margin as opposed to the default dynamic margin. See also spacingBottom
.
The margin between the left outer edge of the chart and the plot area.
The margin between the left outer edge of the chart and the plot area. Use this to set a fixed
pixel value for the margin as opposed to the default dynamic margin. See also spacingLeft
.
The margin between the right outer edge of the chart and the plot area.
The margin between the right outer edge of the chart and the plot area. Use this to set a fixed
pixel value for the margin as opposed to the default dynamic margin. See also spacingRight
.
The margin between the top outer edge of the chart and the plot area.
The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingTop
.
The background color or gradient for the plot area.
The URL for an image to use as the plot background.
The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
The color of the inner chart or plot area border.
The color of the inner chart or plot area border.
The pixel width of the plot area border.
The pixel width of the plot area border.
Whether to apply a drop shadow to the plot area.
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
Whether to reflow the chart to fit the width of the container div on resizing the window.
Whether to reflow the chart to fit the width of the container div on resizing the window.
Move the bar between the JavaScript frame and the Preview frame to see the effect: True by default, false.
The HTML element where the chart will be rendered.
The HTML element where the chart will be rendered. If it is a string, the element by that id is used. The HTML element can also be passed by direct reference, or as the first argument of the chart constructor, in which case the option is not needed.
The button that appears after a selection zoom, allowing the user to reset zoom.
The button that appears after a selection zoom, allowing the user to reset zoom. In Highmaps, the reset zoom button is rarely used, as the controls for mapNavigation are used instead.
For live demos, see the resetZoomButton options for basic Highcharts.
The background color of the marker square when selecting (zooming in on) an area of the chart.
Whether to apply a drop shadow to the outer chart area.
Whether to apply a drop shadow to the outer chart area. Requires that
backgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
The distance between the outer edge of the chart and the content, like title or legend, or axis title or labels if present.
The distance between the outer edge of the chart and the content, like title or legend, or axis title or labels if present. The numbers in the array designate top, right, bottom and left respectively. Use the options spacingTop, spacingRight, spacingBottom and spacingLeft options for shorthand setting of one option.
The space between the bottom edge of the chart and the content (plot area, title, subtitle or legend in top position).
The space between the bottom edge of the chart and the content (plot area, title, subtitle or legend in top position).
The space between the left edge of the chart and the content (plot area,title, subtitle or legend in top position).
The space between the left edge of the chart and the content (plot area,title, subtitle or legend in top position).
The space between the right edge of the chart and the content (plot area, title, subtitle or legend in top position).
The space between the right edge of the chart and the content (plot area, title, subtitle or legend in top position).
The space between the top edge of the chart and the content (plot area, title, subtitle or legend in top position).
The space between the top edge of the chart and the content (plot area, title, subtitle or legend in top position).
Additional CSS styles to apply inline to the container div
.
Additional CSS styles to apply inline to the container div
. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally.
The default series type for the chart.
The default series type for the chart. Can be any of the chart types listed under plotOptions.
A text description of the chart type.
A text description of the chart type.
If the Accessibility module is loaded, this will be included in the description of the chart in the screen reader information region.
Highcharts will by default attempt to guess the chart type, but for more complex charts it is recommended to specify this property for clarity.
5.0.0
An explicit width for the chart.
An explicit width for the chart. By default (when null
) the width is calculated from the offset width of the containing element.
JavaScript name:
chart