org.pepstock.charba.client.items

Class DatasetMetaItem

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.items.DatasetMetaItem

public final class DatasetMetaItem
extends JavaScriptObjectContainer

This object is just a proxy object, created from JavaScript side, to wrap an JavaScript array.
Created and passed by CHART.JS.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DatasetMetaItem(GenericJavaScriptObject javaScriptObject) Wraps the CHART.JS java script object.

Method Summary

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetMetaItem

public DatasetMetaItem(GenericJavaScriptObject javaScriptObject)

Wraps the CHART.JS java script object.

Parameters:

javaScriptObject - CHART.JS java script object

Method Detail

getType

public Type getType()

Returns the type of dataset. If not set, the default is bar.

Returns:

the type of dataset

See Also:

Type

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 java.lang.String getYAxisID()

Returns the Y axis ID.

Returns:

the Y axis ID. Default is UndefinedValues.STRING.

getXAxisID

public java.lang.String getXAxisID()

Returns the X axis ID.

Returns:

the X axis ID. Default is UndefinedValues.STRING.

getDatasets

public java.util.List<DatasetItem> getDatasets()

Returns a list of dataset metadata items.

Returns:

a list of dataset metadata items.

See Also:

DatasetItem