org.pepstock.charba.client.impl.charts

Class GaugeOptions

java.lang.Object

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.AbstractPieOptions

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

org.pepstock.charba.client.impl.charts.GaugeOptions

All Implemented Interfaces:

ConfigurationElement

public final class GaugeOptions
extends MeterOptions

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

Author:

Andrea "Stock" Stocchero

Field Summary

Fields inherited from class org.pepstock.charba.client.impl.charts.MeterOptions

DEFAULT_DISPLAY_COLOR, DEFAULT_FORMAT

Constructor Summary

Constructors

Constructor and Description
GaugeOptions(IsChart chart, IsDefaultScaledOptions 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.
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.
protected void	setConfiguration(T configuration)
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.impl.charts.MeterOptions

getDisplay, getDisplayFontColor, getFontFamily, getFontStyle, getFormat, getHover, getLayout, getLegend, getTooltips, isAnimatedDisplay, setAnimatedDisplay, setCircumference, setCutoutPercentage, setDisplay, setDisplayFontColor, setFontFamily, setFontStyle, setFormat, setLegendCallback, setRotation

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, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration

Methods inherited from class java.lang.Object

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

Constructor Detail

GaugeOptions

public GaugeOptions(IsChart chart,
                    IsDefaultScaledOptions defaultValues)

Builds the object storing the chart instance and defaults.

Parameters:

chart - chart instance

defaultValues - defaults of chart

Method Detail

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