org.pepstock.charba.client.configuration

Class CartesianTimeSeriesAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

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

org.pepstock.charba.client.configuration.CartesianTimeAxis

org.pepstock.charba.client.configuration.CartesianTimeSeriesAxis

public class CartesianTimeSeriesAxis
extends CartesianTimeAxis

This object is used to map defined axis as time series. This is used to have time series charts.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
CartesianTimeSeriesAxis(IsChart chart) Builds the object storing the chart instance.
CartesianTimeSeriesAxis(IsChart chart, AxisKind kind) Builds the object storing the chart instance and axis type.
CartesianTimeSeriesAxis(IsChart chart, ScaleId id) Builds the object storing the chart instance.
CartesianTimeSeriesAxis(IsChart chart, ScaleId id, AxisKind kind) Builds the object storing the chart instance and axis type.
CartesianTimeSeriesAxis(IsChart chart, String id) Builds the object storing the chart instance.
CartesianTimeSeriesAxis(IsChart chart, String id, AxisKind kind) Builds the object storing the chart instance and axis type.

Method Summary

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

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

getAdapters, getMax, getMin, getTicks, getTime, setMax, setMin

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

getBounds, getGrid, getPosition, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setOffset, setPosition, setSingleStacked, setStacked

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

getAxis, getAxisBuildTicksCallback, getAxisCalculateTickRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getCharbaId, getDisplay, getId, getType, getWeight, isAlignToPixels, isReverse, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateTickRotationCallback, 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

Constructor Detail

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(IsChart chart)

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

Parameters:

chart - chart instance

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(IsChart chart,
                               String id)

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

Parameters:

chart - chart instance

id - axis id

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(IsChart chart,
                               ScaleId id)

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

Parameters:

chart - chart instance

id - axis id

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(IsChart chart,
                               AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

kind - axis kind

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(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

CartesianTimeSeriesAxis

public CartesianTimeSeriesAxis(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

Method Detail

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