org.pepstock.charba.client.data

Class TimeSeriesBarDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.HoverFlexDataset

org.pepstock.charba.client.data.BarDataset

org.pepstock.charba.client.data.TimeSeriesBarDataset

All Implemented Interfaces:

HasCallbackScope, HasDataPoints, HasDataset, HasTimeSeriesItems, IsDefaultAnimationContainer, IsDefaultAnimationTransition, IsDefaultBarDatasets, HasAnimationOptions, HasBarDatasetOptions

public class TimeSeriesBarDataset
extends BarDataset
implements HasTimeSeriesItems

The time series bar chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
In time series charts, the data (as double) is not allowed. You must use DataPoint or TimeSeriesItem.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset

Dataset.CanvasObjectProperty, Dataset.CommonProperty

Field Summary

Fields inherited from class org.pepstock.charba.client.data.BarDataset

FLOATING_BAR_DATA_FACTORY

Fields inherited from class org.pepstock.charba.client.data.Dataset

DEFAULT_HIDDEN, DEFAULT_NORMALIZED, DEFAULT_PARSING

Constructor Summary

Constructors

Modifier	Constructor and Description
	TimeSeriesBarDataset() Creates a dataset. It uses the global options has default.
	TimeSeriesBarDataset(boolean hidden) Creates a dataset. It uses the global options has default.
	TimeSeriesBarDataset(IsDefaultOptions defaultValues) Creates the dataset using a default.
	TimeSeriesBarDataset(IsDefaultOptions defaultValues, boolean hidden) Creates the dataset using a default.
protected	TimeSeriesBarDataset(Type type, boolean hidden) Creates the dataset using a default and chart type related to the dataset.
protected	TimeSeriesBarDataset(Type type, IsDefaultOptions defaultValues, boolean hidden) Creates the dataset using a default and chart type related to the dataset.

Method Summary

Modifier and Type	Method and Description
org.pepstock.charba.client.data.BarStackHandler	getBarStackHandler() Returns an stack option handler instance.
List<Double>	getData() Returns the data property of a data set for a chart is specified as a list of numbers. Each point in the data list corresponds to the label at the same index on the x axis.
List<Double>	getData(boolean binding) Returns the data property of a data set for a chart is specified as a list of numbers. Each point in the data list corresponds to the label at the same index on the x axis.
default int	getOrder() Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default String	getStackGroup() Returns the name of stack group.
void	setData(double... values) Sets the data property of a data set 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.
void	setData(List<Double> values) Sets the data property of a data set for a chart is specified as a list of numbers. Each point in the data list corresponds to the label at the same index on the x axis.
default void	setOrder(int order) Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default void	setStackGroup(String stackGroup) Sets the name of stack group.

Methods inherited from class org.pepstock.charba.client.data.BarDataset

getBase, getBaseCallback, getBorderRadius, getBorderRadiusAsObjects, getBorderRadiusCallback, getBorderSkipped, getBorderSkippedCallback, getBorderWidth, getBorderWidthAsObjects, getBorderWidthCallback, getDatasetOptionsHandler, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultHoverBackgroundColorAsString, getDefaultHoverBorderColorAsString, getDefaultHoverBorderWidth, getEnableBorderRadiusCallback, getFloatingData, getFloatingData, getHoverBorderRadius, getHoverBorderRadiusAsObjects, getHoverBorderRadiusCallback, getHoverBorderWidth, getHoverBorderWidthAsObjects, getHoverBorderWidthCallback, getIndexAxis, getLabel, getOrderHandler, getPointStyle, getPointStyleAsCanvas, getPointStyleAsImage, getPointStyleCallback, getPointStyleType, getXAxisID, getYAxisID, isEnableBorderRadius, setBase, setBase, setBase, setBorderRadius, setBorderRadius, setBorderRadius, setBorderRadius, setBorderRadius, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderWidth, setBorderWidth, setBorderWidth, setBorderWidth, setBorderWidth, setEnableBorderRadius, setEnableBorderRadius, setEnableBorderRadius, setFloatingData, setFloatingData, setFloatingData, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setIndexAxis, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setXAxisID, setXAxisID, setYAxisID, setYAxisID

Methods inherited from class org.pepstock.charba.client.data.HoverFlexDataset

getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPatterns, getBackgroundColorAsString, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getColors, getHoverBackgroundColor, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderColor, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getWidths, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setColors, setColors, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setWidths

Methods inherited from class org.pepstock.charba.client.data.Dataset

createContext, getAnimationContainer, getBackgroundColorCallback, getBorderColorCallback, getClip, getClipAsObject, getDataCount, getDataset, getDataType, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getId, getOptions, getOptions, getScope, getType, getTypedDataset, hasOptions, invokeColorCallback, isClip, isHidden, isNormalized, isParsing, removeOptions, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setClip, setClip, setClip, setHidden, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setLabel, setNormalized, setOptions, setOptions, setParsing

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

Methods inherited from interface org.pepstock.charba.client.data.HasTimeSeriesItems

checkTimeSeriesItems, getTimeSeriesData, getTimeSeriesData, isTimeSeriesItem, setDataPoints, setDataPoints, setTimeSeriesData, setTimeSeriesData

Methods inherited from interface org.pepstock.charba.client.data.HasDataPoints

getDataPoints, getDataPoints

Methods inherited from interface org.pepstock.charba.client.data.HasDataset

getDataset

Methods inherited from interface org.pepstock.charba.client.options.HasBarDatasetOptions

getBarPercentage, getBarThickness, getCategoryPercentage, getMaxBarThickness, getMinBarLength, isGrouped, setBarPercentage, setBarThickness, setCategoryPercentage, setGrouped, setMaxBarThickness, setMinBarLength

Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Methods inherited from interface org.pepstock.charba.client.commons.HasCallbackScope

extractScope

Constructor Detail

TimeSeriesBarDataset

public TimeSeriesBarDataset()

Creates a dataset.
It uses the global options has default.

TimeSeriesBarDataset

public TimeSeriesBarDataset(boolean hidden)

Creates a dataset.
It uses the global options has default.

Parameters:

hidden - if true, it will be initially hidden.

TimeSeriesBarDataset

public TimeSeriesBarDataset(IsDefaultOptions defaultValues)

Creates the dataset using a default.

Parameters:

defaultValues - default options

TimeSeriesBarDataset

public TimeSeriesBarDataset(IsDefaultOptions defaultValues,
                            boolean hidden)

Creates the dataset using a default.

Parameters:

defaultValues - default options

hidden - if true, it will be initially hidden.

TimeSeriesBarDataset

protected TimeSeriesBarDataset(Type type,
                               boolean hidden)

Creates the dataset using a default and chart type related to the dataset.

Parameters:

type - chart type related to the dataset

hidden - if true, it will be initially hidden.

TimeSeriesBarDataset

protected TimeSeriesBarDataset(Type type,
                               IsDefaultOptions defaultValues,
                               boolean hidden)

Creates the dataset using a default and chart type related to the dataset.

Parameters:

type - chart type related to the dataset

defaultValues - default options

hidden - if true, it will be initially hidden.

Method Detail

getBarStackHandler

public final org.pepstock.charba.client.data.BarStackHandler getBarStackHandler()

Returns an stack option handler instance.

Returns:

an stack option handler instance

setData

public final void setData(double... values)

Description copied from class: Dataset

Sets the data property of a data set 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.

Specified by:

setData in interface HasTimeSeriesItems

Overrides:

setData in class Dataset

Parameters:

values - an array of numbers

setData

public final void setData(List<Double> values)

Description copied from class: Dataset

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

Specified by:

setData in interface HasTimeSeriesItems

Overrides:

setData in class Dataset

Parameters:

values - list of numbers.

getData

public final List<Double> getData()

Description copied from class: Dataset

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

Specified by:

getData in interface HasTimeSeriesItems

Overrides:

getData in class Dataset

Returns:

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

getData

public final List<Double> getData(boolean binding)

Description copied from class: Dataset

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

Specified by:

getData in interface HasTimeSeriesItems

Overrides:

getData in class Dataset

Parameters:

binding - if true binds the new array list in the container

Returns:

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

setStackGroup

public void setStackGroup(String stackGroup)

Sets the name of stack group.

Parameters:

stackGroup - name of stack group.

getStackGroup

public String getStackGroup()

Returns the name of stack group.

Returns:

the name of stack group.

setOrder

public void setOrder(int order)

Sets the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Parameters:

order - the drawing order of dataset.

getOrder

public int getOrder()

Returns the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Returns:

the drawing order of dataset