org.pepstock.charba.client.configuration

Class CartesianLinearAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianAxis<CartesianLinearTick>

org.pepstock.charba.client.configuration.CartesianLinearAxis

All Implemented Interfaces:

IsLinearAxis, IsNumericAxis

Direct Known Subclasses:

ColorAxis, SizeAxis

public class CartesianLinearAxis
extends CartesianAxis<CartesianLinearTick>
implements IsLinearAxis

This object is used to map defined axis as linear.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
	CartesianLinearAxis(IsChart chart) Builds the object storing the chart instance.
	CartesianLinearAxis(IsChart chart, AxisKind kind) Builds the object storing the chart instance and axis type.
	CartesianLinearAxis(IsChart chart, ScaleId id) Builds the object storing the chart instance.
	CartesianLinearAxis(IsChart chart, ScaleId id, AxisKind kind) Builds the object storing the chart instance and axis type.
protected	CartesianLinearAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind) Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.
	CartesianLinearAxis(IsChart chart, String id) Builds the object storing the chart instance.
	CartesianLinearAxis(IsChart chart, String id, AxisKind kind) Builds the object storing the chart instance and axis type.

Method Summary

Modifier and Type	Method and Description
Axis	getAxisElement() Returns the axis instance.
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
int	getGrace() Returns the value in pixels is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
String	getGraceAsPercentage() Returns the value in percentage is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
CartesianLinearTick	getTicks() Returns the ticks 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.
protected void	setConfiguration(T configuration)
void	setGrace(int grace) Sets the value in pixels is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
void	setGraceAsPercentage(String grace) Sets the value in percentage is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
String	toJSON() Returns the JSON representation of the object.

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

getBounds, getGrid, getPosition, getStack, getStackWeight, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setOffset, setPosition, setSingleStacked, setStack, setStacked, setStackWeight

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

getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getCharbaId, getDisplay, getId, getType, getWeight, isAlignToPixels, isReverse, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setReverse, setWeight

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.IsLinearAxis

isBeginAtZero, setBeginAtZero

Methods inherited from interface org.pepstock.charba.client.configuration.IsNumericAxis

getMax, getMin, getSuggestedMax, getSuggestedMin, setMax, setMin, setSuggestedMax, setSuggestedMin

Constructor Detail

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           String id)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

id - axis id

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           ScaleId id)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

id - axis id

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

kind - axis kind.

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           String id,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           ScaleId id,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianLinearAxis

protected CartesianLinearAxis(IsChart chart,
                              ScaleId id,
                              AxisType type,
                              AxisKind kind)

Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.

Parameters:

chart - chart instance

id - axis id

type - axis type

kind - axis kind

Method Detail

getAxisElement

public final Axis getAxisElement()

Description copied from interface: IsNumericAxis

Returns the axis instance.

Specified by:

getAxisElement in interface IsNumericAxis

Returns:

the axis

getTicks

public CartesianLinearTick getTicks()

Description copied from class: CartesianAxis

Returns the ticks element

Specified by:

getTicks in class CartesianAxis<CartesianLinearTick>

Returns:

the ticks

setGrace

public void setGrace(int grace)

Sets the value in pixels is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Parameters:

grace - the value in pixels is added to the maximum data value and subtracted from the minimum data

getGrace

public int getGrace()

Returns the value in pixels is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Returns:

the value in pixels is added to the maximum data value and subtracted from the minimum data

setGraceAsPercentage

public void setGraceAsPercentage(String grace)

Sets the value in percentage is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Parameters:

grace - the value in percentage is added to the maximum data value and subtracted from the minimum data

getGraceAsPercentage

public String getGraceAsPercentage()

Returns the value in percentage is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Returns:

the value in percentage is added to the maximum data value and subtracted from the minimum data

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