org.pepstock.charba.client.options

Class Scales

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<Options,IsDefaultScales>

org.pepstock.charba.client.options.Scales

All Implemented Interfaces:

IsDefaultScales

public class Scales
extends AbstractModel<Options,IsDefaultScales>
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
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.
boolean	isDisplay() Returns if the scales are shown.
void	setDisplay(boolean display) Sets if the scales are shown.
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.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

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

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)

Sets if the scales are shown.

Parameters:

display - true if the scales are shown.

isDisplay

public boolean isDisplay()

Returns if the scales are shown.

Specified by:

isDisplay in interface IsDefaultScales

Returns:

true if the scales are shown.

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.