Package org.pepstock.charba.client.data

Class HorizontalBarDataset

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.HorizontalBarDataset

All Implemented Interfaces:

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

Direct Known Subclasses:

StackedHorizontalBarDataset, TimeSeriesHorizontalBarDataset

public class HorizontalBarDataset
extends BarDataset

The horizontal bar chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set.
Some properties can be specified as an array.
If these are set to an array value, the first value applies to the first bar, the second value to the second bar, and so on.

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	Description
	HorizontalBarDataset()	Creates a data set. It uses the global options has default.
	HorizontalBarDataset(boolean hidden)	Creates a data set. It uses the global options has default.
	HorizontalBarDataset(IsDefaultOptions defaultValues)	Creates the data set using a default.
	HorizontalBarDataset(IsDefaultOptions defaultValues, boolean hidden)	Creates the data set using a default.
protected	HorizontalBarDataset(Type type, boolean hidden)	Creates the data set using chart type related to the data set.
protected	HorizontalBarDataset(Type type, IsDefaultOptions defaultValues, boolean hidden)	Creates the data set using a default and chart type related to the data set.

Method Summary

Modifier and Type	Method	Description
default int	getOrder()	Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
void	setIndexAxis(IndexAxis indexAxis)	Sets the base axis for the data set. Use IndexAxis.Y for horizontal bar.
default void	setOrder(int order)	Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.

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, getInflateAmount, getInflateAmountCallback, getLabel, getOrderHandler, getPointStyle, getPointStyleAsCanvas, getPointStyleAsImage, getPointStyleCallback, getPointStyleType, getXAxisID, getYAxisID, isAutoInflateAmount, isEnableBorderRadius, setAutoInflateAmount, 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, setInflateAmount, setInflateAmount, setInflateAmount, setPointStyle, 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, getData, getData, 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, setData, setData, setHidden, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setLabel, setNormalized, setOptions, setOptions, setParsing

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, 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

checkAndGetColor, 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, 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, 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.options.HasAnimationOptions

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

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.data.HasDataPoints

getDataPoints, getDataPoints, setDataPoints, setDataPoints

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

getDataset

Constructor Detail

HorizontalBarDataset

public HorizontalBarDataset()

Creates a data set.
It uses the global options has default.

HorizontalBarDataset

public HorizontalBarDataset(boolean hidden)

Creates a data set.
It uses the global options has default.

Parameters:

hidden - if true, it will be initially hidden.

HorizontalBarDataset

public HorizontalBarDataset(IsDefaultOptions defaultValues)

Creates the data set using a default.

Parameters:

defaultValues - default options

HorizontalBarDataset

public HorizontalBarDataset(IsDefaultOptions defaultValues,
                            boolean hidden)

Creates the data set using a default.

Parameters:

defaultValues - default options

hidden - if true, it will be initially hidden.

HorizontalBarDataset

protected HorizontalBarDataset(Type type,
                               boolean hidden)

Creates the data set using chart type related to the data set.

Parameters:

type - chart type related to the data set

hidden - if true, it will be initially hidden

HorizontalBarDataset

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

Creates the data set using a default and chart type related to the data set.

Parameters:

type - chart type related to the data set

defaultValues - default options

hidden - if true, it will be initially hidden.

Method Detail

setIndexAxis

public void setIndexAxis(IndexAxis indexAxis)

Description copied from class: BarDataset

Sets the base axis for the data set.
Use IndexAxis.Y for horizontal bar.

Overrides:

setIndexAxis in class BarDataset

Parameters:

indexAxis - the base axis for the data set

setOrder

public default 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 default int getOrder()

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

Returns:

the drawing order of dataset