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
def addAxis(options: UndefOr[Object] = js.undefined, isX: UndefOr[Boolean] = js.undefined, redraw: UndefOr[Boolean] = js.undefined, animation: UndefOr[Any] = js.undefined): Unit

Add an axis to the chart after render time.
Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initiated, add the axis as a configuration option instead.
options
The Axis options, as documented under xAxis and yAxis.
Example:
1. Add and remove axes
Since
3.0
def addSeries(options: UndefOr[Object] = js.undefined, redraw: UndefOr[Boolean] = js.undefined, animation: UndefOr[Any] = js.undefined): Series

Add a series to the chart after render time.
Add a series to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initiated, add the series as a configuration option instead.
options
The series options, as documented under plotOptions.series and under the plotOptions for each series type.
Example:
1. Add a series from a button
Since
1.2.0
def addSeriesAsDrilldown(point: UndefOr[Object] = js.undefined, seriesOptions: UndefOr[Object] = js.undefined): Unit

Add a series to the chart as drilldown from a specific point in the parent series.
Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution series. When not async, the setup is simpler using the drilldown.series options structure.
point
The existing Point object from which the drilldown will start.
Example:
1. Async drilldown
Since
3.0.8
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

A reference to the containing HTML element, dynamically inserted into the element given in chart.renderTo.
A reference to the containing HTML element, dynamically inserted into the element given in chart.renderTo.

Since
1.2.5
def destroy(): Unit

Removes the chart and purges memory.
Removes the chart and purges memory. This method should be called before writing a new chart into the same container. It is called internally on window unload to prevent leaks.
Example:
1. Destroy the chart from a button
Since
1.2.2
def drillUp(): Unit

When the chart is drilled down to a child series, calling chart.drillUp() will drill up to the parent series.
When the chart is drilled down to a child series, calling chart.drillUp() will drill up to the parent series.

Since
3.0.8
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def exportChart(options: UndefOr[Object] = js.undefined, chartOptions: UndefOr[Object] = js.undefined): Unit

Exporting module required.
Exporting module required. Submit an SVG version of the chart to a server along with some parameters for conversion.
options
Exporting options. Out of the exporting options, the following options can be given as parameters to the exportChart method. All options default to the values given in the exporting config options. filename: the filename for the export without extension, url: the URL for the server module to do the conversion, width: the width of the PNG or JPEG image generated on the server, type: the MIME type of the converted image, sourceWidth: the width of the source (in-page) chart, sourceHeight: the height of the source chart.
Example:
1. Export with no options,PDF type and custom filename, different chart background in export
Since
2.0
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(id: UndefOr[String] = js.undefined): Any

Get an axis, series or point by its id as given in the configuration options.
Get an axis, series or point by its id as given in the configuration options.
id
The id of the axis, series or point to get.
Example:
1. Get series by id
Since
1.2.0
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getSVG(additionalOptions: UndefOr[Object] = js.undefined): String

Exporting module required.
Exporting module required. Get an SVG string representing the chart.
additionalOptions
Chart options to add to the exported chart in addition to the options given for the original chart. For example if series.lineWidth should be greater in the exported chart than in the original, or the chart should have a different background color, this is added here.
Example:
1. View the SVG from a button
Since
2.0
def getSelectedPoints(): Array[Point]

Returns an array of all currently selected points in the chart.
Returns an array of all currently selected points in the chart. Points can be selected either programmatically by the point.select() method or by clicking.
Example:
1. Get selected points
Since
1.2.0
def getSelectedSeries(): Array[Series]

Returns an array of all currently selected series in the chart.
Returns an array of all currently selected series in the chart. Series can be selected either programmatically by the series.select() method or by checking the checkbox next to the legend item if series.showCheckBox is true.
Example:
1. Get selected series
Since
1.2.0
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
def hideLoading(): Unit

Hide the loading screen.
Hide the loading screen. Options for the loading screen are defined at options.loading.
Example:
1. Show and hide loading from a button
Since
1.2.0
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val options: UndefOr[Object]

The options structure for the chart.
The options structure for the chart.

Since
1.2.0
def print(): Unit

Exporting module required.
Exporting module required. Clears away other elements in the page and prints the chart as it is displayed. By default, when the exporting module is enabled, a button at the upper left calls this method.
Example:
1. Print from a HTML button
Since
2.0
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def redraw(animation: UndefOr[Any] = js.undefined): Unit

Redraw the chart after changes have been done to the data or axis extremes.
Redraw the chart after changes have been done to the data or axis extremes. All methods for updating axes, series or points have a parameter for redrawing the chart. This is true by default. But in many cases you want to do more than one operation on the chart before redrawing, for example add a number of points. In those cases it is a waste of resources to redraw the chart for each new point added. So you add the points and call chart.redraw() after.
animation
Defaults to true. When true, the update will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.

Since
1.2.0
def reflow(): Unit

Reflows the chart to its container.
Reflows the chart to its container. By default, the chart reflows automatically to its container following a window.resize event, as per the chart.reflow option. However, there are no reliable events for div resize, so if the container is resized without a window resize event, this must be called explicitly.
Example:
1. Resize div and reflow, pop up and reflow
val series: UndefOr[Array[Series]]

An array of all the chart's series.
An array of all the chart's series.

Since
1.2.0
def setSize(width: UndefOr[Double] = js.undefined, height: UndefOr[Double] = js.undefined, animation: UndefOr[Any] = js.undefined): Unit

Resize the chart to a given width and height.
Resize the chart to a given width and height.
width
The new pixel width of the chart.
height
The new pixel height of the chart.
animation
Defaults to true. When true, the resize will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
Example:
1. Test resizing from buttons, add a jQuery UI resizable
def setTitle(title: UndefOr[Object] = js.undefined, subtitle: UndefOr[Any] = js.undefined, redraw: UndefOr[Boolean] = js.undefined): Unit

Set a new title or subtitle for the chart
Set a new title or subtitle for the chart
title
A configuration object for the new title as defined at #title.
Example:
1. Set title text and styles
Since
2.1.0
def showLoading(str: UndefOr[String] = js.undefined): Unit

Dim the chart's plot area and show a loading label text.
Dim the chart's plot area and show a loading label text. Options for the loading screen are defined at options.loading. A custom text can be given as a parameter for loading.
Example:
1. Show and hide loading from a button,apply different text labels.
Since
2.0.5
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
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[Axis]]

An array of the chart's x axes.
An array of the chart's x axes. If only one x axis, it is referenced by chart.xAxis[0].

Since
1.2.0
val yAxis: UndefOr[Array[Axis]]

An array of the chart's y axes.
An array of the chart's y axes. If only one y axis, it is referenced by chart.yAxis[0].

Since
1.2.0

Deprecated Value Members

def updatePosition(): Unit

This method is deprecated as of 2.0.1.
This method is deprecated as of 2.0.1. Updating the chart position after a move operation is no longer necessary.

Annotations
@deprecated
Deprecated
Since
1.2.5

Related Doc: package api

trait Chart extends Object

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAxis(options: UndefOr[Object] = js.undefined, isX: UndefOr[Boolean] = js.undefined, redraw: UndefOr[Boolean] = js.undefined, animation: UndefOr[Any] = js.undefined): Unit

def addSeries(options: UndefOr[Object] = js.undefined, redraw: UndefOr[Boolean] = js.undefined, animation: UndefOr[Any] = js.undefined): Series

def addSeriesAsDrilldown(point: UndefOr[Object] = js.undefined, seriesOptions: UndefOr[Object] = js.undefined): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val container: UndefOr[Object]

def destroy(): Unit

def drillUp(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exportChart(options: UndefOr[Object] = js.undefined, chartOptions: UndefOr[Object] = js.undefined): Unit

def finalize(): Unit

def get(id: UndefOr[String] = js.undefined): Any

final def getClass(): Class[_]

def getSVG(additionalOptions: UndefOr[Object] = js.undefined): String

def getSelectedPoints(): Array[Point]

def getSelectedSeries(): Array[Series]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

def hideLoading(): Unit

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: UndefOr[Object]

def print(): Unit

def propertyIsEnumerable(v: String): Boolean

def redraw(animation: UndefOr[Any] = js.undefined): Unit

def reflow(): Unit

val series: UndefOr[Array[Series]]

def setSize(width: UndefOr[Double] = js.undefined, height: UndefOr[Double] = js.undefined, animation: UndefOr[Any] = js.undefined): Unit

def setTitle(title: UndefOr[Object] = js.undefined, subtitle: UndefOr[Any] = js.undefined, redraw: UndefOr[Boolean] = js.undefined): Unit

def showLoading(str: UndefOr[String] = js.undefined): Unit

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

def toLocaleString(): String

def toString(): String

def valueOf(): Any

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val xAxis: UndefOr[Array[Axis]]

val yAxis: UndefOr[Array[Axis]]

Deprecated Value Members

def updatePosition(): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped