org.pepstock.charba.client.impl.charts

Class MeterDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.impl.charts.MeterDataset

All Implemented Interfaces:

HasDataset

Direct Known Subclasses:

GaugeDataset

public class MeterDataset
extends Dataset

The Meter chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
The minimum value of data is 0 (see MINIMUM_VALUE).
The dataset will have always 2 data and setting the color of data, the first is the value color and the second is the empty one.
To set the data, is mandatory to use setValue(double)) method.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_EMPTY_VALUE_COLOR Default empty color, rgb(234, 234, 234).
static double	DEFAULT_MAXIMUM_VALUE Default maximum value is 100.0.
static IsColor	DEFAULT_VALUE_COLOR Default value color, rgb(140, 214, 16).
static double	MINIMUM_VALUE Minimum value is 0.0.

Constructor Summary

Constructors

Constructor and Description
MeterDataset(double max) Creates a dataset setting the maximum value of dataset.
MeterDataset(double max, IsDefaultOptions defaultValues) Creates a dataset setting the maximum value of dataset and defaults value.

Method Summary

Modifier and Type	Method and Description
protected void	applyGradient(Key key, List<CanvasGradient> canvasGradientsList) Stores the canvas gradients into dataset object by property name passed as key.
protected void	applyPattern(Key key, List<CanvasPattern> canvasPatternsList) Stores the canvas patterns into dataset object by property name passed as key.
IsColor	getColor() Returns the fill color for value.
String	getColorAsString() Returns the fill color for value.
IsColor	getEmptyColor() Returns the fill color for empty sector.
String	getEmptyColorAsString() Returns the fill color for empty sector.
double	getMax() Returns the maximum value of chart.
double	getValue() Returns the value of the chart.
void	setColor(IsColor valueColor) Sets the fill color for value.
void	setColor(String valueColor) Sets the fill color for value.
void	setData(double... values) Throws an exception because not available.
void	setData(List<Double> values) Throws an exception because not available.
void	setEmptyColor(IsColor emptyValueColor) Sets the fill color for empty sector.
void	setEmptyColor(String emptyValueColor) Sets the fill color for empty sector.
void	setHidden(boolean hidden) Sets if the dataset will appear or not.
void	setType(Type type) Sets the type of dataset based on type of chart.
void	setValue(double value)

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

getBackgroundColorCallback, getBorderColorCallback, getBorderWidthCallback, getData, getData, getDataset, getDataType, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultValues, getId, getLabel, getOptions, getType, hasOptions, isHidden, setBackgroundColor, setBorderColor, setBorderWidth, setLabel, setOptions

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

Field Detail

DEFAULT_VALUE_COLOR

public static final IsColor DEFAULT_VALUE_COLOR

Default value color, rgb(140, 214, 16).

DEFAULT_EMPTY_VALUE_COLOR

public static final IsColor DEFAULT_EMPTY_VALUE_COLOR

Default empty color, rgb(234, 234, 234).

DEFAULT_MAXIMUM_VALUE

public static final double DEFAULT_MAXIMUM_VALUE

Default maximum value is 100.0.

See Also:

Constant Field Values

MINIMUM_VALUE

public static final double MINIMUM_VALUE

Minimum value is 0.0.

See Also:

Constant Field Values

Constructor Detail

MeterDataset

public MeterDataset(double max)

Creates a dataset setting the maximum value of dataset. It uses the global options has default.

Parameters:

max - maximum value of dataset.

MeterDataset

public MeterDataset(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

setColor

public void setColor(IsColor valueColor)

Sets the fill color for value.

Parameters:

valueColor - the fill color for value.

setColor

public void setColor(String valueColor)

Sets the fill color for value.

Parameters:

valueColor - the fill color for value.

getColorAsString

public String getColorAsString()

Returns the fill color for value.

Returns:

the fill color for value.

getColor

public IsColor getColor()

Returns the fill color for value.

Returns:

the fill color for value.

setEmptyColor

public void setEmptyColor(IsColor emptyValueColor)

Sets the fill color for empty sector.

Parameters:

emptyValueColor - the fill color for empty sector.

setEmptyColor

public void setEmptyColor(String emptyValueColor)

Sets the fill color for empty sector.

Parameters:

emptyValueColor - the fill color for empty sector.

getEmptyColorAsString

public String getEmptyColorAsString()

Returns the fill color for empty sector.

Returns:

the fill color for empty sector.

getEmptyColor

public IsColor getEmptyColor()

Returns the fill color for empty sector.

Returns:

the fill color for empty sector.

getMax

public final double getMax()

Returns the maximum value of chart.

Returns:

the max

getValue

public final double getValue()

Returns the value of the chart.

Returns:

the value

setValue

public void setValue(double value)

Parameters:

value - the value to set

setType

public void setType(Type type)

Description copied from class: Dataset

Sets the type of dataset based on type of chart.

Overrides:

setType in class Dataset

Parameters:

type - type of dataset.

setHidden

public final void setHidden(boolean hidden)

Description copied from class: Dataset

Sets if the dataset will appear or not.

Overrides:

setHidden in class Dataset

Parameters:

hidden - if the dataset will appear or not.

setData

public final void setData(double... values)

Throws an exception because not available.

Overrides:

setData in class Dataset

Parameters:

values - ignored because will throw an exception

setData

public final void setData(List<Double> values)

Throws an exception because not available.

Overrides:

setData in class Dataset

Parameters:

values - ignored because will throw an exception

applyPattern

protected final void applyPattern(Key key,
                                  List<CanvasPattern> canvasPatternsList)

Description copied from class: Dataset

Stores the canvas patterns into dataset object by property name passed as key.

Specified by:

applyPattern in class Dataset

Parameters:

key - key property name to use to store canvas patterns into dataset object.

canvasPatternsList - list of canvas patterns

applyGradient

protected final void applyGradient(Key key,
                                   List<CanvasGradient> canvasGradientsList)

Description copied from class: Dataset

Stores the canvas gradients into dataset object by property name passed as key.

Specified by:

applyGradient in class Dataset

Parameters:

key - key property name to use to store canvas gradients into dataset object.

canvasGradientsList - list of canvas gradients