org.pepstock.charba.client.data

Class Data

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Data

All Implemented Interfaces:

ConfigurationElement

public final class Data
extends NativeObjectContainer
implements ConfigurationElement

CHART.JS entity object to configure the data options of a chart.
It contains labels and datasets.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
Data() Creates the object with an empty native object.

Method Summary

Modifier and Type	Method and Description
List<Dataset>	getDatasets() Returns the list of datasets.
List<Dataset>	getDatasets(boolean binding) Returns the list of datasets.
Labels	getLabels() Returns the labels.
Labels	getLabels(boolean binding) Returns the labels for axes.
Labels	getXLabels() Returns the labels for X axes.
Labels	getXLabels(boolean binding) Returns the labels for X axes.
Labels	getYLabels() Returns the labels for Y axes.
Labels	getYLabels(boolean binding) Returns the labels for Y axes.
boolean	isCanvasObjectHandling() Returns true if the plugin to manage canvas object (gradients and patterns) has been forcedly disable. Pay attention that disabling the handler, your datasets configuration with gradients or patterns will e showed with default color.
void	load(IsChart chart, Configuration configuration) Called to enable to load into a configuration object the specific configuration item (by native object).
Dataset	retrieveDataset(LegendItem legendItem) Returns a dataset instance by legend item locator, dataset index and index.
Dataset	retrieveDataset(TooltipItem tooltipItem) Returns a dataset instance by tooltip item locator, dataset index and index.
Gradient	retrieveFillStyleAsGradient(LegendItem legendItem) Returns a gradient object set as background color for a dataset related to legend item.
Pattern	retrieveFillStyleAsPattern(LegendItem legendItem) Returns a pattern object set as background color for a dataset related to legend item.
Gradient	retrieveStrokeStyleAsGradient(LegendItem legendItem) Returns a gradient object set as border color for a dataset related to legend item.
Pattern	retrieveStrokeStyleAsPattern(LegendItem legendItem) Returns a pattern object set as border color for a dataset related to legend item.
void	setCanvasObjectHandling(boolean canvasObjectHandling) Sets true if the plugin to manage canvas object (gradients and patterns) have to be forcedly disable. Pay attention that disabling the handler, your datasets configuration with gradients or patterns will e showed with default color.
void	setDatasets(Dataset... datasets) Sets a set of datasets for chart.
void	setLabels(Labels labels) Sets the labels of the data.
void	setLabels(String... labels) Sets the labels of the data.
void	setXLabels(Labels labels) Sets the labels for X axes of the data.
void	setXLabels(String... labels) Sets the labels for X axes of the data.
void	setYLabels(Labels labels) Sets the labels for Y axes of the data.
void	setYLabels(String... labels) Sets the labels for Y axes of the data.

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

Data

public Data()

Creates the object with an empty native object.

Method Detail

setLabels

public void setLabels(String... labels)

Sets the labels of the data.

Parameters:

labels - array of labels

setLabels

public void setLabels(Labels labels)

Sets the labels of the data.

Parameters:

labels - labels object to manage also multi-line labels

getLabels

public Labels getLabels()

Returns the labels.

Returns:

the labels

getLabels

public Labels getLabels(boolean binding)

Returns the labels for axes.

Parameters:

binding - if true binds the new labels into container

Returns:

the labels for axes

setXLabels

public void setXLabels(String... labels)

Sets the labels for X axes of the data.

Parameters:

labels - array of labels

setXLabels

public void setXLabels(Labels labels)

Sets the labels for X axes of the data.

Parameters:

labels - labels object to manage also multi-line labels

getXLabels

public Labels getXLabels()

Returns the labels for X axes.

Returns:

the labels for X axes

getXLabels

public Labels getXLabels(boolean binding)

Returns the labels for X axes.

Parameters:

binding - if true binds the new labels into container

Returns:

the labels for X axes

setYLabels

public void setYLabels(String... labels)

Sets the labels for Y axes of the data.

Parameters:

labels - array of labels

setYLabels

public void setYLabels(Labels labels)

Sets the labels for Y axes of the data.

Parameters:

labels - labels object to manage also multi-line labels

getYLabels

public Labels getYLabels()

Returns the labels for Y axes.

Returns:

the labels for Y axes

getYLabels

public Labels getYLabels(boolean binding)

Returns the labels for Y axes.

Parameters:

binding - if true binds the new labels into container

Returns:

the labels for Y axes

setDatasets

public void setDatasets(Dataset... datasets)

Sets a set of datasets for chart. If argument is null, removes all datasets.

Parameters:

datasets - set of dataset. If null, removes all datasets

getDatasets

public List<Dataset> getDatasets()

Returns the list of datasets.

Returns:

the list of datasets

getDatasets

public List<Dataset> getDatasets(boolean binding)

Returns the list of datasets.

Parameters:

binding - if true binds the new array list into container

Returns:

the list of datasets

isCanvasObjectHandling

public boolean isCanvasObjectHandling()

Returns true if the plugin to manage canvas object (gradients and patterns) has been forcedly disable.
Pay attention that disabling the handler, your datasets configuration with gradients or patterns will e showed with default color.

Returns:

true if the plugin to manage canvas object (gradients and patterns) has been forcedly disable

setCanvasObjectHandling

public void setCanvasObjectHandling(boolean canvasObjectHandling)

Sets true if the plugin to manage canvas object (gradients and patterns) have to be forcedly disable.
Pay attention that disabling the handler, your datasets configuration with gradients or patterns will e showed with default color.

Parameters:

canvasObjectHandling - true if the plugin to manage canvas object (gradients and patterns) have to be forcedly disable

retrieveFillStyleAsGradient

public final Gradient retrieveFillStyleAsGradient(LegendItem legendItem)

Returns a gradient object set as background color for a dataset related to legend item.

Parameters:

legendItem - legend item instance to get the dataset related to.

Returns:

a gradient object or null if not found by legend item

retrieveStrokeStyleAsGradient

public final Gradient retrieveStrokeStyleAsGradient(LegendItem legendItem)

Returns a gradient object set as border color for a dataset related to legend item.

Parameters:

legendItem - legend item instance to get the dataset related to.

Returns:

a gradient object or null if not found by legend item

retrieveFillStyleAsPattern

public final Pattern retrieveFillStyleAsPattern(LegendItem legendItem)

Returns a pattern object set as background color for a dataset related to legend item.

Parameters:

legendItem - legend item instance to get the dataset related to.

Returns:

a pattern object or null if not found by legend item

retrieveStrokeStyleAsPattern

public final Pattern retrieveStrokeStyleAsPattern(LegendItem legendItem)

Returns a pattern object set as border color for a dataset related to legend item.

Parameters:

legendItem - legend item instance to get the dataset related to.

Returns:

a pattern object or null if not found by legend item

retrieveDataset

public final Dataset retrieveDataset(LegendItem legendItem)

Returns a dataset instance by legend item locator, dataset index and index.

Parameters:

legendItem - legend item instance to get the dataset related to.

Returns:

a dataset instance or null if not found by legend item

retrieveDataset

public final Dataset retrieveDataset(TooltipItem tooltipItem)

Returns a dataset instance by tooltip item locator, dataset index and index.

Parameters:

tooltipItem - legend item instance to get the dataset related to.

Returns:

a dataset instance or null if not found by tooltip item

load

public void load(IsChart chart,
                 Configuration configuration)

Description copied from interface: ConfigurationElement

Called to enable to load into a configuration object the specific configuration item (by native object).

Specified by:

load in interface ConfigurationElement

Parameters:

chart - chart instance

configuration - chart configuration instance