org.pepstock.charba.client.options

Class ScaledOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Options

org.pepstock.charba.client.options.ScaledOptions

All Implemented Interfaces:

IsDefaultOptions, IsDefaultScaledOptions

Direct Known Subclasses:

ChartOptions, ExtendedOptions, OptionsNode

public abstract class ScaledOptions
extends Options
implements IsDefaultScaledOptions

Base object which maps chart options, with scales elements to set axes configurations.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScaledOptions(IsDefaultScaledOptions defaultValues) Creates the object only with default provider.
protected	ScaledOptions(IsDefaultScaledOptions defaultValues, NativeObject nativeObject) Creates the object only with default provider and native object.

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
Scale	getScale() Returns the scale/axis defaults.
Scales	getScales() Returns the scale/axis defaults.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.
void	setScale(Scale scale) Sets a scale instance for options.

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

getAnimation, getAspectRatio, getCharbaId, getCircumference, getCutoutPercentage, getDefaultColor, getDefaultColorAsString, getDefaultFontColor, getDefaultFontColorAsString, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyle, getDefaultLineHeight, getDevicePixelRatio, getElements, getEvents, getHover, getLayout, getLegend, getPlugins, getResponsiveAnimationDuration, getRotation, getStartAngle, getTitle, getTooltips, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, isShowLines, isSpanGaps, setAspectRatio, setCircumference, setCutoutPercentage, setDefaultColor, setDefaultColor, setDefaultFontColor, setDefaultFontColor, setDefaultFontFamily, setDefaultFontSize, setDefaultFontStyle, setDefaultLineHeight, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration, setRotation, setShowLines, setSpanGaps, setStartAngle

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

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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.defaults.IsDefaultOptions

getAnimation, getAspectRatio, getCircumference, getCutoutPercentage, getDefaultColorAsString, getDefaultFontColorAsString, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyle, getDefaultLineHeight, getDevicePixelRatio, getElements, getHover, getLayout, getLegend, getPlugins, getResponsiveAnimationDuration, getRotation, getStartAngle, getTitle, getTooltips, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, isShowLines, isSpanGaps

Constructor Detail

ScaledOptions

protected ScaledOptions(IsDefaultScaledOptions defaultValues)

Creates the object only with default provider. This is used as the root element.
New native java script object is created and it's empty.

Parameters:

defaultValues - default provider instance.

ScaledOptions

protected ScaledOptions(IsDefaultScaledOptions defaultValues,
                        NativeObject nativeObject)

Creates the object only with default provider and native object. This is used as the root element.

Parameters:

defaultValues - default provider instance.

nativeObject - native object to store properties.

Method Detail

setScale

public final void setScale(Scale scale)

Sets a scale instance for options.

Parameters:

scale - the scale to set

getScale

public Scale getScale()

Description copied from interface: IsDefaultScaledOptions

Returns the scale/axis defaults.

Specified by:

getScale in interface IsDefaultScaledOptions

Returns:

the scale/axis defaults.

getScales

public Scales getScales()

Description copied from interface: IsDefaultScaledOptions

Returns the scale/axis defaults.

Specified by:

getScales in interface IsDefaultScaledOptions

Returns:

the scale/axis defaults.

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.