org.pepstock.charba.client.options

Class MeterOptions

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.commons.EventProvider

org.pepstock.charba.client.options.BaseOptions

org.pepstock.charba.client.options.MeterOptions

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

Direct Known Subclasses:

GaugeOptions

public class MeterOptions
extends BaseOptions

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 java.lang.String	DEFAULT_FORMAT Default format to apply displaying the value or percentage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
double	getCircumference() Returns the the sweep to allow arcs to cover.
double	getCutoutPercentage() Returns the the percentage of the chart that is cut out of the middle.
MeterDisplay	getDisplay()
IsColor	getDisplayFontColor()
java.lang.String	getFontFamily()
FontStyle	getFontStyle()
java.lang.String	getFormat()
Hover	getHover()
Layout	getLayout()
Legend	getLegend()
double	getRotation() returns the starting angle to draw arcs from.
Tooltips	getTooltips()
void	setCircumference(double circumference) Sets the sweep to allow arcs to cover.
void	setCutoutPercentage(double cutoutPercentage) Sets the percentage of the chart that is cut out of the middle.
void	setDisplay(MeterDisplay display)
void	setDisplayFontColor(IsColor displayFontColor)
void	setFontFamily(java.lang.String fontFamily)
void	setFontStyle(FontStyle fontStyle)
void	setFormat(java.lang.String format)
void	setLegendCallBack(LegendCallback legendCallBack)
void	setRotation(double rotation) Sets the starting angle to draw arcs from.

Methods inherited from class org.pepstock.charba.client.options.BaseOptions

addHandler, generateLegend, getAnimation, getDevicePixelRatio, getElements, getEvents, getLegendCallBack, getPlugins, getResponsiveAnimationDuration, getTitle, isAnimationEnable, isMaintainAspectRatio, isResponsive, onClick, onHover, onItemClick, onResize, removeHandler, setAnimationEnabled, setDevicePixelRatio, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration

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

onAdd, onRemove

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

getChart

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

Field Detail

DEFAULT_FORMAT

public static final java.lang.String DEFAULT_FORMAT

Default format 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)

Builds the object storing the chart instance.

Parameters:

chart - chart instance

Method Detail

setCutoutPercentage

public void setCutoutPercentage(double cutoutPercentage)

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

Parameters:

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

getHover

public Hover getHover()

Overrides:

getHover in class BaseOptions

Returns:

the hover

getLayout

public Layout getLayout()

Overrides:

getLayout in class BaseOptions

Returns:

the layout

getLegend

public Legend getLegend()

Overrides:

getLegend in class BaseOptions

Returns:

the legend

getTooltips

public Tooltips getTooltips()

Overrides:

getTooltips in class BaseOptions

Returns:

the tooltip

setLegendCallBack

public void setLegendCallBack(LegendCallback legendCallBack)

Overrides:

setLegendCallBack in class BaseOptions

Parameters:

legendCallBack - the legendCallBack to set

getDisplay

public MeterDisplay getDisplay()

Returns:

the display

setDisplay

public void setDisplay(MeterDisplay display)

Parameters:

display - the display to set

getFormat

public java.lang.String getFormat()

Returns:

the format

setFormat

public void setFormat(java.lang.String format)

Parameters:

format - the format to set

getFontFamily

public java.lang.String getFontFamily()

Returns:

the fontFamily

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Parameters:

fontFamily - the fontFamily to set

getFontStyle

public FontStyle getFontStyle()

Returns:

the fontStyle

setFontStyle

public void setFontStyle(FontStyle fontStyle)

Parameters:

fontStyle - the fontStyle to set

getDisplayFontColor

public IsColor getDisplayFontColor()

Returns:

the displayFontColor

setDisplayFontColor

public void setDisplayFontColor(IsColor displayFontColor)

Parameters:

displayFontColor - the displayFontColor to set

getCutoutPercentage

public double getCutoutPercentage()

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

Returns:

the percentage of the chart that is cut out of the middle. Default is Options.getCutoutPercentage().

setRotation

public void setRotation(double rotation)

Sets the starting angle to draw arcs from.

Parameters:

rotation - starting angle to draw arcs from.

getRotation

public double getRotation()

returns the starting angle to draw arcs from.

Returns:

starting angle to draw arcs from. Default is Options.getRotation().

setCircumference

public void setCircumference(double circumference)

Sets the sweep to allow arcs to cover.

Parameters:

circumference - the sweep to allow arcs to cover.

getCircumference

public double getCircumference()

Returns the the sweep to allow arcs to cover.

Returns:

the sweep to allow arcs to cover. Default is Options.getCircumference().