org.pepstock.charba.client.data

Class BarDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.HovingFlexDataset

org.pepstock.charba.client.data.BarDataset

All Implemented Interfaces:

HasDataPoints, HasDataset

Direct Known Subclasses:

StackedBarDataset, TimeSeriesBarDataset

public class BarDataset
extends HovingFlexDataset
implements HasDataPoints

The bar chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
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

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLEX_BAR_THICKNESS If set to 'flex', the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap.

Constructor Summary

Constructors

Constructor and Description
BarDataset() Creates a dataset. It uses the global options has default.
BarDataset(IsDefaultOptions defaultValues) Creates the dataset using a default.

Method Summary

Modifier and Type	Method and Description
double	getBarPercentage() Returns the percent (0-1) of the available width each bar should be within the category width.
int	getBarThickness() Returns the width of each bar in pixels.
BorderSkipped	getBorderSkipped() Returns the edge to skip drawing the border for.
BorderSkippedCallback	getBorderSkippedCallback() Returns the border skipped callback, if set, otherwise null.
BarBorderWidth	getBorderWidthAsItem() Returns the stroke width of the bar in pixels.
double	getCategoryPercentage() Returns the percent (0-1) of the available width each category should be within the sample width.
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.
String	getLabel() Returns the label for the dataset which appears in the legend and tooltips.
int	getMaxBarThickness() Returns the maximum bar thickness.
int	getMinBarLength() Returns a minimum length in pixels.
default int	getOrder() Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
Orderer	getOrderer() Returns an order option manager instance.
String	getXAxisID() Returns the ID of the x axis to plot this dataset on.
String	getYAxisID() Returns the ID of the y axis to plot this dataset on.
void	setBarPercentage(double barPercentage) Sets the percent (0-1) of the available width each bar should be within the category width.
void	setBarThickness(int barThickness) Sets the width of each bar in pixels.
void	setBorderSkipped(boolean borderskip) Sets the edge to skip drawing the border for.
void	setBorderSkipped(BorderSkipped borderskip) Sets the edge to skip drawing the border for.
void	setBorderSkipped(BorderSkippedCallback borderSkippedCallback) Sets the border skipped callback.
void	setBorderWidth(BarBorderWidth borderWidth) Sets the stroke width of the bar in pixels.
void	setCategoryPercentage(double categoryPercentage) Sets the percent (0-1) of the available width each category should be within the sample width.
void	setMaxBarThickness(int maxBarThickness) Sets the maximum bar thickness, to ensure that bars are not sized thicker than this
void	setMinBarLength(int minBarLength) Set this to ensure that bars have a minimum length in pixels.
default void	setOrder(int order) Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
void	setXAxisID(String xAxisID) Sets the ID of the x axis to plot this dataset on.
void	setYAxisID(String yAxisID) Sets the ID of the y axis to plot this dataset on.

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

applyGradient, applyPattern, getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPatterns, getBackgroundColorAsString, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getBorderWidth, getHoverBackgroundColor, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderColor, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getHoverBorderWidth, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderWidth

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

getBackgroundColorCallback, getBorderColorCallback, getBorderWidthCallback, getData, getData, getDataset, getDataType, getDefaultValues, getId, getOptions, getType, hasOptions, isHidden, setBackgroundColor, setBorderColor, setBorderWidth, setData, setData, setHidden, setLabel, setOptions, setType

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

checkValue, 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

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

Field Detail

FLEX_BAR_THICKNESS

public static final int FLEX_BAR_THICKNESS

If set to 'flex', the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using barPercentage and categoryPercentage. There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced, Integer.MIN_VALUE.

See Also:

Constant Field Values

Constructor Detail

BarDataset

public BarDataset()

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

BarDataset

public BarDataset(IsDefaultOptions defaultValues)

Creates the dataset using a default.

Parameters:

defaultValues - default options

Method Detail

getOrderer

public Orderer getOrderer()

Returns an order option manager instance.

Returns:

an order option manager instance

getLabel

public String getLabel()

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

Overrides:

getLabel in class Dataset

Returns:

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

setXAxisID

public void setXAxisID(String xAxisID)

Sets the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

Parameters:

xAxisID - the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

getXAxisID

public String getXAxisID()

Returns the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

Returns:

the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

setYAxisID

public void setYAxisID(String yAxisID)

Sets the ID of the y axis to plot this dataset on. If not specified, this defaults to the ID of the first found y axis.

Parameters:

yAxisID - the ID of the y axis to plot this dataset on. If not specified, this defaults to the ID of the first found y axis.

getYAxisID

public String getYAxisID()

Returns the ID of the y axis to plot this dataset on. If not specified, this defaults to the ID of the first found y axis.

Returns:

the ID of the y axis to plot this dataset on. If not specified, this defaults to the ID of the first found y axis.

setBarPercentage

public void setBarPercentage(double barPercentage)

Sets the percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

Parameters:

barPercentage - percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

getBarPercentage

public double getBarPercentage()

Returns the percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

Returns:

percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

setCategoryPercentage

public void setCategoryPercentage(double categoryPercentage)

Sets the percent (0-1) of the available width each category should be within the sample width.

Parameters:

categoryPercentage - percent (0-1) of the available width each category should be within the sample width.

getCategoryPercentage

public double getCategoryPercentage()

Returns the percent (0-1) of the available width each category should be within the sample width.

Returns:

the percent (0-1) of the available width each category should be within the sample width.

setBarThickness

public void setBarThickness(int barThickness)

Sets the width of each bar in pixels. If set to 'flex', it computes "optimal" sample widths that globally arrange bars side by side. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.

Parameters:

barThickness - width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.

getBarThickness

public int getBarThickness()

Returns the width of each bar in pixels. If set to 'flex', it computes "optimal" sample widths that globally arrange bars side by side. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.

Returns:

width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.

setMaxBarThickness

public void setMaxBarThickness(int maxBarThickness)

Sets the maximum bar thickness, to ensure that bars are not sized thicker than this

Parameters:

maxBarThickness - the maximum bar thickness.

getMaxBarThickness

public int getMaxBarThickness()

Returns the maximum bar thickness.

Returns:

the maximum bar thickness.

setMinBarLength

public void setMinBarLength(int minBarLength)

Set this to ensure that bars have a minimum length in pixels.

Parameters:

minBarLength - a minimum length in pixels.

getMinBarLength

public int getMinBarLength()

Returns a minimum length in pixels.

Returns:

a minimum length in pixels.

setBorderWidth

public void setBorderWidth(BarBorderWidth borderWidth)

Sets the stroke width of the bar in pixels.

Parameters:

borderWidth - the stroke width of the bar in pixels.

getBorderWidthAsItem

public BarBorderWidth getBorderWidthAsItem()

Returns the stroke width of the bar in pixels. If a callback or an array have been set, returns an empty object.

Returns:

list of the stroke width of the bar in pixels. If a callback or an array have been set, returns an empty object

setBorderSkipped

public void setBorderSkipped(boolean borderskip)

Sets the edge to skip drawing the border for.

Parameters:

borderskip - to set false as border skipped. If set true, is ignored

setBorderSkipped

public void setBorderSkipped(BorderSkipped borderskip)

Sets the edge to skip drawing the border for.

Parameters:

borderskip - the edge to skip drawing the border for.

getBorderSkipped

public BorderSkipped getBorderSkipped()

Returns the edge to skip drawing the border for.

Returns:

the edge to skip drawing the border for.

getBorderSkippedCallback

public BorderSkippedCallback getBorderSkippedCallback()

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

Returns:

the border skipped callback, if set, otherwise null.

setBorderSkipped

public void setBorderSkipped(BorderSkippedCallback borderSkippedCallback)

Sets the border skipped callback.

Parameters:

borderSkippedCallback - the border skipped callback to set

getDefaultBackgroundColorAsString

protected String getDefaultBackgroundColorAsString()

Description copied from class: Dataset

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

Overrides:

getDefaultBackgroundColorAsString in class Dataset

Returns:

the default background color value based on type of chart.

getDefaultBorderColorAsString

protected String getDefaultBorderColorAsString()

Description copied from class: Dataset

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

Overrides:

getDefaultBorderColorAsString in class Dataset

Returns:

the default border color value based on type of chart.

getDefaultBorderWidth

protected int getDefaultBorderWidth()

Description copied from class: Dataset

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

Overrides:

getDefaultBorderWidth in class Dataset

Returns:

the default border width value based on type of chart.

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