org.pepstock.charba.client.configuration

Class StackedOptions

java.lang.Object

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.ScalesOptions

org.pepstock.charba.client.configuration.StackedOptions

All Implemented Interfaces:

HasAnimation, ConfigurationElement

public class StackedOptions
extends ScalesOptions

Configuration of chart which could be stacked.
It uses Category axis for X axis and Linear for Y axis.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
StackedOptions(IsChart chart, IsDefaultScaledOptions defaultValues) Builds the object storing the chart instance and default values.
StackedOptions(IsChart chart, IsDefaultScaledOptions defaultValues, boolean onlyYScaled) Builds the object storing the chart instance, default values and if only Y axis is scaled.

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
Scales	getScales() Returns the scales element.
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.
protected void	setConfiguration(T configuration)
String	toJSON() Returns the JSON representation of the object.

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

getAxisById

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

Constructor Detail

StackedOptions

public StackedOptions(IsChart chart,
                      IsDefaultScaledOptions defaultValues,
                      boolean onlyYScaled)

Builds the object storing the chart instance, default values and if only Y axis is scaled.

Parameters:

chart - chart instance

defaultValues - defaults options of stacked chart

onlyYScaled - true if only Y axis is scaled.

StackedOptions

public StackedOptions(IsChart chart,
                      IsDefaultScaledOptions defaultValues)

Builds the object storing the chart instance and default values.

Parameters:

chart - chart instance

defaultValues - defaults options of bar chart

Method Detail

getScales

public Scales getScales()

Description copied from class: ScalesOptions

Returns the scales element.

Overrides:

getScales in class ScalesOptions

Returns:

the scales

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