org.pepstock.charba.client.options.scales

Class CartesianTimeAxis

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.scales.Axis

org.pepstock.charba.client.options.scales.CartesianTimeAxis

public final class CartesianTimeAxis
extends Axis

This object is used to map defined axis as time.

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()
ScaleDistribution	getDistribution() Returns the property controls the data distribution along the scale.
GridLines	getGrideLines()
java.lang.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()
T	getTicks()
Time	getTime()
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()
void	setBounds(ScaleBounds bounds) Sets the property controls the scale boundary strategy (bypassed by min/max time options).
void	setDistribution(ScaleDistribution distribution) Sets property controls the data distribution along the scale.
void	setId(java.lang.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.

Methods inherited from class org.pepstock.charba.client.options.scales.Axis

getBuildTicksCallback, getCalculateTickRotationCallback, getDataLimitsCallback, getDimensionsCallback, getFitCallback, getScale, getTickToLabelConversionCallback, getType, getUpdateCallback, getWeight, isDisplay, onAfterBuildTicks, onAfterCalculateTickRotation, onAfterDataLimits, onAfterFit, onAfterSetDimensions, onAfterTickToLabelConversion, onAfterUpdate, onBeforeBuildTicks, onBeforeCalculateTickRotation, onBeforeDataLimits, onBeforeFit, onBeforeSetDimensions, onBeforeTickToLabelConversion, onBeforeUpdate, setBuildTicksCallback, setCalculateTickRotationCallback, setDataLimitsCallback, setDimensionsCallback, setDisplay, setFitCallback, setTickToLabelConversionCallback, setType, setUpdateCallback, setWeight

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

getChart

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

See Also:

CartesianAxisType.x

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.

See Also:

CartesianAxisType

Method Detail

getTime

public Time getTime()

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.

See Also:

ScaleDistribution

getDistribution

public ScaleDistribution getDistribution()

Returns the property controls the data distribution along the scale.

Returns:

property controls the data distribution along the scale.

See Also:

ScaleDistribution

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

See Also:

ScaleBounds

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

See Also:

ScaleBounds

getScaleLabel

public CartesianScaleLabel getScaleLabel()

Returns:

the scaleLabel

See Also:

CartesianScaleLabel

getTicks

public T getTicks()

Returns:

the ticks

See Also:

Tick

getGrideLines

public GridLines getGrideLines()

Returns:

the grideLines

See Also:

GridLines

getCartesianType

public CartesianAxisType getCartesianType()

Returns:

the cartesianType

See Also:

CartesianAxisType

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()

Returns:

the stacked

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(java.lang.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 java.lang.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

See Also:

Position

getPosition

public Position getPosition()

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

Returns:

position of axis.

See Also:

Position