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 alignTicks: UndefOr[Boolean]

When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified.
When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified.
This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0.
Annotations
@JSOptional()
Example:
1. True by default, false.
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 Math object. See the easing demo.
</dl>
Annotations
@JSOptional()
Example:
1. Updating with no animation, with a longer duration, with a jQuery UI easing.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val backgroundColor: UndefOr[|[String, Object]]

The background color or gradient for the outer chart area.
The background color or gradient for the outer chart area.
Annotations
@JSOptional()
Example:
1. Color, gradient
val borderColor: UndefOr[|[String, Object]]

The color of the outer chart border.
The color of the outer chart border.
Annotations
@JSOptional()
Example:
1. Brown border
val borderRadius: UndefOr[Double]

The corner radius of the outer chart border.
The corner radius of the outer chart border.
Annotations
@JSOptional()
Example:
1. 20px radius
val borderWidth: UndefOr[Double]

The pixel width of the outer chart border.
The pixel width of the outer chart border.
Annotations
@JSOptional()
Example:
1. 5px border
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.

Annotations
@JSOptional()
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val colorCount: UndefOr[Int]

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.

Annotations
@JSOptional()
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.

Annotations
@JSOptional()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: UndefOr[ChartEvents]

Event listeners for the chart.
Event listeners for the chart.

Annotations
@JSOptional()
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.
Annotations
@JSOptional()
Example:
1. 500px height
val ignoreHiddenSeries: UndefOr[Boolean]

If true, the axes will scale to the remaining visible series once one series is hidden.
If true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected.
Annotations
@JSOptional()
Example:
1. True by default false, true with stack
val inverted: UndefOr[Boolean]

Whether to invert the axes so that the x axis is vertical and y axis is horizontal.
Whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is reversed by default. If a bar series is present in the chart, it will be inverted automatically.
Inverting the chart doesn't have an effect if there are no cartesian series in the chart, or if the chart is polar.
Annotations
@JSOptional()
Example:
1. Inverted line
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val margin: UndefOr[Array[Double]]

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.
Since version 2.1, the margin is 0 by default. 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].
Annotations
@JSOptional()
Example:
1. Zero margins
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.
Annotations
@JSOptional()
Example:
1. 100px bottom margin
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.
Annotations
@JSOptional()
Example:
1. 150px left margin
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.
Annotations
@JSOptional()
Example:
1. 100px right margin
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.
Annotations
@JSOptional()
Example:
1. 100px top margin
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val options3d: UndefOr[ChartOptions3d]

Options to render charts in 3 dimensions.
Options to render charts in 3 dimensions. This feature requires highcharts-3d.js, found in the download package or online at code.highcharts.com/highcharts-3d.js.
Annotations
@JSOptional()
Example:
1. Basic 3D columns, basic 3D pie, basic 3D scatter chart.
val panKey: UndefOr[String]

Allows setting a key to switch between zooming and panning.
Allows setting a key to switch between zooming and panning.
Annotations
@JSOptional()
Example:
1. Hold down shift to pan
val panning: UndefOr[Boolean]

Allow panning in a chart.
Allow panning in a chart. Best used with panKey to combine zooming and panning.
Annotations
@JSOptional()
Example:
1. Zooming and panning
val pinchType: UndefOr[String]

Equivalent to zoomType, but for multitouch gestures only.
Equivalent to zoomType, but for multitouch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled.

Annotations
@JSOptional()
val plotBackgroundColor: UndefOr[|[String, Object]]

The background color or gradient for the plot area.
The background color or gradient for the plot area.
Annotations
@JSOptional()
Example:
1. Color, gradient
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.
Annotations
@JSOptional()
Example:
1. Skies
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.
Annotations
@JSOptional()
Example:
1. Blue border
val plotBorderWidth: UndefOr[Double]

The pixel width of the plot area border.
The pixel width of the plot area border.
Annotations
@JSOptional()
Example:
1. 1px border
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 and width.
Annotations
@JSOptional()
Example:
1. Plot shadow
val polar: UndefOr[Boolean]

When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system. Requires highcharts-more.js.
Annotations
@JSOptional()
Example:
1. Polar line, polar area, polar column, combined series types, spider chart, wind rose.
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.
Annotations
@JSOptional()
Example:
1. Move the bar between the JavaScript frame and the Preview frame to see the effect: True by default, false.
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.
Annotations
@JSOptional()
Example:
1. String, object reference, object reference through jQuery,
val resetZoomButton: UndefOr[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.

Annotations
@JSOptional()
val selectionMarkerFill: UndefOr[|[String, Object]]

The background color of the marker square when selecting (zooming in on) an area of the chart.
The background color of the marker square when selecting (zooming in on) an area of the chart.

Annotations
@JSOptional()
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 and width.
Annotations
@JSOptional()
Example:
1. Shadow
val showAxes: UndefOr[Boolean]

Whether to show the axes initially.
Whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to cartesian series.
Annotations
@JSOptional()
Example:
1. False by default, true
val spacing: UndefOr[Array[Double]]

The distance between the outer edge of the chart and the content, like title, legend, axis title or labels.
The distance between the outer edge of the chart and the content, like title, legend, axis title or labels. 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.

Annotations
@JSOptional()
val spacingBottom: UndefOr[Double]

The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
Annotations
@JSOptional()
Example:
1. Spacing bottom set to 100.
val spacingLeft: UndefOr[Double]

The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
Annotations
@JSOptional()
Example:
1. Spacing left set to 100
val spacingRight: UndefOr[Double]

The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
Annotations
@JSOptional()
Example:
1. Spacing set to 100, legend in right position with default spacing
val spacingTop: UndefOr[Double]

The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
Annotations
@JSOptional()
Example:
1. A top spacing of 100, floating chart title makes the plot area align to the default spacingTop of 10..
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. Defaults to:
```
style: {
fontFamily: '"Lucida Grande", "Lucida Sans Unicode", Verdana, Arial, Helvetica, sans-serif', // default font
fontSize: '12px'
}
```
Annotations
@JSOptional()
Example:
1. Using a serif type font
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.
Annotations
@JSOptional()
Example:
1. Bar
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.

Annotations
@JSOptional()
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.
Annotations
@JSOptional()
Example:
1. 800px wide
val zoomType: UndefOr[String]

Decides in what dimensions the user can zoom by dragging the mouse.
Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy.
Annotations
@JSOptional()
Example:
1. None by default, x, y, xy

Deprecated Value Members

val defaultSeriesType: UndefOr[String]

Alias of type.
Alias of type.
Annotations
@JSOptional() @deprecated
Deprecated
(Since version 0.5.0) Alias of type.
Example:
1. Bar

Related Docs: object Chart | package chart

trait Chart extends Object

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val alignTicks: UndefOr[Boolean]

val animation: UndefOr[|[Boolean, Object]]

final def asInstanceOf[T0]: T0

val backgroundColor: UndefOr[|[String, Object]]

val borderColor: UndefOr[|[String, Object]]

val borderRadius: UndefOr[Double]

val borderWidth: UndefOr[Double]

val className: UndefOr[String]

def clone(): AnyRef

val colorCount: UndefOr[Int]

val description: UndefOr[String]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[ChartEvents]

def finalize(): Unit

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val height: UndefOr[Double]

val ignoreHiddenSeries: UndefOr[Boolean]

val inverted: UndefOr[Boolean]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val margin: UndefOr[Array[Double]]

val marginBottom: UndefOr[Double]

val marginLeft: UndefOr[Double]

val marginRight: UndefOr[Double]

val marginTop: UndefOr[Double]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options3d: UndefOr[ChartOptions3d]

val panKey: UndefOr[String]

val panning: UndefOr[Boolean]

val pinchType: UndefOr[String]

val plotBackgroundColor: UndefOr[|[String, Object]]

val plotBackgroundImage: UndefOr[String]

val plotBorderColor: UndefOr[|[String, Object]]

val plotBorderWidth: UndefOr[Double]

val plotShadow: UndefOr[|[Boolean, Object]]

val polar: UndefOr[Boolean]

def propertyIsEnumerable(v: String): Boolean

val reflow: UndefOr[Boolean]

val renderTo: UndefOr[|[String, Object]]

val resetZoomButton: UndefOr[ChartResetZoomButton]

val selectionMarkerFill: UndefOr[|[String, Object]]

val shadow: UndefOr[|[Boolean, Object]]

val showAxes: UndefOr[Boolean]

val spacing: UndefOr[Array[Double]]

val spacingBottom: UndefOr[Double]

val spacingLeft: UndefOr[Double]

val spacingRight: UndefOr[Double]

val spacingTop: UndefOr[Double]

val style: UndefOr[Object]

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

val type: UndefOr[String]

val typeDescription: UndefOr[String]

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val width: UndefOr[Double]

val zoomType: UndefOr[String]

Deprecated Value Members

val defaultSeriesType: UndefOr[String]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped