org.pepstock.charba.client.data

Class Dataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

All Implemented Interfaces:

HasDataset

Direct Known Subclasses:

HovingFlexDataset, LiningDataset, MeterDataset

public abstract class Dataset
extends NativeObjectContainer
implements HasDataset

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Dataset.Property Name of common properties of native object related to a dataset.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dataset(Type type, IsDefaultOptions defaultValues) Creates the dataset using a default and chart type related to the dataset, adding patterns and gradients element.

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyGradient(Key key, List<CanvasGradientItem> canvasGradientsList) Stores the canvas gradients into dataset object by property name passed as key.
protected abstract void	applyPattern(Key key, List<CanvasPatternItem> canvasPatternsList) Stores the canvas patterns into dataset object by property name passed as key.
BackgroundColorCallback	getBackgroundColorCallback() Returns the background color callback, if set, otherwise null.
BorderColorCallback	getBorderColorCallback() Returns the border color callback, if set, otherwise null.
BorderWidthCallback	getBorderWidthCallback() Returns the border width callback, if set, otherwise null.
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.
Dataset	getDataset() Gets the dataset instance.
DataType	getDataType() Returns the data type of datasets.
protected String	getDefaultBackgroundColorAsString() Returns the default background color value based on type of chart.
protected String	getDefaultBorderColorAsString() Returns the default border color value based on type of chart.
protected int	getDefaultBorderWidth() Returns the default border width value based on type of chart.
protected IsDefaultOptions	getDefaultValues() Returns the default options instance.
BackgroundColorCallback	getHoverBackgroundColorCallback() Returns the hover background color callback, if set, otherwise null.
BorderColorCallback	getHoverBorderColorCallback() Returns the hover border color callback, if set, otherwise null.
BorderWidthCallback	getHoverBorderWidthCallback() Returns the hover border width callback, if set, otherwise null.
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 AbstractPluginOptions> T	getOptions(AbstractPluginOptionsFactory<T> factory) Returns the plugin options, if exist. It uses a factory instance to create a plugin options. If factory argument is not consistent, null is returned.
<T extends AbstractPluginOptions> T	getOptions(String pluginId, AbstractPluginOptionsFactory<T> factory) Returns the plugin dataset configuration, if exist. It uses a factory instance to create a plugin options.
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.
protected Object	invokeColorCallback(ScriptableContext context, Scriptable<?> callback, Key property, String defaultValue, boolean hasPattern) Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
boolean	isHidden() Returns if the dataset will appear or not.
void	removeOptions(String pluginId) Removes the plugin options.
void	setBackgroundColor(BackgroundColorCallback backgroundColorCallback) Sets the background color callback.
void	setBorderColor(BorderColorCallback borderColorCallback) Sets the border color callback.
void	setBorderWidth(BorderWidthCallback borderWidthCallback) Sets the border width callback.
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	setHoverBackgroundColor(BackgroundColorCallback hoverBackgroundColorCallback) Sets the hover background color callback.
void	setHoverBorderColor(BorderColorCallback hoverBorderColorCallback) Sets the hover border color callback.
void	setHoverBorderWidth(BorderWidthCallback hoverBorderWidthCallback) Sets the hover border width callback.
void	setLabel(String label) Sets the label for the dataset which appears in the legend and tooltips.
<T extends AbstractPluginOptions> void	setOptions(String pluginId, T options) Sets the plugin dataset configuration. If dataset configuration options is null, the configuration of plugin will be removed.
<T extends AbstractPluginOptions> void	setOptions(T options) Sets the plugin 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

Dataset

protected Dataset(Type type,
                  IsDefaultOptions defaultValues)

Creates the dataset using a default and chart type related to the dataset, adding patterns and gradients element.

Parameters:

type - chart type related to the dataset

defaultValues - default options

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

getDefaultValues

protected final IsDefaultOptions getDefaultValues()

Returns the default options instance.

Returns:

the default options instance.

getBackgroundColorCallback

public final BackgroundColorCallback getBackgroundColorCallback()

Returns the background color callback, if set, otherwise null.

Returns:

the background color callback, if set, otherwise null.

setBackgroundColor

public final void setBackgroundColor(BackgroundColorCallback backgroundColorCallback)

Sets the background color callback.

Parameters:

backgroundColorCallback - the background color callback.

getBorderColorCallback

public final BorderColorCallback getBorderColorCallback()

Returns the border color callback, if set, otherwise null.

Returns:

the border color callback, if set, otherwise null.

setBorderColor

public final void setBorderColor(BorderColorCallback borderColorCallback)

Sets the border color callback.

Parameters:

borderColorCallback - the border color callback.

getBorderWidthCallback

public final BorderWidthCallback getBorderWidthCallback()

Returns the border width callback, if set, otherwise null.

Returns:

the border width callback, if set, otherwise null.

setBorderWidth

public final void setBorderWidth(BorderWidthCallback borderWidthCallback)

Sets the border width callback.

Parameters:

borderWidthCallback - the border width callback to set

getHoverBackgroundColorCallback

public final BackgroundColorCallback getHoverBackgroundColorCallback()

Returns the hover background color callback, if set, otherwise null.

Returns:

the hover background color callback, if set, otherwise null.

setHoverBackgroundColor

public final void setHoverBackgroundColor(BackgroundColorCallback hoverBackgroundColorCallback)

Sets the hover background color callback.

Parameters:

hoverBackgroundColorCallback - the hover background color callback.

getHoverBorderColorCallback

public final BorderColorCallback getHoverBorderColorCallback()

Returns the hover border color callback, if set, otherwise null.

Returns:

the hover border color callback, if set, otherwise null.

setHoverBorderColor

public final void setHoverBorderColor(BorderColorCallback hoverBorderColorCallback)

Sets the hover border color callback.

Parameters:

hoverBorderColorCallback - the hover border color callback.

getHoverBorderWidthCallback

public final BorderWidthCallback getHoverBorderWidthCallback()

Returns the hover border width callback, if set, otherwise null.

Returns:

the hover border width callback, if set, otherwise null.

setHoverBorderWidth

public final void setHoverBorderWidth(BorderWidthCallback hoverBorderWidthCallback)

Sets the hover border width callback.

Parameters:

hoverBorderWidthCallback - the hover border width callback to set

getDefaultBackgroundColorAsString

protected String getDefaultBackgroundColorAsString()

Returns the default background color value based on type of chart.

Returns:

the default background color value based on type of chart.

getDefaultBorderColorAsString

protected String getDefaultBorderColorAsString()

Returns the default border color value based on type of chart.

Returns:

the default border color value based on type of chart.

getDefaultBorderWidth

protected int getDefaultBorderWidth()

Returns the default border width value based on type of chart.

Returns:

the default border width value based on type of chart.

applyPattern

protected abstract void applyPattern(Key key,
                                     List<CanvasPatternItem> canvasPatternsList)

Stores the canvas patterns into dataset object by property name passed as key.

Parameters:

key - key property name to use to store canvas patterns into dataset object.

canvasPatternsList - list of canvas patterns

applyGradient

protected abstract void applyGradient(Key key,
                                      List<CanvasGradientItem> canvasGradientsList)

Stores the canvas gradients into dataset object by property name passed as key.

Parameters:

key - key property name to use to store canvas gradients into dataset object.

canvasGradientsList - list of canvas gradients

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.

getDataset

public Dataset getDataset()

Description copied from interface: HasDataset

Gets the dataset instance.

Specified by:

getDataset in interface HasDataset

Returns:

the dataset instance

getType

public final Type getType()

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

Returns:

type of dataset.

removeOptions

public void removeOptions(String pluginId)

Removes the plugin options.

Parameters:

pluginId - plugin id.

setOptions

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

Sets the plugin options.

Type Parameters:

T - type of plugin options to store

Parameters:

options - plugin options used to configure the plugin

setOptions

public final <T extends AbstractPluginOptions> 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 plugin options to store

Parameters:

pluginId - plugin id.

options - options 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 AbstractPluginOptions> T getOptions(String pluginId,
                                                            AbstractPluginOptionsFactory<T> factory)

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

Type Parameters:

T - type of plugin options to return

Parameters:

pluginId - plugin id.

factory - factory instance to create a plugin options.

Returns:

options instance used to configure the plugin or null if factory is null.

getOptions

public <T extends AbstractPluginOptions> T getOptions(AbstractPluginOptionsFactory<T> factory)

Returns the plugin options, if exist.
It uses a factory instance to create a plugin options.
If factory argument is not consistent, null is returned.

Type Parameters:

T - type of plugin options to return

Parameters:

factory - factory instance to create a plugin options

Returns:

plugin options used to configure the plugin or an empty object if not exist.
If factory argument is not consistent, null is returned.

invokeColorCallback

protected final Object invokeColorCallback(ScriptableContext context,
                                           Scriptable<?> callback,
                                           Key property,
                                           String defaultValue,
                                           boolean hasPattern)

Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.

Parameters:

context - scriptable context

callback - callback to invoke

property - property of dataset used to store the color

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

hasPattern - if true is able to manage also Pattern or CanvasPatternItem, otherwise it skips them.

Returns:

a value of property as color