Package 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, AddHandlerEventHandler, EventHandler, RemoveHandlerEventHandler

Direct Known Subclasses:

GaugeOptions

public class MeterOptions
extends AbstractPieOptions

Specific options for METER chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	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.
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.
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	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

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

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

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.

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.

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