org.pepstock.charba.client.impl.charts

Class MeterOptions

java.lang.Object

org.pepstock.charba.client.configuration.EventProvider<ExtendedOptions>

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.AbstractPieOptions

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

All Implemented Interfaces:

EventHandler, ConfigurationElement, AddHandlerEventHandler, RemoveHandlerEventHandler

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
static String	DEFAULT_FORMAT Default format "##0" to apply displaying the value or percentage

Constructor Summary

Constructors

Constructor and Description
MeterOptions(AbstractChart<?,?> chart, ChartOptions defaultValues) Builds the object storing the chart instance and defaults.

Method Summary

Modifier and Type	Method and Description
AbstractChart<?,?>	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 the hover element.
Layout	getLayout() Returns the layout element.
Legend	getLegend() Returns the legend element.
Tooltips	getTooltips() Returns the tooltips element.
boolean	isAnimatedDisplay() Returns if the display will be shown based on the animation of chart.
void	setAnimatedDisplay(boolean animatedDisplay) Sets if the display will be shown based on the animation of chart.
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) Sets the legend callback instance
String	toJSON() Returns the JSON representation of the object.

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

getCircumference, getCutoutPercentage, getRotation, setCircumference, setRotation

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

addHandler, getAnimation, getAspectRatio, getDevicePixelRatio, getElements, getEvents, getLegendCallback, getPlugins, getResponsiveAnimationDuration, getTitle, hasDatasetSelectionHandlers, isMaintainAspectRatio, isResponsive, load, removeHandler, setAspectRatio, setDevicePixelRatio, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration

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

onAdd, onRemove

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 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

Constructor Detail

MeterOptions

public MeterOptions(AbstractChart<?,?> chart,
                    ChartOptions defaultValues)

Builds the object storing the chart instance and defaults.

Parameters:

chart - chart instance

defaultValues - defaults of chart

Method Detail

setCutoutPercentage

public 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.

getHover

public Hover getHover()

Description copied from class: ConfigurationOptions

Returns the hover element.

Overrides:

getHover in class ConfigurationOptions

Returns:

the hover

getLayout

public final Layout getLayout()

Description copied from class: ConfigurationOptions

Returns the layout element.

Overrides:

getLayout in class ConfigurationOptions

Returns:

the layout

getLegend

public final Legend getLegend()

Description copied from class: ConfigurationOptions

Returns the legend element.

Overrides:

getLegend in class ConfigurationOptions

Returns:

the legend

getTooltips

public final Tooltips getTooltips()

Description copied from class: ConfigurationOptions

Returns the tooltips element.

Overrides:

getTooltips in class ConfigurationOptions

Returns:

the tooltips

setLegendCallback

public final void setLegendCallback(LegendCallback legendCallback)

Description copied from class: ConfigurationOptions

Sets the legend callback instance

Overrides:

setLegendCallback in class ConfigurationOptions

Parameters:

legendCallback - the legendCallBack to set

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

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.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart