org.pepstock.charba.client.options

Class Scales

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Scales

All Implemented Interfaces:

IsDefaultScales

public final class Scales
extends NativeObjectContainer
implements IsDefaultScales

The configuration element which contains all axes definitions.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SINGLE_AXIS_ID Default name of axis when the chart has got only 1 scale (polar, radar) is "scale".
static String	DEFAULT_X_AXIS_ID Default name of X axis is "x-axis-0".
static String	DEFAULT_Y_AXIS_ID Default name of Y axis is "y-axis-0".

Constructor Summary

Constructors

Constructor and Description
Scales(IsDefaultScales defaultValues) Creates a scales object by defaults values.

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.
Display	getDisplay() The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
protected P	getParent() Returns the parent element.
List<Scale>	getXAxes() Returns a list of X axes.
IsDefaultScale	getXAxis() Returns the default configuration for x axis.
List<Scale>	getYAxes() Returns a list of Y axes.
IsDefaultScale	getYAxis() Returns the default configuration for y axis.
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.
void	setDisplay(boolean display) If true, shows the axis.
void	setDisplay(Display display) The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
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	setXAxes(Scale... scales) Sets all X axes of chart.
void	setYAxes(Scale... scales) Sets all Y axes of chart.

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

checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

Field Detail

DEFAULT_X_AXIS_ID

public static final String DEFAULT_X_AXIS_ID

Default name of X axis is "x-axis-0".

See Also:

Constant Field Values

DEFAULT_Y_AXIS_ID

public static final String DEFAULT_Y_AXIS_ID

Default name of Y axis is "y-axis-0".

See Also:

Constant Field Values

DEFAULT_SINGLE_AXIS_ID

public static final String DEFAULT_SINGLE_AXIS_ID

Default name of axis when the chart has got only 1 scale (polar, radar) is "scale".

See Also:

Constant Field Values

Constructor Detail

Scales

public Scales(IsDefaultScales defaultValues)

Creates a scales object by defaults values. This method is creating the root element of scales.

Parameters:

defaultValues - default values of scales

Method Detail

setDisplay

public void setDisplay(boolean display)

If true, shows the axis.

Parameters:

display - if true, shows the axes.

setDisplay

public void setDisplay(Display display)

The display option controls the visibility of axis.
Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Parameters:

display - display option controls the visibility of axis

getDisplay

public Display getDisplay()

The display option controls the visibility of axis.
Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Specified by:

getDisplay in interface IsDefaultScales

Returns:

display option controls the visibility of axis

setXAxes

public void setXAxes(Scale... scales)

Sets all X axes of chart.

Parameters:

scales - array of axes.

getXAxes

public List<Scale> getXAxes()

Returns a list of X axes.

Returns:

a list of X axes.

setYAxes

public void setYAxes(Scale... scales)

Sets all Y axes of chart.

Parameters:

scales - array of axes.

getYAxes

public List<Scale> getYAxes()

Returns a list of Y axes.

Returns:

a list of Y axes.

getXAxis

public IsDefaultScale getXAxis()

Description copied from interface: IsDefaultScales

Returns the default configuration for x axis.

Specified by:

getXAxis in interface IsDefaultScales

Returns:

the default configuration for x axis.

getYAxis

public IsDefaultScale getYAxis()

Description copied from interface: IsDefaultScales

Returns the default configuration for y axis.

Specified by:

getYAxis in interface IsDefaultScales

Returns:

the default configuration for y axis.

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.