org.pepstock.charba.client.impl.charts

Class MeterOptions

java.lang.Object

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.AbstractPieOptions

org.pepstock.charba.client.impl.charts.MeterOptions

All Implemented Interfaces:

ConfigurationElement

Direct Known Subclasses:

GaugeOptions

public class MeterOptions
extends AbstractPieOptions

Specific options for METER chart. This chart doesn't allow any legend, hover, layout and tooltips components.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_DISPLAY_COLOR Default color of display, rgb(128, 128, 128)
static String	DEFAULT_FORMAT Default number format "##0" to apply displaying the value or percentage.

Constructor Summary

Constructors

Constructor and Description
MeterOptions(IsChart chart, ChartOptions defaultValues) Builds the object storing the chart instance and defaults.

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
MeterDisplay	getDisplay() Returns the display type of data in chart.
IsColor	getDisplayFontColor() Returns the font color to apply to the display of value.
String	getFontFamily() Returns the font family to apply to the display of value.
FontStyle	getFontStyle() Returns the font style to apply to the display of value.
String	getFormat() Sets the format to apply to display the value.
Hover	getHover() Returns nothing but throws an exception because not available.
Layout	getLayout() Returns nothing but throws an exception because not available.
Legend	getLegend() Returns nothing but throws an exception because not available.
Tooltips	getTooltips() Returns nothing but throws an exception because not available.
boolean	isAnimatedDisplay() Returns if the display will be shown based on the animation of chart.
void	merge(NativeObjectContainer source, String property) Merge a native object into this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
static void	register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider) Adds the event provider implementation as handlers of chart.
void	setAnimatedDisplay(boolean animatedDisplay) Sets if the display will be shown based on the animation of chart.
void	setCircumference(double circumference) Sets the sweep to allow arcs to cover.
protected void	setConfiguration(T configuration)
void	setCutoutPercentage(double cutoutPercentage) Sets the percentage of the chart that is cut out of the middle.
void	setDisplay(MeterDisplay display) Sets the display type of data in chart.
void	setDisplayFontColor(IsColor displayFontColor) Sets the font color to apply to the display of value.
void	setFontFamily(String fontFamily) Sets the font family to apply to the display of value.
void	setFontStyle(FontStyle fontStyle) Sets the font style to apply to the display of value.
void	setFormat(String format) Sets the format to apply to display the value.
void	setLegendCallback(LegendCallback legendCallback) Throws an exception because not available.
void	setRotation(double rotation) Sets the starting angle to draw arcs from.
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.AbstractPieOptions

getCircumference, getCutoutPercentage, getRotation

Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions

getAnimation, getAspectRatio, getDevicePixelRatio, getElements, getEvents, getLegendCallback, getPlugins, getResponsiveAnimationDuration, getTitle, hasAxisClickHandlers, hasDatasetSelectionHandlers, hasTitleClickHandlers, isMaintainAspectRatio, isResponsive, load, onAdd, onRemove, setAspectRatio, setDevicePixelRatio, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

Default number format "##0" to apply displaying the value or percentage.

See Also:

Constant Field Values

DEFAULT_DISPLAY_COLOR

public static final IsColor DEFAULT_DISPLAY_COLOR

Default color of display, rgb(128, 128, 128)

Constructor Detail

MeterOptions

public MeterOptions(IsChart chart,
                    ChartOptions defaultValues)

Builds the object storing the chart instance and defaults.

Parameters:

chart - chart instance

defaultValues - defaults of chart

Method Detail

setCutoutPercentage

public final void setCutoutPercentage(double cutoutPercentage)

Description copied from class: AbstractPieOptions

Sets the percentage of the chart that is cut out of the middle.

Overrides:

setCutoutPercentage in class AbstractPieOptions

Parameters:

cutoutPercentage - the percentage of the chart that is cut out of the middle.

setRotation

public final void setRotation(double rotation)

Description copied from class: AbstractPieOptions

Sets the starting angle to draw arcs from.

Overrides:

setRotation in class AbstractPieOptions

Parameters:

rotation - starting angle to draw arcs from.

setCircumference

public final void setCircumference(double circumference)

Description copied from class: AbstractPieOptions

Sets the sweep to allow arcs to cover.

Overrides:

setCircumference in class AbstractPieOptions

Parameters:

circumference - the sweep to allow arcs to cover.

getHover

public final Hover getHover()

Returns nothing but throws an exception because not available.

Overrides:

getHover in class ConfigurationOptions

Returns:

nothing because will throw an exception

getLayout

public final Layout getLayout()

Returns nothing but throws an exception because not available.

Overrides:

getLayout in class ConfigurationOptions

Returns:

nothing because will throw an exception

getLegend

public final Legend getLegend()

Returns nothing but throws an exception because not available.

Overrides:

getLegend in class ConfigurationOptions

Returns:

nothing because will throw an exception

getTooltips

public final Tooltips getTooltips()

Returns nothing but throws an exception because not available.

Overrides:

getTooltips in class ConfigurationOptions

Returns:

nothing because will throw an exception

setLegendCallback

public final void setLegendCallback(LegendCallback legendCallback)

Throws an exception because not available.

Overrides:

setLegendCallback in class ConfigurationOptions

Parameters:

legendCallback - ignored because will throw an exception

getDisplay

public final MeterDisplay getDisplay()

Returns the display type of data in chart.

Returns:

the display type of data in chart.

setDisplay

public final void setDisplay(MeterDisplay display)

Sets the display type of data in chart.

Parameters:

display - the display to set

getFormat

public final String getFormat()

Sets the format to apply to display the value.

Returns:

the format to apply to the value in chart.

setFormat

public final void setFormat(String format)

Sets the format to apply to display the value.

Parameters:

format - the format to set

getFontFamily

public final String getFontFamily()

Returns the font family to apply to the display of value.

Returns:

the fontFamily to apply to the display of value.

setFontFamily

public final void setFontFamily(String fontFamily)

Sets the font family to apply to the display of value.

Parameters:

fontFamily - the fontFamily to set

getFontStyle

public final FontStyle getFontStyle()

Returns the font style to apply to the display of value.

Returns:

the fontStyle to apply to the display of value.

setFontStyle

public final void setFontStyle(FontStyle fontStyle)

Sets the font style to apply to the display of value.

Parameters:

fontStyle - the fontStyle to set

getDisplayFontColor

public final IsColor getDisplayFontColor()

Returns the font color to apply to the display of value.

Returns:

the displayFontColor

setDisplayFontColor

public final void setDisplayFontColor(IsColor displayFontColor)

Sets the font color to apply to the display of value.

Parameters:

displayFontColor - the displayFontColor to set

isAnimatedDisplay

public final boolean isAnimatedDisplay()

Returns if the display will be shown based on the animation of chart.

Returns:

the animatedDisplay, true if animated, otherwise false. Default is false.

setAnimatedDisplay

public final void setAnimatedDisplay(boolean animatedDisplay)

Sets if the display will be shown based on the animation of chart.

Parameters:

animatedDisplay - the animatedDisplay to set, true if animated, otherwise false

register

public static void register(IsChart chart,
                            org.pepstock.charba.client.configuration.IsEventProvider provider)

Adds the event provider implementation as handlers of chart.

Parameters:

chart - chart instance

provider - event provider implmentation

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

merge

public final void merge(NativeObjectContainer source,
                        String property)

Merge a native object into this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.

Parameters:

source - native object container to add

property - property name

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart