Axis (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.configuration.Axis

Direct Known Subclasses:

CartesianCategoryAxis, CartesianLinearAxis, CartesianLogarithmicAxis, CartesianTimeAxis, RadialAxis
```
public abstract class Axis
extends Object
```
Axes are an integral part of a chart.
They are used to determine how data maps to a pixel value on the chart.
It contains a number of config callbacks that can be used to change parameters in the scale at different points in the update process.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AxisBuildTicksCallback`	`getAxisBuildTicksCallback()` Returns the user callback that runs before/after ticks are created.
`AxisCalculateTickRotationCallback`	`getAxisCalculateTickRotationCallback()` Returns the user callback that runs before/after tick rotation is determined.
`AxisDataLimitsCallback`	`getAxisDataLimitsCallback()` Returns the user callback that runs before/after data limits are determined.
`AxisDimensionsCallback`	`getAxisDimensionsCallback()` Returns the user callback that runs before/after dimensions are set.
`AxisFitCallback`	`getAxisFitCallback()` Returns the user callback that runs before/after the scale fits to the canvas.
`AxisTickToLabelConversionCallback`	`getAxisTickToLabelConversionCallback()` Returns the user callback that runs before/after ticks are converted into strings.
`AxisUpdateCallback`	`getAxisUpdateCallback()` Returns the user callback that runs before/after of the update process.
`AbstractChart<?,?>`	`getChart()` Returns the chart instance
`protected T`	`getConfiguration()` Returns the configuration element.
`AxisType`	`getType()` Returns the type of axis.
`int`	`getWeight()` The weight used to sort the axis.
`boolean`	`isDisplay()` Returns if axis is hidden.
`void`	`setAxisBuildTicksCallback(AxisBuildTicksCallback axisBuildTicksCallback)` Sets the user callback that runs before/after ticks are created.
`void`	`setAxisCalculateTickRotationCallback(AxisCalculateTickRotationCallback axisCalculateTickRotationCallback)` Sets the user callback that runs before/after tick rotation is determined.
`void`	`setAxisDataLimitsCallback(AxisDataLimitsCallback axisDataLimitsCallback)` Sets the user callback that runs before/after data limits are determined.
`void`	`setAxisDimensionsCallback(AxisDimensionsCallback axisDimensionsCallback)` Sets the user callback that runs before/after dimensions are set.
`void`	`setAxisFitCallback(AxisFitCallback axisFitCallback)` Sets the user callback that runs before/after the scale fits to the canvas.
`void`	`setAxisTickToLabelConversionCallback(AxisTickToLabelConversionCallback axisTickToLabelConversionCallback)` Sets the user callback that runs before/after ticks are converted into strings.
`void`	`setAxisUpdateCallback(AxisUpdateCallback axisUpdateCallback)` Sets the user callback that runs before/after of the update process.
`protected void`	`setConfiguration(T configuration)`
`void`	`setDisplay(boolean display)` If set to false the axis is hidden from view.
`void`	`setType(AxisType type)` Type of scale being employed.
`void`	`setWeight(int weight)` The weight used to sort the axis.
`String`	`toJSON()` Returns the JSON representation of the object.

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

- Method Detail
  - setType
```
public void setType(AxisType type)
```
    Type of scale being employed.
    
    Parameters:
    
    type - type of axis
  - getType
```
public AxisType getType()
```
    Returns the type of axis.
    
    Returns:
    
    the type of axis
  - setDisplay
```
public void setDisplay(boolean display)
```
    If set to false the axis is hidden from view. Overrides gridLines.display, scaleLabel.display, and ticks.display.
    
    Parameters:
    
    display - If set to false the axis is hidden from view. Overrides gridLines.display, scaleLabel.display, and ticks.display.
  - isDisplay
```
public boolean isDisplay()
```
    Returns if axis is hidden.
    
    Returns:
    
    false if axis is hidden, otherwise true.
  - setWeight
```
public void setWeight(int weight)
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Parameters:
    
    weight - weight of axis
  - getWeight
```
public int getWeight()
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Returns:
    
    weight of axis
  - getAxisBuildTicksCallback
```
public AxisBuildTicksCallback getAxisBuildTicksCallback()
```
    Returns the user callback that runs before/after ticks are created.
    
    Returns:
    
    the axisBuildTicksCallback
  - setAxisBuildTicksCallback
```
public void setAxisBuildTicksCallback(AxisBuildTicksCallback axisBuildTicksCallback)
```
    Sets the user callback that runs before/after ticks are created.
    
    Parameters:
    
    axisBuildTicksCallback - the axisBuildTicksCallback to set
  - getAxisCalculateTickRotationCallback
```
public AxisCalculateTickRotationCallback getAxisCalculateTickRotationCallback()
```
    Returns the user callback that runs before/after tick rotation is determined.
    
    Returns:
    
    the axisCalculateTickRotationCallback
  - setAxisCalculateTickRotationCallback
```
public void setAxisCalculateTickRotationCallback(AxisCalculateTickRotationCallback axisCalculateTickRotationCallback)
```
    Sets the user callback that runs before/after tick rotation is determined.
    
    Parameters:
    
    axisCalculateTickRotationCallback - the axisCalculateTickRotationCallback to set
  - getAxisDataLimitsCallback
```
public AxisDataLimitsCallback getAxisDataLimitsCallback()
```
    Returns the user callback that runs before/after data limits are determined.
    
    Returns:
    
    the axisDataLimitsCallback
  - setAxisDataLimitsCallback
```
public void setAxisDataLimitsCallback(AxisDataLimitsCallback axisDataLimitsCallback)
```
    Sets the user callback that runs before/after data limits are determined.
    
    Parameters:
    
    axisDataLimitsCallback - the axisDataLimitsCallback to set
  - getAxisDimensionsCallback
```
public AxisDimensionsCallback getAxisDimensionsCallback()
```
    Returns the user callback that runs before/after dimensions are set.
    
    Returns:
    
    the axisDimensionsCallback
  - setAxisDimensionsCallback
```
public void setAxisDimensionsCallback(AxisDimensionsCallback axisDimensionsCallback)
```
    Sets the user callback that runs before/after dimensions are set.
    
    Parameters:
    
    axisDimensionsCallback - the axisDimensionsCallback to set
  - getAxisFitCallback
```
public AxisFitCallback getAxisFitCallback()
```
    Returns the user callback that runs before/after the scale fits to the canvas.
    
    Returns:
    
    the axisFitCallback
  - setAxisFitCallback
```
public void setAxisFitCallback(AxisFitCallback axisFitCallback)
```
    Sets the user callback that runs before/after the scale fits to the canvas.
    
    Parameters:
    
    axisFitCallback - the axisFitCallback to set
  - getAxisTickToLabelConversionCallback
```
public AxisTickToLabelConversionCallback getAxisTickToLabelConversionCallback()
```
    Returns the user callback that runs before/after ticks are converted into strings.
    
    Returns:
    
    the axisTickToLabelConversionCallback
  - setAxisTickToLabelConversionCallback
```
public void setAxisTickToLabelConversionCallback(AxisTickToLabelConversionCallback axisTickToLabelConversionCallback)
```
    Sets the user callback that runs before/after ticks are converted into strings.
    
    Parameters:
    
    axisTickToLabelConversionCallback - the axisTickToLabelConversionCallback to set
  - getAxisUpdateCallback
```
public AxisUpdateCallback getAxisUpdateCallback()
```
    Returns the user callback that runs before/after of the update process.
    
    Returns:
    
    the axisUpdateCallback
  - setAxisUpdateCallback
```
public void setAxisUpdateCallback(AxisUpdateCallback axisUpdateCallback)
```
    Sets the user callback that runs before/after of the update process.
    
    Parameters:
    
    axisUpdateCallback - the axisUpdateCallback to set
  - 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

Class Axis

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setType

getType

setDisplay

isDisplay

setWeight

getWeight

getAxisBuildTicksCallback

setAxisBuildTicksCallback

getAxisCalculateTickRotationCallback

setAxisCalculateTickRotationCallback

getAxisDataLimitsCallback

setAxisDataLimitsCallback

getAxisDimensionsCallback

setAxisDimensionsCallback

getAxisFitCallback

setAxisFitCallback

getAxisTickToLabelConversionCallback

setAxisTickToLabelConversionCallback

getAxisUpdateCallback

setAxisUpdateCallback

setConfiguration

getConfiguration

toJSON

getChart