BarDataset (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.data.Dataset
  - - org.pepstock.charba.client.data.BarDataset

All Implemented Interfaces:

HasDataPoints

Direct Known Subclasses:

StackedBarDataset
```
public class BarDataset
extends Dataset
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

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<IsColor>`	`getBackgroundColor()` Returns the fill colors of the elements.
`List<Gradient>`	`getBackgroundColorAsGradient()` Returns the fill gradient of elements.
`List<Pattern>`	`getBackgroundColorAsPatterns()` Returns the fill patters of elements.
`List<String>`	`getBackgroundColorAsString()` Returns the fill colors of the elements.
`List<IsColor>`	`getBorderColor()` Returns the color of the bar border
`List<Gradient>`	`getBorderColorAsGradient()` Returns the gradient of the bar border.
`List<String>`	`getBorderColorAsString()` Returns the color of the bar border
`Position`	`getBorderSkipped()` Returns the edge to skip drawing the border for.
`List<Integer>`	`getBorderWidth()` Returns the stroke width of the bar in pixels.
`List<DataPoint>`	`getDataPoints()` Returns the data property of a dataset for a chart is specified as an array of data points
`List<DataPoint>`	`getDataPoints(boolean binding)` Returns the data property of a dataset for a chart is specified as an array of data points
`List<IsColor>`	`getHoverBackgroundColor()` Returns the fill color of the elements when hovered.
`List<Gradient>`	`getHoverBackgroundColorAsGradient()` Returns the fill gradients of elements when hovered.
`List<Pattern>`	`getHoverBackgroundColorAsPatterns()` Returns the fill patters of elements when hovered.
`List<String>`	`getHoverBackgroundColorAsString()` Returns the fill color of the elements when hovered.
`List<IsColor>`	`getHoverBorderColor()` Returns the stroke color of the elements when hovered
`List<Gradient>`	`getHoverBorderColorAsGradient()` Returns the stroke gradients of the elements when hovered.
`List<String>`	`getHoverBorderColorAsString()` Returns the stroke color of the elements when hovered.
`List<Integer>`	`getHoverBorderWidth()` Returns the stroke width of the elements when hovered.
`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`	`setBackgroundColor(Gradient... backgroundColor)` Sets the fill gradient of the elements.
`void`	`setBackgroundColor(IsColor... backgroundColor)` Sets the fill colors of the elements.
`void`	`setBackgroundColor(Pattern... backgroundColor)` Sets the fill pattern of the elements.
`void`	`setBackgroundColor(String... backgroundColor)` Sets the fill colors of the elements.
`void`	`setBorderColor(Gradient... borderColor)` Sets the gradient of the bar border as gradient.
`void`	`setBorderColor(IsColor... borderColor)` Sets the color of the bar border
`void`	`setBorderColor(String... borderColor)` Sets the color of the bar border
`void`	`setBorderSkipped(Position position)` Sets the edge to skip drawing the border for.
`void`	`setBorderWidth(int... borderWidth)` Sets the stroke width of the bar in pixels.
`void`	`setDataPoints(DataPoint... datapoints)` Sets the data property of a dataset for a chart is specified as an array of data points.
`void`	`setDataPoints(List<DataPoint> datapoints)` Sets the data property of a dataset for a chart is specified as an array of data points.
`void`	`setHoverBackgroundColor(Gradient... colors)` Sets the fill gradient of the elements when hovered.
`void`	`setHoverBackgroundColor(IsColor... colors)` Sets the fill color of the elements when hovered
`void`	`setHoverBackgroundColor(Pattern... colors)` Sets the fill pattern of the elements when hovered.
`void`	`setHoverBackgroundColor(String... colors)` Sets the fill color of the elements when hovered
`void`	`setHoverBorderColor(Gradient... colors)` Sets the stroke gradient of elements when hovered as gradient.
`void`	`setHoverBorderColor(IsColor... colors)` Sets the stroke color of the elements when hovered
`void`	`setHoverBorderColor(String... colors)` Sets the stroke color of the elements when hovered
`void`	`setHoverBorderWidth(int... widths)` Sets the stroke width of the elements when hovered.
`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.Dataset
getData, getData, getDataType, getId, getLabel, getOptions, getType, hasOptions, isHidden, setData, setData, setHidden, setLabel, setOptions, setType

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
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

- 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
  - 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.
  - setBorderSkipped
```
public void setBorderSkipped(Position position)
```
    Sets the edge to skip drawing the border for.
    
    Parameters:
    
    position - the edge to skip drawing the border for.
  - getBorderSkipped
```
public Position getBorderSkipped()
```
    Returns the edge to skip drawing the border for.
    
    Returns:
    
    the edge to skip drawing the border for.
  - setDataPoints
```
public void setDataPoints(DataPoint... datapoints)
```
    Sets the data property of a dataset for a chart is specified as an array of data points.
    
    Specified by:
    
    setDataPoints in interface HasDataPoints
    
    Parameters:
    
    datapoints - an array of data points
  - setDataPoints
```
public void setDataPoints(List<DataPoint> datapoints)
```
    Sets the data property of a dataset for a chart is specified as an array of data points.
    
    Specified by:
    
    setDataPoints in interface HasDataPoints
    
    Parameters:
    
    datapoints - a list of data points
  - getDataPoints
```
public List<DataPoint> getDataPoints()
```
    Returns the data property of a dataset for a chart is specified as an array of data points
    
    Specified by:
    
    getDataPoints in interface HasDataPoints
    
    Returns:
    
    a list of data points or an empty list of data points if the data type is not DataType.points.
  - getDataPoints
```
public List<DataPoint> getDataPoints(boolean binding)
```
    Returns the data property of a dataset for a chart is specified as an array of data points
    
    Specified by:
    
    getDataPoints in interface HasDataPoints
    
    Parameters:
    
    binding - if true binds the new array list into container
    
    Returns:
    
    a list of data points or an empty list of data points if the data type is not DataType.points.
  - setBackgroundColor
```
public void setBackgroundColor(IsColor... backgroundColor)
```
    Sets the fill colors of the elements.
    
    Parameters:
    
    backgroundColor - the fill colors of the elements.
  - setBackgroundColor
```
public void setBackgroundColor(String... backgroundColor)
```
    Sets the fill colors of the elements.
    
    Parameters:
    
    backgroundColor - the fill colors of the elements.
  - setBackgroundColor
```
public void setBackgroundColor(Pattern... backgroundColor)
```
    Sets the fill pattern of the elements.
    
    Parameters:
    
    backgroundColor - the fill pattern of element.
  - setBackgroundColor
```
public void setBackgroundColor(Gradient... backgroundColor)
```
    Sets the fill gradient of the elements.
    
    Parameters:
    
    backgroundColor - the fill gradient of the elements.
  - getBackgroundColorAsString
```
public List<String> getBackgroundColorAsString()
```
    Returns the fill colors of the elements. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill colors of the elements. If property is missing or not a color, returns an empty list.
  - getBackgroundColor
```
public List<IsColor> getBackgroundColor()
```
    Returns the fill colors of the elements. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill colors of the elements. If property is missing or not a color, returns an empty list.
  - getBackgroundColorAsPatterns
```
public List<Pattern> getBackgroundColorAsPatterns()
```
    Returns the fill patters of elements. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of elements. If property is missing or not a pattern, returns an empty list.
  - getBackgroundColorAsGradient
```
public List<Gradient> getBackgroundColorAsGradient()
```
    Returns the fill gradient of elements. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the fill gradient of elements. If property is missing or not a gradient, returns an empty list.
  - setBorderColor
```
public void setBorderColor(IsColor... borderColor)
```
    Sets the color of the bar border
    
    Parameters:
    
    borderColor - the color of the bar border
  - setBorderColor
```
public void setBorderColor(String... borderColor)
```
    Sets the color of the bar border
    
    Parameters:
    
    borderColor - the color of the bar border
  - setBorderColor
```
public void setBorderColor(Gradient... borderColor)
```
    Sets the gradient of the bar border as gradient.
    
    Parameters:
    
    borderColor - the gradient of the bar border as gradient.
  - getBorderColorAsString
```
public List<String> getBorderColorAsString()
```
    Returns the color of the bar border
    
    Returns:
    
    list of the color of the bar border
  - getBorderColor
```
public List<IsColor> getBorderColor()
```
    Returns the color of the bar border
    
    Returns:
    
    list of the color of the bar border
  - getBorderColorAsGradient
```
public List<Gradient> getBorderColorAsGradient()
```
    Returns the gradient of the bar border. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the gradient of the bar border. If property is missing or not a gradient, returns an empty list.
  - setBorderWidth
```
public void setBorderWidth(int... borderWidth)
```
    Sets the stroke width of the bar in pixels.
    
    Parameters:
    
    borderWidth - the stroke width of the bar in pixels.
  - getBorderWidth
```
public List<Integer> getBorderWidth()
```
    Returns the stroke width of the bar in pixels.
    
    Returns:
    
    list of the stroke width of the bar in pixels.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(IsColor... colors)
```
    Sets the fill color of the elements when hovered
    
    Parameters:
    
    colors - the fill color of the elements when hovered
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(String... colors)
```
    Sets the fill color of the elements when hovered
    
    Parameters:
    
    colors - the fill color of the elements when hovered
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(Pattern... colors)
```
    Sets the fill pattern of the elements when hovered.
    
    Parameters:
    
    colors - the fill pattern of element when hovered.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(Gradient... colors)
```
    Sets the fill gradient of the elements when hovered.
    
    Parameters:
    
    colors - the fill gradient of the elements when hovered.
  - getHoverBackgroundColorAsString
```
public List<String> getHoverBackgroundColorAsString()
```
    Returns the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColor
```
public List<IsColor> getHoverBackgroundColor()
```
    Returns the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the elements when hovered.If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColorAsPatterns
```
public List<Pattern> getHoverBackgroundColorAsPatterns()
```
    Returns the fill patters of elements when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of elements when hovered. If property is missing or not a pattern, returns an empty list.
  - getHoverBackgroundColorAsGradient
```
public List<Gradient> getHoverBackgroundColorAsGradient()
```
    Returns the fill gradients of elements when hovered. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    list of the fill gradients of elements when hovered. If property is missing or not a gradient, returns an empty list.
  - setHoverBorderColor
```
public void setHoverBorderColor(IsColor... colors)
```
    Sets the stroke color of the elements when hovered
    
    Parameters:
    
    colors - the stroke color of the elements when hovered
  - setHoverBorderColor
```
public void setHoverBorderColor(String... colors)
```
    Sets the stroke color of the elements when hovered
    
    Parameters:
    
    colors - the stroke color of the elements when hovered
  - setHoverBorderColor
```
public void setHoverBorderColor(Gradient... colors)
```
    Sets the stroke gradient of elements when hovered as gradient.
    
    Parameters:
    
    colors - the stroke gradient of elements when hovered as gradient.
  - getHoverBorderColorAsString
```
public List<String> getHoverBorderColorAsString()
```
    Returns the stroke color of the elements when hovered.
    
    Returns:
    
    list of the stroke color of the elements when hovered.
  - getHoverBorderColor
```
public List<IsColor> getHoverBorderColor()
```
    Returns the stroke color of the elements when hovered
    
    Returns:
    
    list of the stroke color of the elements when hovered
  - getHoverBorderColorAsGradient
```
public List<Gradient> getHoverBorderColorAsGradient()
```
    Returns the stroke gradients of the elements when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the stroke gradients of the elements when hovered. If property is missing or not a pattern, returns an empty list.
  - setHoverBorderWidth
```
public void setHoverBorderWidth(int... widths)
```
    Sets the stroke width of the elements when hovered.
    
    Parameters:
    
    widths - the stroke width of the elements when hovered.
  - getHoverBorderWidth
```
public List<Integer> getHoverBorderWidth()
```
    Returns the stroke width of the elements when hovered.
    
    Returns:
    
    list of the stroke width of the elements when hovered.

Class BarDataset

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

BarDataset

BarDataset

Method Detail

setXAxisID

getXAxisID

setYAxisID

getYAxisID

setBorderSkipped

getBorderSkipped

setDataPoints

setDataPoints

getDataPoints

getDataPoints

setBackgroundColor

setBackgroundColor

setBackgroundColor

setBackgroundColor

getBackgroundColorAsString

getBackgroundColor

getBackgroundColorAsPatterns

getBackgroundColorAsGradient

setBorderColor

setBorderColor

setBorderColor

getBorderColorAsString

getBorderColor

getBorderColorAsGradient

setBorderWidth

getBorderWidth

setHoverBackgroundColor

setHoverBackgroundColor

setHoverBackgroundColor

setHoverBackgroundColor

getHoverBackgroundColorAsString

getHoverBackgroundColor

getHoverBackgroundColorAsPatterns

getHoverBackgroundColorAsGradient

setHoverBorderColor

setHoverBorderColor

setHoverBorderColor

getHoverBorderColorAsString

getHoverBorderColor

getHoverBorderColorAsGradient

setHoverBorderWidth

getHoverBorderWidth