org.pepstock.charba.client.callbacks

Class ScriptableContext

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.callbacks.ScriptableContext

public final class ScriptableContext
extends NativeObjectContainer

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

Constructor and Description
ScriptableContext(NativeObject nativeObject) Creates the object with native object instance to be wrapped.

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.
<T extends NativeObjectContainer> T	getOptions(NativeObjectContainerFactory<T> factory) Returns the options, if exist.
boolean	hasOptions() Checks if there is any options.
boolean	isActive() Returns whether the associated element is hovered.
<T extends NativeObjectContainer> void	setOptions(T options) Sets the additional options.

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

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableContext

public ScriptableContext(NativeObject nativeObject)

Creates the object with native object instance to be wrapped.

Parameters:

nativeObject - native object instance to be wrapped.

Method Detail

getIndex

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

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

public IsChart getChart()

Returns the CHARBA chart instance.

Returns:

the CHARBA chart instance

isActive

public boolean isActive()

Returns whether the associated element is hovered.

Returns:

whether the associated element is hovered. Default is false.

setOptions

public <T extends NativeObjectContainer> void setOptions(T options)

Sets the additional options.

Type Parameters:

T - type of native object container to store

Parameters:

options - additional options instance.

hasOptions

public boolean hasOptions()

Checks if there is any options.

Returns:

true if there is an options, otherwise false.

getOptions

public <T extends NativeObjectContainer> T getOptions(NativeObjectContainerFactory<T> factory)

Returns the options, if exist. It uses a factory instance to create a native object container.

Type Parameters:

T - type of native object container to return

Parameters:

factory - factory instance to create a native object container.

Returns:

java script object used to map the options or an empty object if not exist.