class HighchartsConfig extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
HighchartsConfig
- Alphabetic
- By Inheritance
- HighchartsConfig
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HighchartsConfig()
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
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', '#2b908f', '#f45b5b', '#91e8e1']
Default colors can also be set on a series or series.type basis, see column.colors, pie.colors.
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.
Legacy
In Highcharts 3.x, the default colors were:
colors: ['#2f7ed8', '#0d233a', '#8bbc21', '#910000', '#1aadce', '#492970', '#f28f43', '#77a1e5', '#c42525', '#a6c96a']
In Highcharts 2.x, the default colors were:
colors: ['#4572A7', '#AA4643', '#89A54E', '#80699B', '#3D96AE', '#DB843D', '#92A8CD', '#A47D7C', '#B5CA92']
Example: -
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
data: UndefOr[CleanJsObject[Data]]
The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views.
The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views. See also the tutorial article on the Data module.
It requires the
modules/data.js
file to be loaded.Please note that the default way of adding data in Highcharts, without the need of a module, is through the series.data option.
Data from a HTML table, CSV.
- Since
4.0
Example: -
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.- Since
3.0.8
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 a symbol and name for each series item or point item in the chart.
The legend is a box containing a symbol and name for each series item or point item in the chart. Each series (or points in case of pie charts) is represented by a symbol and its name in the legend.
It is also possible to override the symbol creator function and create custom legend symbols.
-
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. -
val
navigation: UndefOr[CleanJsObject[Navigation]]
A collection of options for buttons and menus appearing in the exporting module.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
val
noData: UndefOr[CleanJsObject[NoData]]
Options for displaying a message like "No data to display".
Options for displaying a message like "No data to display". This feature requires the file
no-data-to-display.js
to be loaded in the page. The actual text to display is set in the lang.noData option.- Since
3.0.8
Example: -
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
pane: UndefOr[CleanJsObject[Pane]]
Applies only to polar charts and angular gauges.
Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index.
- Since
2.3.0
-
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[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[|[SeriesArea, SeriesArearange], SeriesAreaspline], SeriesAreasplinerange], SeriesBar], SeriesBoxplot], SeriesBubble], SeriesColumn], SeriesColumnrange], SeriesErrorbar], SeriesFunnel], SeriesGauge], SeriesHeatmap], SeriesLine], SeriesPie], SeriesPolygon], SeriesPyramid], SeriesScatter], SeriesSolidgauge], SeriesSpline], SeriesTreemap], SeriesWaterfall]]]]
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. For example, even though a generallineWidth
is specified inplotOptions.series
, an individuallineWidth
can be specified for each series. -
val
subtitle: UndefOr[CleanJsObject[Subtitle]]
The chart's subtitle
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
title: UndefOr[CleanJsObject[Title]]
The chart's main title.
-
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[Array[CleanJsObject[XAxis]]]
The X axis or category axis.
The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.
See the Axis object for programmatic access to the axis.
-
val
yAxis: UndefOr[Array[CleanJsObject[YAxis]]]
The Y axis or value axis.
The Y axis or value axis. Normally this is the vertical axis, though if the chart is inverted this is the horizontal axis. In case of multiple axes, the yAxis node is an array of configuration objects.
See the Axis object for programmatic access to the axis.
-
val
zAxis: UndefOr[CleanJsObject[ZAxis]]
The Z axis or depth axis for 3D plots.
The Z axis or depth axis for 3D plots.
See the Axis object for programmatic access to the axis.
- Since
5.0.0
Example: