org.pepstock.charba.client.items

Class DatasetMetaItem

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.items.DatasetMetaItem

public final class DatasetMetaItem
extends NativeObjectContainer

Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position.
Created and passed by CHART.JS and provide dataset metadata information.
Contains all data set items.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<DatasetItem>	getDatasets() Returns a list of dataset metadata items.
Type	getType() Returns the type of dataset.
String	getXAxisID() Returns the X axis ID.
String	getYAxisID() Returns the Y axis ID.
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

DatasetMetaItem

public DatasetMetaItem(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

getType

public Type getType()

Returns the type of dataset.

Returns:

the type of dataset. If not set or invalid, the default is ChartType.BAR.

isHidden

public boolean isHidden()

Returns if the dataset is hidden.

Returns:

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

setHidden

public void setHidden(boolean hidden)

Sets if the dataset must be hidden.

Parameters:

hidden - true if the dataset must be hidden, otherwise is UndefinedValues.BOOLEAN.

getYAxisID

public String getYAxisID()

Returns the Y axis ID.

Returns:

the Y axis ID. Default is Scales.DEFAULT_Y_AXIS_ID.

getXAxisID

public String getXAxisID()

Returns the X axis ID.

Returns:

the X axis ID. Default is Scales.DEFAULT_X_AXIS_ID.

getDatasets

public List<DatasetItem> getDatasets()

Returns a list of dataset metadata items.

Returns:

a list of dataset metadata items.