GaugeDataset (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.PieDataset
    - - org.pepstock.charba.client.data.DoughnutDataset
      - org.pepstock.charba.client.impl.charts.MeterDataset
        
        org.pepstock.charba.client.impl.charts.GaugeDataset

```
public final class GaugeDataset
extends MeterDataset
```
The Gauge chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
Is equals of Meter dataset.
The minimum value of data is 0 (see MeterDataset.MINIMUM_VALUE).
The dataset will have always 2 data and setting the color of data (set by thresholds), only the first is the empty value.
To set the data, is mandatory to use MeterDataset.setValue(double)) method instead of Dataset.setData(double...)) one.

Author:

Andrea "Stock" Stocchero

Field Summary
- Fields inherited from class org.pepstock.charba.client.impl.charts.MeterDataset
  DEFAULT_EMPTY_VALUE_COLOR, DEFAULT_MAXIMUM_VALUE, DEFAULT_VALUE_COLOR, MINIMUM_VALUE

Constructor Summary

Constructors
Constructor and Description
`GaugeDataset(double max)` Creates a dataset for gauge with maximum value of data.
`GaugeDataset(double max, IsDefaultOptions defaultValues)` Creates a dataset setting the maximum value of dataset and defaults value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<IsColor>`	`getBackgroundColor()` Returns the fill color of the arcs in the dataset.
`List<Gradient>`	`getBackgroundColorAsGradient()` Returns the fill gradient of the arcs in the dataset.
`List<Pattern>`	`getBackgroundColorAsPatterns()` Returns the fill patters of the arcs in the dataset.
`List<String>`	`getBackgroundColorAsString()` Returns the fill color of the arcs in the dataset as string.
`List<IsColor>`	`getBorderColor()` Returns the border color of the arcs in the dataset.
`List<Gradient>`	`getBorderColorAsGradient()` Returns the border gradient of the arcs in the dataset as string.
`List<String>`	`getBorderColorAsString()` Returns the border color of the arcs in the dataset as string.
`List<Integer>`	`getBorderWidth()` Returns the border width of the arcs in the dataset.
`IsThreshold`	`getCurrent()` Returns the current threshold.
`List<IsColor>`	`getHoverBackgroundColor()` Returns the fill color of the arcs when hovered.
`List<Gradient>`	`getHoverBackgroundColorAsGradient()` Returns the fill gradients of the arcs in the dataset when hovered.
`List<Pattern>`	`getHoverBackgroundColorAsPatterns()` Returns the fill patterns of the arcs in the dataset when hovered.
`List<String>`	`getHoverBackgroundColorAsString()` Returns the fill color of the arcs when hovered as string.
`List<IsColor>`	`getHoverBorderColor()` Returns the stroke color of the arcs when hovered.
`List<Gradient>`	`getHoverBorderColorAsGradient()` Returns the stroke gradients of the arcs in the dataset when hovered.
`List<String>`	`getHoverBorderColorAsString()` Returns the stroke color of the arcs when hovered.
`List<Integer>`	`getHoverBorderWidth()` Returns the stroke width of the arcs when hovered.
`List<Threshold>`	`getThresholds()` Gets all thresholds.
`boolean`	`isPercentageThreshold()` Returns `true` if percentage threshold is used, otherwise `false`.
`void`	`setBackgroundColor(IsColor... backgroundColor)` Sets the fill color of the arcs in the dataset.
`void`	`setBackgroundColor(String... backgroundColor)` Sets the fill color of the arcs in the dataset.
`void`	`setBorderColor(IsColor... borderColor)` Sets the border color of the arcs in the dataset.
`void`	`setBorderColor(String... borderColor)` Sets the border color of the arcs in the dataset as string.
`void`	`setHoverBackgroundColor(IsColor... colors)` Sets the fill color of the arcs when hovered
`void`	`setHoverBackgroundColor(String... colors)` Sets the fill color of the arcs when hovered as string
`void`	`setHoverBorderColor(IsColor... colors)` Sets the stroke color of the arcs when hovered as string.
`void`	`setHoverBorderColor(String... colors)` Sets the stroke color of the arcs when hovered as string.
`void`	`setPercentageThreshold(boolean percentageThreshold)` Sets `true` if percentage threshold is used, otherwise `false`.
`void`	`setThresholds(Threshold... thres)` Sets all thresholds to use for this gauge.
`void`	`setValue(double value)`

Methods inherited from class org.pepstock.charba.client.impl.charts.MeterDataset
getMax, getValue, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderWidth, setData, setData, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderWidth

Methods inherited from class org.pepstock.charba.client.data.Dataset
getData, getData, getDataType, getId, getLabel, getOptions, getType, hasOptions, isHidden, 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
  - GaugeDataset
```
public GaugeDataset(double max)
```
    Creates a dataset for gauge with maximum value of data. It uses the global options has default.
    
    Parameters:
    
    max - maximum value of data.
  - GaugeDataset
```
public GaugeDataset(double max,
                    IsDefaultOptions defaultValues)
```
    Creates a dataset setting the maximum value of dataset and defaults value.
    
    Parameters:
    
    max - maximum value of dataset.
    
    defaultValues - default options
- Method Detail
  - setBackgroundColor
```
public void setBackgroundColor(IsColor... backgroundColor)
```
    Sets the fill color of the arcs in the dataset.
    
    Parameters:
    
    backgroundColor - the fill color of the arcs in the dataset.
  - setBackgroundColor
```
public void setBackgroundColor(String... backgroundColor)
```
    Sets the fill color of the arcs in the dataset.
    
    Parameters:
    
    backgroundColor - the fill color of the arcs in the dataset.
  - getCurrent
```
public IsThreshold getCurrent()
```
    Returns the current threshold.
    
    Returns:
    
    the current
  - isPercentageThreshold
```
public boolean isPercentageThreshold()
```
    Returns true if percentage threshold is used, otherwise false.
    
    Returns:
    
    true if percentage threshold is used, otherwise false
  - setPercentageThreshold
```
public void setPercentageThreshold(boolean percentageThreshold)
```
    Sets true if percentage threshold is used, otherwise false.
    
    Parameters:
    
    percentageThreshold - true if percentage threshold is used, otherwise false
  - setThresholds
```
public void setThresholds(Threshold... thres)
```
    Sets all thresholds to use for this gauge.
    
    Parameters:
    
    thres - thresholds array.
  - getThresholds
```
public List<Threshold> getThresholds()
```
    Gets all thresholds.
    
    Returns:
    
    all thresholds
  - setValue
```
public void setValue(double value)
```
    Overrides:
    
    setValue in class MeterDataset
    
    Parameters:
    
    value - the value to set
  - getBackgroundColorAsString
```
public List<String> getBackgroundColorAsString()
```
    Returns the fill color of the arcs in the dataset as string. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the arcs in the dataset as string. If property is missing or not a color, returns an empty list.
  - getBackgroundColor
```
public List<IsColor> getBackgroundColor()
```
    Returns the fill color of the arcs in the dataset. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the arcs in the dataset. If property is missing or not a color, returns an empty list.
  - getBackgroundColorAsPatterns
```
public List<Pattern> getBackgroundColorAsPatterns()
```
    Returns the fill patters of the arcs in the dataset. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of the arcs in the dataset. If property is missing or not a pattern, returns an empty list.
  - getBackgroundColorAsGradient
```
public List<Gradient> getBackgroundColorAsGradient()
```
    Returns the fill gradient of the arcs in the dataset. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the fill gradient of the arcs in the dataset. If property is missing or not a gradient, returns an empty list.
  - setBorderColor
```
public void setBorderColor(IsColor... borderColor)
```
    Sets the border color of the arcs in the dataset.
    
    Parameters:
    
    borderColor - the border color of the arcs in the dataset.
  - setBorderColor
```
public void setBorderColor(String... borderColor)
```
    Sets the border color of the arcs in the dataset as string.
    
    Parameters:
    
    borderColor - the border color of the arcs in the dataset as string.
  - getBorderColorAsString
```
public List<String> getBorderColorAsString()
```
    Returns the border color of the arcs in the dataset as string.
    
    Returns:
    
    list of the border color of the arcs in the dataset as string.
  - getBorderColor
```
public List<IsColor> getBorderColor()
```
    Returns the border color of the arcs in the dataset.
    
    Returns:
    
    list of the border color of the arcs in the dataset.
  - getBorderColorAsGradient
```
public List<Gradient> getBorderColorAsGradient()
```
    Returns the border gradient of the arcs in the dataset as string. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the border gradient of the arcs in the dataset as string. If property is missing or not a gradient, returns an empty list.
  - getBorderWidth
```
public List<Integer> getBorderWidth()
```
    Returns the border width of the arcs in the dataset.
    
    Returns:
    
    list of the border width of the arcs in the dataset.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(IsColor... colors)
```
    Sets the fill color of the arcs when hovered
    
    Parameters:
    
    colors - the fill color of the arcs when hovered
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(String... colors)
```
    Sets the fill color of the arcs when hovered as string
    
    Parameters:
    
    colors - the fill color of the arcs when hovered as string
  - getHoverBackgroundColorAsString
```
public List<String> getHoverBackgroundColorAsString()
```
    Returns the fill color of the arcs when hovered as string. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the arcs when hovered as string. If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColor
```
public List<IsColor> getHoverBackgroundColor()
```
    Returns the fill color of the arcs when hovered. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the arcs when hovered. If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColorAsPatterns
```
public List<Pattern> getHoverBackgroundColorAsPatterns()
```
    Returns the fill patterns of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.
  - getHoverBackgroundColorAsGradient
```
public List<Gradient> getHoverBackgroundColorAsGradient()
```
    Returns the fill gradients of the arcs in the dataset when hovered. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    list of the fill gradients of the arcs in the dataset 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 arcs when hovered as string.
    
    Parameters:
    
    colors - the stroke color of the arcs when hovered as string.
  - setHoverBorderColor
```
public void setHoverBorderColor(String... colors)
```
    Sets the stroke color of the arcs when hovered as string.
    
    Parameters:
    
    colors - the stroke color of the arcs when hovered as string.
  - getHoverBorderColorAsString
```
public List<String> getHoverBorderColorAsString()
```
    Returns the stroke color of the arcs when hovered.
    
    Returns:
    
    list of the stroke color of the arcs when hovered.
  - getHoverBorderColor
```
public List<IsColor> getHoverBorderColor()
```
    Returns the stroke color of the arcs when hovered.
    
    Returns:
    
    list of the stroke color of the arcs when hovered.
  - getHoverBorderColorAsGradient
```
public List<Gradient> getHoverBorderColorAsGradient()
```
    Returns the stroke gradients of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the stroke gradients of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.
  - getHoverBorderWidth
```
public List<Integer> getHoverBorderWidth()
```
    Returns the stroke width of the arcs when hovered.
    
    Returns:
    
    list of the stroke width of the arcs when hovered.

Class GaugeDataset

Field Summary

Fields inherited from class org.pepstock.charba.client.impl.charts.MeterDataset

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.impl.charts.MeterDataset

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

GaugeDataset

GaugeDataset

Method Detail

setBackgroundColor

setBackgroundColor

getCurrent

isPercentageThreshold

setPercentageThreshold

setThresholds

getThresholds

setValue

getBackgroundColorAsString

getBackgroundColor

getBackgroundColorAsPatterns

getBackgroundColorAsGradient

setBorderColor

setBorderColor

getBorderColorAsString

getBorderColor

getBorderColorAsGradient

getBorderWidth

setHoverBackgroundColor

setHoverBackgroundColor

getHoverBackgroundColorAsString

getHoverBackgroundColor

getHoverBackgroundColorAsPatterns

getHoverBackgroundColorAsGradient

setHoverBorderColor

setHoverBorderColor

getHoverBorderColorAsString

getHoverBorderColor

getHoverBorderColorAsGradient

getHoverBorderWidth