class HighmapsConfig extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
HighmapsConfig
- Alphabetic
- By Inheritance
- HighmapsConfig
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HighmapsConfig()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
accessibility: UndefOr[CleanJsObject[Accessibility]]
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.
- Since
5.0.0
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
chart: UndefOr[CleanJsObject[Chart]]
Options regarding the chart area and plot area as well as general chart options.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
colorAxis: UndefOr[CleanJsObject[ColorAxis]]
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.
-
val
colors: UndefOr[Array[|[String, Object]]]
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.
-
val
credits: UndefOr[CleanJsObject[Credits]]
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.
-
val
defs: UndefOr[Object]
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.
- Since
5.0.0
-
val
drilldown: UndefOr[CleanJsObject[Drilldown]]
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 themodules
directory of the download package, or online at code.highcharts.com/modules/drilldown.js.Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
exporting: UndefOr[CleanJsObject[Exporting]]
Options for the exporting module.
Options for the exporting module. For an overview on the matter, see the docs.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
val
global: UndefOr[CleanJsObject[Global]]
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 theHighcharts.setOptions
method.Highcharts.setOptions({ global: { useUTC: false } });
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
labels: UndefOr[CleanJsObject[Labels]]
HTML labels that can be positioned anywhere in the chart area.
-
val
lang: UndefOr[CleanJsObject[Lang]]
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'] } });
-
val
legend: UndefOr[CleanJsObject[Legend]]
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.
-
val
loading: UndefOr[CleanJsObject[Loading]]
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 thelang
object.For demo cases, see the loading configuration object for basic Highcharts.
-
val
mapNavigation: UndefOr[CleanJsObject[MapNavigation]]
A collection of options for zooming and panning in a map.
-
val
navigation: UndefOr[CleanJsObject[Navigation]]
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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
plotOptions: UndefOr[CleanJsObject[PlotOptions]]
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.
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
responsive: UndefOr[CleanJsObject[Responsive]]
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.
- Since
5.0.0
Example: -
val
series: UndefOr[Array[CleanJsObject[|[|[|[|[SeriesHeatmap, SeriesMap], SeriesMapbubble], SeriesMapline], SeriesMappoint]]]]
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. -
val
subtitle: UndefOr[CleanJsObject[Subtitle]]
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.Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
title: UndefOr[CleanJsObject[Title]]
The chart's main title.
The chart's main title.
Example: -
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
tooltip: UndefOr[CleanJsObject[Tooltip]]
Options for the tooltip that appears when the user hovers over a series or point.
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
xAxis: UndefOr[CleanJsObject[XAxis]]
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.
-
val
yAxis: UndefOr[CleanJsObject[YAxis]]
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.