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:

HasAnimation, ConfigurationElement

Direct Known Subclasses:

GaugeOptions

public class MeterOptions
extends AbstractPieOptions

Specific options for METER chart.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_FONT_COLOR Default color of render, rgb(128, 128, 128)
static int	DEFAULT_PRECISION Default precision 2 to apply rendering the value or percentage.

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
double	getCutout() Returns the portion of the chart that is cut out of the middle. As Double, it is considered to be pixels.
IsColor	getFontColor() Returns the font color to apply to the render of value.
ColorCallback<MeterContext>	getFontColorCallback() Returns the callback to customize the font color for rendered label in the chart.
MeterFormatCallback	getFormatCallback() Returns the callback to customize the value string in the chart.
int	getPrecision() Returns the decimal places to apply to render the value.
Render	getRender() Returns the render type of data in chart.
boolean	isAnimated() Returns if the render will be shown based on the animation of chart.
boolean	isAutoFontSize() Returns true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering.
ChartEnvelop<NativeObject>	loadNativeObject(ChartEnvelop<NativeObject> envelop) Returns the native object instance inside an envelop. It can be called only from org.pepstock.charba.client package.
void	merge(NativeObjectContainer source, String property) Merge a native object in the 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 in the 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	setAnimated(boolean animated) Sets if the render will be shown based on the animation of chart.
void	setAutoFontSize(boolean autoFontSize) Sets true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering.
void	setCircumference(double circumference) Sets the sweep to allow arcs to cover.
protected void	setConfiguration(T configuration)
void	setCutout(double cutout) Sets the portion of the chart that is cut out of the middle. As Double, it is considered to be pixels.
void	setCutoutPercentage(String cutout) Sets the portion of the chart that is cut out of the middle. As String and ending with '%', percentage of the chart radius.
void	setFontColor(ColorCallback<MeterContext> fontColorCallback) Sets the callback to customize the font color for rendered label in the chart.
void	setFontColor(IsColor fontColor) Sets the font color to apply to the render of value.
void	setFormatCallback(MeterFormatCallback formatCallback) Sets the callback to customize the value string in the chart.
void	setPrecision(int precision) Sets the decimal places to apply to render the value.
void	setRender(Render render) Sets the render type of data in chart.
String	toJSON() Returns the JSON representation of the object.

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

getAxisById, getCircumference, getCutoutPercentage, getRadius, getRadiusPercentage, getRotation, setRadius, setRadiusPercentage, setRotation

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

afterAxisConfigurationUpdate, afterConfigurationUpdate, beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, getElements, getEvents, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getLocale, getPlugins, getResizeDelay, getSubtitle, getTitle, getTooltips, hasAxisClickHandlers, hasAxisEnterHandlers, hasAxisHoverHandlers, hasAxisLeaveHandlers, hasDatasetSelectionHandlers, hasSubtitleClickHandlers, hasSubtitleEnterHandlers, hasSubtitleLeaveHandlers, hasTitleClickHandlers, hasTitleEnterHandlers, hasTitleLeaveHandlers, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setChartOptions, setColor, setColor, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setLocale, setMaintainAspectRatio, setResizeDelay, setResponsive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.configuration.HasAnimation

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Field Detail

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

Default precision 2 to apply rendering the value or percentage.

See Also:

Constant Field Values

DEFAULT_FONT_COLOR

public static final IsColor DEFAULT_FONT_COLOR

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

Method Detail

setCutoutPercentage

public void setCutoutPercentage(String cutout)

Description copied from class: AbstractPieOptions

Sets the portion of the chart that is cut out of the middle.
As String and ending with '%', percentage of the chart radius.

Overrides:

setCutoutPercentage in class AbstractPieOptions

Parameters:

cutout - the portion of the chart that is cut out of the middle.
As String and ending with '%', percentage of the chart radius.

setCutout

public final void setCutout(double cutout)

Description copied from class: AbstractPieOptions

Sets the portion of the chart that is cut out of the middle.
As Double, it is considered to be pixels.

Overrides:

setCutout in class AbstractPieOptions

Parameters:

cutout - the portion of the chart that is cut out of the middle.
As Double, it is considered to be pixels.

getCutout

public final double getCutout()

Description copied from class: AbstractPieOptions

Returns the portion of the chart that is cut out of the middle.
As Double, it is considered to be pixels.

Overrides:

getCutout in class AbstractPieOptions

Returns:

the portion of the chart that is cut out of the middle.
As Double, it is considered to be pixels.

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.

getRender

public final Render getRender()

Returns the render type of data in chart.

Returns:

the render type of data in chart.

setRender

public final void setRender(Render render)

Sets the render type of data in chart.

Parameters:

render - the render to set

getPrecision

public final int getPrecision()

Returns the decimal places to apply to render the value.

Returns:

the decimal places to apply to the value in chart

setPrecision

public final void setPrecision(int precision)

Sets the decimal places to apply to render the value.

Parameters:

precision - the decimal places to apply to the value in chart

getFontColor

public final IsColor getFontColor()

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

Returns:

the font color to apply to the render of value

setFontColor

public final void setFontColor(IsColor fontColor)

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

Parameters:

fontColor - the displayFontColor to set

isAnimated

public final boolean isAnimated()

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

Returns:

the true the rendering is animated, otherwise false

setAnimated

public final void setAnimated(boolean animated)

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

Parameters:

animated - true if the rendering is animated, otherwise false

isAutoFontSize

public boolean isAutoFontSize()

Returns true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering.

Returns:

true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering

setAutoFontSize

public void setAutoFontSize(boolean autoFontSize)

Sets true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering.

Parameters:

autoFontSize - true if the font size of the rendering will be automatically calculated, based on dimension of the area for rendering

getFormatCallback

public final MeterFormatCallback getFormatCallback()

Returns the callback to customize the value string in the chart.

Returns:

the callback to customize the value string in the chart

setFormatCallback

public final void setFormatCallback(MeterFormatCallback formatCallback)

Sets the callback to customize the value string in the chart.

Parameters:

formatCallback - the callback to customize the value string in the chart

getFontColorCallback

public final ColorCallback<MeterContext> getFontColorCallback()

Returns the callback to customize the font color for rendered label in the chart.

Returns:

the callback to customize the font color for rendered label in the chart

setFontColor

public final void setFontColor(ColorCallback<MeterContext> fontColorCallback)

Sets the callback to customize the font color for rendered label in the chart.

Parameters:

fontColorCallback - the callback to customize the font color for rendered label in the chart

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 in the 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 in the 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.

loadNativeObject

public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)

Returns the native object instance inside an envelop.
It can be called only from org.pepstock.charba.client package.

Parameters:

envelop - envelop instance which will contain the native object

Returns:

the envelop, passed as argument, loaded with the native object

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart