Chart

Abstract Value Members

abstract def legend: Legend

Concrete 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 addCredits(options: Credits): Unit

Set a new credits label for the chart.
def addSeriesAsDrilldown(point: Point, seriesOptions: config.series.Series): 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val container: org.scalajs.dom.Element

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.
val credits: Credits

The chart's credits label.
The chart's credits label. The label has an update method that allows setting new options.
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
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.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def exportChart(options: Exporting, chartOptions: config.chart.Chart): 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.
chartOptions
Additional chart options for the exported chart. For example a different background color can be added here.
Example:
1. Export with no options, PDF type and custom filename, different chart background in export
def exportChartLocal(options: Exporting, chartOptions: config.chart.Chart): Unit

Export the chart to a PNG or SVG without sending it to a server.
Export the chart to a PNG or SVG without sending it to a server. Requires modules/exporting.js and modules/offline-exporting.js.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(id: String): |[|[Axis[_, _], Series], Point]

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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getSVG(additionalOptions: HighchartsConfig): 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
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
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: HighchartsConfig

The options structure for the chart.
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
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
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
def setTitle(title: config.title.Title, subtitle: config.title.Subtitle, redraw: Boolean = js.native): 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
def showLoading(text: String = js.native): 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.
def subtitle: Subtitle

The chart subtitle.
The chart subtitle. The subtitle has an update method that allows modifying the options.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def title: Title

The chart title.
The chart title. The title has an update method that allows modifying the options.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def update(options: HighchartsConfig, redraw: Boolean = js.native): Unit

A generic function to update any element of the chart.
A generic function to update any element of the chart. Elements can be enabled and disabled, moved, re-styled, re-formatted etc.
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( ... )

Deprecated Value Members

def updatePosition(): Unit

Annotations
@deprecated
Deprecated
(Since version 0.5.0) Updating the chart position after a move operation is no longer necessary.

Related Docs: object Chart | package api

trait Chart extends Object

Abstract Value Members

abstract def legend: Legend

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addCredits(options: Credits): Unit

def addSeriesAsDrilldown(point: Point, seriesOptions: config.series.Series): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val container: org.scalajs.dom.Element

val credits: Credits

def destroy(): Unit

def drillUp(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exportChart(options: Exporting, chartOptions: config.chart.Chart): Unit

def exportChartLocal(options: Exporting, chartOptions: config.chart.Chart): Unit

def finalize(): Unit

def get(id: String): |[|[Axis[_, _], Series], Point]

final def getClass(): Class[_]

def getSVG(additionalOptions: HighchartsConfig): String

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: HighchartsConfig

def print(): Unit

def propertyIsEnumerable(v: String): Boolean

def reflow(): Unit

def setTitle(title: config.title.Title, subtitle: config.title.Subtitle, redraw: Boolean = js.native): Unit

def showLoading(text: String = js.native): Unit

def subtitle: Subtitle

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

def title: Title

def toLocaleString(): String

def toString(): String

def update(options: HighchartsConfig, redraw: Boolean = js.native): Unit

def valueOf(): Any

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def updatePosition(): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped