org.pepstock.charba.client.data

Class GaugeDataset

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.PieDataset

org.pepstock.charba.client.data.DoughnutDataset

org.pepstock.charba.client.data.MeterDataset

org.pepstock.charba.client.data.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

See Also:

MeterDataset

Field Summary

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

DEFAULT_EMPTY_VALUE_COLOR, DEFAULT_MAXIMUM_VALUE, DEFAULT_VALUE_COLOR, MINIMUM_VALUE

Constructor Summary

Constructors

Constructor and Description
GaugeDataset(double max)

Method Summary

Modifier and Type	Method and Description
java.util.List<IsColor>	getBackgroundColor() Returns the fill color of the arcs in the dataset.
java.util.List<java.lang.String>	getBackgroundColorAsString() Returns the fill color of the arcs in the dataset as string.
java.util.List<IsColor>	getBorderColor() Returns the border color of the arcs in the dataset.
java.util.List<java.lang.String>	getBorderColorAsString() Returns the border color of the arcs in the dataset as string.
java.util.List<java.lang.Integer>	getBorderWidth() Returns the border width of the arcs in the dataset.
IsThreshold	getCurrent()
java.util.List<IsColor>	getHoverBackgroundColor() Returns the fill color of the arcs when hovered
java.util.List<java.lang.String>	getHoverBackgroundColorAsString() Returns the fill color of the arcs when hovered as string
java.util.List<IsColor>	getHoverBorderColor() Returns the stroke color of the arcs when hovered.
java.util.List<java.lang.String>	getHoverBorderColorAsString() Returns the stroke color of the arcs when hovered.
java.util.List<java.lang.Integer>	getHoverBorderWidth() Returns the stroke width of the arcs when hovered.
java.util.List<Threshold>	getThresholds() Gets all thresholds.
boolean	isPercentageThreshold()
void	setBackgroundColor(IsColor... backgroundColor) Sets the fill color of the arcs in the dataset.
void	setBackgroundColor(java.lang.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(java.lang.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(java.lang.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(java.lang.String... colors) Sets the stroke color of the arcs when hovered as string.
void	setPercentageThreshold(boolean percentageThreshold)
void	setThresholds(Threshold... thres) Sets all thresholds to use for this gauge.
void	setValue(double value)

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

getMax, getValue, setBorderWidth, setData, setData, setHoverBorderWidth

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

getData, getLabel, getType, isHidden, setHidden, setLabel, setType

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GaugeDataset

public GaugeDataset(double max)

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(java.lang.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

isPercentageThreshold

public boolean isPercentageThreshold()

Returns:

the percentageThresholds

setPercentageThreshold

public void setPercentageThreshold(boolean percentageThreshold)

Parameters:

percentageThreshold - the percentageThresholds to set

setThresholds

public void setThresholds(Threshold... thres)

Sets all thresholds to use for this gauge.

Parameters:

thres - thresholds array.

See Also:

Threshold

getThresholds

public java.util.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 java.util.List<java.lang.String> getBackgroundColorAsString()

Returns the fill color of the arcs in the dataset as string.

Returns:

list of the fill color of the arcs in the dataset as string.

getBackgroundColor

public java.util.List<IsColor> getBackgroundColor()

Returns the fill color of the arcs in the dataset.

Returns:

list of the fill color of the arcs in the dataset.

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(java.lang.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 java.util.List<java.lang.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 java.util.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.

getBorderWidth

public java.util.List<java.lang.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(java.lang.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 java.util.List<java.lang.String> getHoverBackgroundColorAsString()

Returns the fill color of the arcs when hovered as string

Returns:

list of the fill color of the arcs when hovered as string

getHoverBackgroundColor

public java.util.List<IsColor> getHoverBackgroundColor()

Returns the fill color of the arcs when hovered

Returns:

list of the fill color of the arcs when hovered

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(java.lang.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 java.util.List<java.lang.String> getHoverBorderColorAsString()

Returns the stroke color of the arcs when hovered.

Returns:

list of the stroke color of the arcs when hovered.

getHoverBorderColor

public java.util.List<IsColor> getHoverBorderColor()

Returns the stroke color of the arcs when hovered.

Returns:

list of the stroke color of the arcs when hovered.

getHoverBorderWidth

public java.util.List<java.lang.Integer> getHoverBorderWidth()

Returns the stroke width of the arcs when hovered.

Returns:

list of the stroke width of the arcs when hovered.