org.pepstock.charba.client.items

Class DatasetItem

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.items.DatasetItem

Direct Known Subclasses:

StyleElement

public class DatasetItem
extends NativeObjectContainer

Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position.
The elements are mapped by this object.
This is the CHART.JS item with all needed info about a selected dataset. This object has been created and passed to event handler or callbacks to apply own logic.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatasetItem.DatasetItemFactory Inner class to create dataset item by a native object.

Constructor Summary

Constructors

Constructor and Description
DatasetItem(NativeObject nativeObject) Creates the item using a native java script object which contains all properties.

Method Summary

Modifier and Type	Method and Description
int	getDatasetIndex() Returns the dataset index of the chart
int	getIndex() Returns the index of the data inside the dataset.
DatasetViewItem	getView() Returns all view information about the dataset.
boolean	isHidden() Returns if the dataset is hidden.
void	setHidden(boolean hidden) Sets if the dataset must be hidden.

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

checkValue, empty, getArrayValue, 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, 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

DatasetItem

public DatasetItem(NativeObject nativeObject)

Creates the item using a native java script object which contains all properties.

Parameters:

nativeObject - native java script object which contains all properties.

Method Detail

getDatasetIndex

public final int getDatasetIndex()

Returns the dataset index of the chart

Returns:

the dataset index of the chart. Default is UndefinedValues.INTEGER.

getIndex

public final int getIndex()

Returns the index of the data inside the dataset.

Returns:

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

isHidden

public final boolean isHidden()

Returns if the dataset is hidden.

Returns:

true if the dataset is hidden, otherwise false. Default is UndefinedValues.BOOLEAN.

setHidden

public final void setHidden(boolean hidden)

Sets if the dataset must be hidden.

Parameters:

hidden - true if the dataset must be hidden, otherwise false.

getView

public final DatasetViewItem getView()

Returns all view information about the dataset.

Returns:

all view information about the dataset.