org.pepstock.charba.client.data

Class Dataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

Direct Known Subclasses:

BarDataset, BubbleDataset, LineDataset, PieDataset, PolarAreaDataset, RadarDataset

public abstract class Dataset
extends NativeObjectContainer

The chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
This is the base implementation for all datasets with common fields.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
List<Double>	getData() Returns the data property of a dataset for a chart is specified as an array of numbers.
List<Double>	getData(boolean binding) Returns the data property of a dataset for a chart is specified as an array of numbers.
DataType	getDataType() Returns the data type of datasets.
int	getId() Returns the unique id of datasets.
String	getLabel() Returns the label for the dataset which appears in the legend and tooltips.
<T extends NativeObjectContainer> T	getOptions(String pluginId, NativeObjectContainerFactory<T> factory) Returns the plugin dataset configuration, if exist.
Type	getType() Returns the type of dataset, based on type of chart.
boolean	hasOptions(String pluginId) Checks if there is any dataset configuration for a specific plugin, by its id.
boolean	isHidden() Returns if the dataset will appear or not.
void	setData(double... values) Sets the data property of a dataset for a chart is specified as an array of numbers.
void	setData(List<Double> values) Sets the data property of a dataset for a chart is specified as an array of numbers.
void	setHidden(boolean hidden) Sets if the dataset will appear or not.
void	setLabel(String label) Sets the label for the dataset which appears in the legend and tooltips.
<T extends NativeObjectContainer> void	setOptions(String pluginId, T options) Sets the plugin dataset configuration.
void	setType(Type type) Sets the type of dataset based on type of chart.

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

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

Method Detail

getId

public final int getId()

Returns the unique id of datasets.

Returns:

the unique id of datasets

getDataType

public final DataType getDataType()

Returns the data type of datasets.

Returns:

the data type of datasets

setHidden

public void setHidden(boolean hidden)

Sets if the dataset will appear or not.

Parameters:

hidden - if the dataset will appear or not.

isHidden

public boolean isHidden()

Returns if the dataset will appear or not.

Returns:

if the dataset will appear or not. Default is false

setLabel

public void setLabel(String label)

Sets the label for the dataset which appears in the legend and tooltips.

Parameters:

label - the label for the dataset which appears in the legend and tooltips.

getLabel

public String getLabel()

Returns the label for the dataset which appears in the legend and tooltips.

Returns:

the label for the dataset which appears in the legend and tooltips.

setData

public void setData(double... values)

Sets the data property of a dataset for a chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

values - an array of numbers

setData

public void setData(List<Double> values)

Sets the data property of a dataset for a chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

values - list of numbers.

getData

public List<Double> getData()

Returns the data property of a dataset for a chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index on the x axis.

Returns:

list of numbers or an empty list of numbers if the data type is not DataType.numbers.

getData

public List<Double> getData(boolean binding)

Returns the data property of a dataset for a chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

binding - if true binds the new array list into container

Returns:

list of numbers or an empty list of numbers if the data type is not DataType.numbers.

setType

public final void setType(Type type)

Sets the type of dataset based on type of chart.

Parameters:

type - type of dataset.

getType

public final Type getType()

Returns the type of dataset, based on type of chart.

Returns:

type of dataset or null if not set. If not set or invalid, the default is ChartType.bar.

setOptions

public final <T extends NativeObjectContainer> void setOptions(String pluginId,
                                                               T options)

Sets the plugin dataset configuration. If dataset configuration options is null, the configuration of plugin will be removed.

Type Parameters:

T - type of native object container to store

Parameters:

pluginId - plugin id.

options - java script object used to configure the plugin. Pass null to remove the configuration if exist.

hasOptions

public final boolean hasOptions(String pluginId)

Checks if there is any dataset configuration for a specific plugin, by its id.

Parameters:

pluginId - plugin id.

Returns:

true if there is an options, otherwise false.

getOptions

public final <T extends NativeObjectContainer> T getOptions(String pluginId,
                                                            NativeObjectContainerFactory<T> factory)

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

Type Parameters:

T - type of native object container to return

Parameters:

pluginId - plugin id.

factory - factory instance to create a native object container.

Returns:

java script object used to configure the plugin or null if not exist.