org.pepstock.charba.client.configuration

Class CartesianTimeAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianTimeAxis

public class CartesianTimeAxis
extends Axis

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

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
CartesianTimeAxis(AbstractChart<?,?> chart) Builds the object storing the chart instance.
CartesianTimeAxis(AbstractChart<?,?> chart, CartesianAxisType cartesianType) Builds the object storing the chart instance and axis type.

Method Summary

Modifier and Type	Method and Description
ScaleBounds	getBounds() Returns the property controls the scale boundary strategy (bypassed by min/max time options).
CartesianAxisType	getCartesianType() Returns the axis type
AbstractChart<?,?>	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
ScaleDistribution	getDistribution() Returns the property controls the data distribution along the scale.
GridLines	getGrideLines() Returns the grid lines element
String	getId() The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
Position	getPosition() Position of the axis in the chart.
CartesianScaleLabel	getScaleLabel() Returns the scale label element
CartesianTimeTick	getTicks() Returns the ticks element
Time	getTime() Returns the time element.
boolean	isOffset() If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
boolean	isStacked() Gets if the axis are stacked or not.
void	setBounds(ScaleBounds bounds) Sets the property controls the scale boundary strategy (bypassed by min/max time options).
protected void	setConfiguration(T configuration)
void	setDistribution(ScaleDistribution distribution) Sets property controls the data distribution along the scale.
void	setId(String id) The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
void	setOffset(boolean offset) If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
void	setPosition(Position position) Position of the axis in the chart.
void	setStacked(boolean stacked) Sets if the axis are stacked or not.
String	toJSON() Returns the JSON representation of the object.

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

getAxisBuildTicksCallback, getAxisCalculateTickRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getType, getWeight, isDisplay, setAxisBuildTicksCallback, setAxisCalculateTickRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setDisplay, setType, setWeight

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CartesianTimeAxis

public CartesianTimeAxis(AbstractChart<?,?> chart)

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

Parameters:

chart - chart instance

CartesianTimeAxis

public CartesianTimeAxis(AbstractChart<?,?> chart,
                         CartesianAxisType cartesianType)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

cartesianType - cartesian axis type.

Method Detail

getTicks

public CartesianTimeTick getTicks()

Returns the ticks element

Returns:

the ticks

getTime

public Time getTime()

Returns the time element.

Returns:

the time

setDistribution

public void setDistribution(ScaleDistribution distribution)

Sets property controls the data distribution along the scale.

Parameters:

distribution - property controls the data distribution along the scale.

getDistribution

public ScaleDistribution getDistribution()

Returns the property controls the data distribution along the scale.

Returns:

property controls the data distribution along the scale.

setBounds

public void setBounds(ScaleBounds bounds)

Sets the property controls the scale boundary strategy (bypassed by min/max time options).

Parameters:

bounds - property controls the scale boundary strategy (bypassed by min/max time options).

getBounds

public ScaleBounds getBounds()

Returns the property controls the scale boundary strategy (bypassed by min/max time options).

Returns:

property controls the scale boundary strategy (bypassed by min/max time options).

getScaleLabel

public CartesianScaleLabel getScaleLabel()

Returns the scale label element

Returns:

the scaleLabel

getGrideLines

public GridLines getGrideLines()

Returns the grid lines element

Returns:

the grideLines

getCartesianType

public CartesianAxisType getCartesianType()

Returns the axis type

Returns:

the cartesianType

setStacked

public void setStacked(boolean stacked)

Sets if the axis are stacked or not.

Parameters:

stacked - if the axis are stacked or not.

isStacked

public boolean isStacked()

Gets if the axis are stacked or not.

Returns:

if the axis are stacked or not.

setOffset

public void setOffset(boolean offset)

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.

Parameters:

offset - extra space of axis

isOffset

public boolean isOffset()

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.

Returns:

extra space of axis.

setId

public void setId(String id)

The ID is used to link datasets and scale axes together.
This is especially needed if multi-axes charts are used.

Parameters:

id - The ID is used to link datasets and scale axes together

getId

public String getId()

The ID is used to link datasets and scale axes together.
This is especially needed if multi-axes charts are used.

Returns:

The ID is used to link datasets and scale axes together

setPosition

public void setPosition(Position position)

Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'

Parameters:

position - position of axis

getPosition

public Position getPosition()

Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'

Returns:

position of axis.

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.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart