HighmapsConfig
Related Docs:
object HighmapsConfig
| package config
Options for configuring accessibility for the chart.
Options for configuring accessibility for the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.
5.0.0
Options regarding the chart area and plot area as well as general chart options.
A color axis for choropleth mapping.
A color axis for choropleth mapping. Visually, the color axis will appear as a gradient or as separate items inside the legend, depending on whether the axis is scalar or based on data classes.
For supported color formats, see the docs article about colors.
A scalar color axis is represented by a gradient. The colors either range between the minColor and the maxColor, or for more fine grained control the colors can be defined in stops. Often times, the color axis needs to be adjusted to get the right color spread for the data. In addition to stops, consider using a logarithmic axis type, or setting min and max to avoid the colors being determined by outliers.
When dataClasses are used, the ranges are subdivided into separate classes like categories based on their values. This can be used for ranges between two values, but also for a true category. However, when your data is categorized, it may be as convenient to add each category to a separate series.
See the Axis object for programmatic access to the axis.
An array containing the default colors for the chart's series.
An array containing the default colors for the chart's series. When all colors are used, new colors are pulled from the start again. Defaults to:
colors: ['#7cb5ec', '#434348', '#90ed7d', '#f7a35c', '#8085e9', '#f15c80', '#e4d354', '#8085e8', '#8d4653', '#91e8e1']
In styled mode, the colors option doesn't exist. Instead, colors are defined in CSS and applied either through series or point class names, or through the chart.colorCount option.
Highchart by default puts a credits label in the lower right corner of the chart.
Highchart by default puts a credits label in the lower right corner of the chart. This can be changed using these options.
Styled mode only.
Styled mode only. Configuration object for adding SVG definitions for reusable elements. See gradients, shadows and patterns for more information and code examples.
5.0.0
Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items like columns or pie slices.
Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items like columns or pie slices.
The drilldown feature requires the drilldown.js file to be loaded, found in the modules directory of the download package, or online at code.highcharts.com/modules/drilldown.js.
Options for the exporting module.
Options for the exporting module. For an overview on the matter, see the docs.
Global options that don't apply to each chart.
Global options that don't apply to each chart. These options, like the lang
options, must be set using the Highcharts.setOptions method.
Highcharts.setOptions({
global: {
useUTC: false
}
});
HTML labels that can be positioned anywhere in the chart area.
Language object.
Language object. The language object is global and it can't
be set on each chart initiation. Instead, use Highcharts.setOptions to
set it before any chart is initiated.
Highcharts.setOptions({
lang: {
months: ['Janvier', 'Février', 'Mars', 'Avril', 'Mai', 'Juin', 'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 'Décembre'],
weekdays: ['Dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi']
}
});
The legend is a box containing explanations for the different elements of a chart.
The legend is a box containing explanations for the different elements of a chart. A Highmaps legend by default contains one legend item per series, but if a colorAxis is defined, the axis will be displayed in the legen. Either as a gradient, or as multiple legend items for dataClasses.
The loading options control the appearance of the loading screen that covers the plot area on chart operations.
The loading options control the appearance of the loading screen that covers the
plot area on chart operations. This screen only appears after an explicit call
to chart.showLoading(). It is a utility for developers to communicate
to the end user that something is going on, for example while retrieving new data
via an XHR connection. The "Loading..." text itself is not part of this configuration
object, but part of the lang object.
For demo cases, see the loading configuration object for basic Highcharts.
A collection of options for zooming and panning in a map.
A collection of options for buttons and menus appearing in the exporting module.
A collection of options for buttons and menus appearing in the exporting module.
The examples below point to basic Highcharts demos, but the syntax for Highmaps are the exact same.
The plotOptions is a wrapper object for config objects for each series type.
The plotOptions is a wrapper object for config objects for each series type. The config objects for each series can also be overridden for each series item as given in the series array.
Configuration options for the series are given in three levels. Options for all series in a chart are given in the plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type, for example plotOptions.line. Next, options for one single series are given in the series array.
Allows setting a set of rules to apply for different screen or chart sizes.
Allows setting a set of rules to apply for different screen or chart sizes. Each rule specifies additional chart options.
Responsive axis, legend and class name.
5.0.0
The actual series to append to the chart.
The actual series to append to the chart. In addition to
the members listed below, any member of the plotOptions for that specific
type of plot can be added to a series individually.
The chart's subtitle.
The chart's subtitle. This can be used both to display a subtitle below the main title, and to display random text anywhere in the chart. The subtitle can be updated after chart initialization through the Chart.setTitle() method.
The chart's main title.
The chart's main title.
Options for the tooltip that appears when the user hovers over a series or point.
The X axis.
The X axis. A Highcharts map has hidden X and Y axes to control layout of the shapes and features like zooming and panning. Zooming is in effect the same as setting the extremes of one of the axes, and Highmaps is set up to make the other axis zoom the same amount.
Highmaps uses the coordinate system of the map points' path configurations.
See the Axis object for programmatic access to the axis.
The Y axis.
The Y axis. A Highcharts map has hidden X and Y axes to control layout of the shapes and features like zooming and panning. Zooming is in effect the same as setting the extremes of one of the axes, and Highmaps is set up to make the other axis zoom the same amount.
Highmaps uses the coordinate system of the map points' path configurations.
See the Axis object for programmatic access to the axis.
JavaScript name:
HighmapsConfig