CartesianTimeAxis (Charba - J2CL and GWT charts library based on CHART.JS)

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(IsChart chart)` Builds the object storing the chart instance.
`CartesianTimeAxis(IsChart chart, CartesianAxisType cartesianType)` Builds the object storing the chart instance and axis type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Adapters`	`getAdapters()` Returns the adapters element.
`TimeAxisBuildTicksCallback`	`getAxisBuildTicksCallback()` Returns the user callback that runs before/after ticks are created.
`ScaleBounds`	`getBounds()` Returns the property controls the scale boundary strategy (bypassed by min/max time options).
`CartesianAxisType`	`getCartesianType()` Returns the axis type
`IsChart`	`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`	`merge(NativeObjectContainer source, String property)` Merge a native object into 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 into options of chart.
`void`	`setAxisBuildTicksCallback(TimeAxisBuildTicksCallback axisBuildTicksCallback)` Sets the user callback that runs before/after ticks are created.
`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
getAxisCalculateTickRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getCharbaId, getDisplay, getType, getWeight, setAxisCalculateTickRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setDisplay, setDisplay, setWeight

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CartesianTimeAxis
```
public CartesianTimeAxis(IsChart chart)
```
    Builds the object storing the chart instance. Axis type is X by default.
    
    Parameters:
    
    chart - chart instance
  - CartesianTimeAxis
```
public CartesianTimeAxis(IsChart 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
  - getAdapters
```
public Adapters getAdapters()
```
    Returns the adapters element.
    
    Returns:
    
    the adapters
  - 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).
  - getAxisBuildTicksCallback
```
public TimeAxisBuildTicksCallback getAxisBuildTicksCallback()
```
    Returns the user callback that runs before/after ticks are created.
    
    Returns:
    
    the axisBuildTicksCallback
  - setAxisBuildTicksCallback
```
public void setAxisBuildTicksCallback(TimeAxisBuildTicksCallback axisBuildTicksCallback)
```
    Sets the user callback that runs before/after ticks are created.
    
    Parameters:
    
    axisBuildTicksCallback - the axisBuildTicksCallback to set
  - 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. This is set to true in the bar chart by default.
    
    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. This is set to true in the bar chart by default.
    
    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.
  - merge
```
public final void merge(NativeObjectContainer source,
                        String property)
```
    Merge a native object into 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 into 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.
  - getChart
```
public final IsChart getChart()
```
    Returns the chart instance
    
    Returns:
    
    the chart

Class CartesianTimeAxis

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CartesianTimeAxis

CartesianTimeAxis

Method Detail

getTicks

getTime

getAdapters

setDistribution

getDistribution

setBounds

getBounds

getAxisBuildTicksCallback

setAxisBuildTicksCallback

getScaleLabel

getGrideLines

getCartesianType

setStacked

isStacked

setOffset

isOffset

setId

getId

setPosition

getPosition

setConfiguration

getConfiguration

merge

toJSON

getChart