class Chart extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
chart
- Alphabetic
- By Inheritance
- Chart
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Chart()
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
animation: UndefOr[|[Boolean, Object]]
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>- The duration of the animation in milliseconds.
<dt>easing</dt>
- A string reference to an easing function set on the
</dl>Math
object. See the easing demo.Example: -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
backgroundColor: UndefOr[|[String, Object]]
The background color or gradient for the outer chart area.
-
val
borderColor: UndefOr[|[String, Object]]
The color of the outer chart border.
The color of the outer chart border.
Example: -
val
borderRadius: UndefOr[Double]
The corner radius of the outer chart border.
The corner radius of the outer chart border.
Example: -
val
borderWidth: UndefOr[Double]
The pixel width of the outer chart border.
The pixel width of the outer chart border.
Example: -
val
className: UndefOr[String]
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. -
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
colorCount: UndefOr[Double]
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.- Since
5.0.0
-
val
description: UndefOr[String]
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.
- Since
5.0.0
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
events: UndefOr[CleanJsObject[ChartEvents]]
Event listeners for the chart.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
val
height: UndefOr[Double]
An explicit height for the chart.
An explicit height for the chart. 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.Example: -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
map: UndefOr[|[|[String, Object], Array[Object]]]
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.
- Since
5.0.0
Example: -
val
mapTransforms: UndefOr[Object]
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.
- Since
5.0.0
-
val
margin: UndefOr[Array[Any]]
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
andmarginLeft
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
andspacingLeft
options. Defaults to[null]
. -
val
marginBottom: UndefOr[Double]
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
.Example: -
val
marginLeft: UndefOr[Double]
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
.Example: -
val
marginRight: UndefOr[Double]
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
.Example: -
val
marginTop: UndefOr[Double]
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
.Example: -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
plotBackgroundColor: UndefOr[|[String, Object]]
The background color or gradient for the plot area.
-
val
plotBackgroundImage: UndefOr[String]
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.
-
val
plotBorderColor: UndefOr[|[String, Object]]
The color of the inner chart or plot area border.
The color of the inner chart or plot area border.
Example: -
val
plotBorderWidth: UndefOr[Double]
The pixel width of the plot area border.
The pixel width of the plot area border.
Example: -
val
plotShadow: UndefOr[|[Boolean, Object]]
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. Since 2.3 the shadow can be an object configuration containing
color
,offsetX
,offsetY
,opacity
andwidth
.Example: -
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
reflow: UndefOr[Boolean]
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.
Example: -
val
renderTo: UndefOr[|[String, Object]]
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.
When using the Highcharts.mapChart constructor, the
renderTo
is given as a parameter, and can be skipped in the options set. -
val
resetZoomButton: UndefOr[CleanJsObject[ChartResetZoomButton]]
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.
-
val
selectionMarkerFill: UndefOr[|[String, Object]]
The background color of the marker square when selecting (zooming in on) an area of the chart.
-
val
shadow: UndefOr[|[Boolean, Object]]
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. Since 2.3 the shadow can be an object configuration containing
color
,offsetX
,offsetY
,opacity
andwidth
.Example: -
val
spacing: UndefOr[Array[Double]]
The distance between the outer edge of the chart and the content, like title and legend.
The distance between the outer edge of the chart and the content, like title and legend. 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.
-
val
spacingBottom: UndefOr[Double]
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).
Example: -
val
spacingLeft: UndefOr[Double]
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).
Example: -
val
spacingRight: UndefOr[Double]
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).
Example: -
val
spacingTop: UndefOr[Double]
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).
Example: -
val
style: UndefOr[Object]
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.Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
type: UndefOr[String]
The default series type for the chart.
The default series type for the chart. Can be any of the chart types listed under plotOptions.
Example: -
val
typeDescription: UndefOr[String]
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.
- Since
5.0.0
Example: -
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
width: UndefOr[Double]
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.Example: