org.pepstock.charba.client.callbacks

Class ScriptableContext

java.lang.Object

org.pepstock.charba.client.commons.NativeExtendedObject

org.pepstock.charba.client.callbacks.ScriptableContext

@JsType(isNative=true,
        name="Object",
        namespace="<global>")
public final class ScriptableContext
extends NativeExtendedObject

The option context is used to give contextual information when resolving options.
The context object contains the following properties:

• index(int): index of the associated data
• datasetIndex(int): index of the associated dataset
• active(boolean): if the data and dataset item is hovered. It also maps the hover property of CHART.js context.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptableContext() To avoid any instantiation

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the CHARBA chart instance.
int	getDatasetIndex() Returns the dataset index of the data inside the dataset.
int	getIndex() Returns the index of the data inside the dataset.
boolean	isActive() Returns whether the associated element is hovered.

Methods inherited from class org.pepstock.charba.client.commons.NativeExtendedObject

getNativeOptions, getOptions, hasOptions, setNativeOptions, setOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptableContext

protected ScriptableContext()

To avoid any instantiation

Method Detail

getIndex

@JsOverlay
public int getIndex()

Returns the index of the data inside the dataset.

Returns:

the index of the data inside the dataset. Default is UndefinedValues.INTEGER.

getDatasetIndex

@JsOverlay
public int getDatasetIndex()

Returns the dataset index of the data inside the dataset.

Returns:

the dataset index of the data inside the dataset. Default is UndefinedValues.INTEGER.

getChart

@JsOverlay
public IsChart getChart()

Returns the CHARBA chart instance.

Returns:

the CHARBA chart instance

isActive

@JsOverlay
public boolean isActive()

Returns whether the associated element is hovered.

Returns:

whether the associated element is hovered. Default is false.