Axis (Charba - J2CL and GWT charts library based on 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
`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.
`int`	`getCharbaId()` Returns the unique id of axis.
`IsChart`	`getChart()` Returns the chart instance
`protected T`	`getConfiguration()` Returns the configuration element.
`Display`	`getDisplay()` The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
`AxisType`	`getType()` Returns the type of axis.
`double`	`getWeight()` The weight used to sort the axis.
`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`	`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`	`setDisplay(Display display)` The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
`void`	`setWeight(double 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
  - getCharbaId
```
public final int getCharbaId()
```
    Returns the unique id of axis.
    
    Returns:
    
    the unique id 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.
  - setDisplay
```
public final void setDisplay(Display display)
```
    The display option controls the visibility of axis.
    Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
    
    Parameters:
    
    display - display option controls the visibility of axis
  - getDisplay
```
public final Display getDisplay()
```
    The display option controls the visibility of axis.
    Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
    
    Returns:
    
    display option controls the visibility of axis
  - setWeight
```
public void setWeight(double weight)
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Parameters:
    
    weight - weight of axis
  - getWeight
```
public double getWeight()
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Returns:
    
    weight of axis
  - 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 user callback that runs before/after data limits are determined
  - setAxisDataLimitsCallback
```
public void setAxisDataLimitsCallback(AxisDataLimitsCallback axisDataLimitsCallback)
```
    Sets the user callback that runs before/after data limits are determined.
    
    Parameters:
    
    axisDataLimitsCallback - the user callback that runs before/after data limits are determined
  - getAxisDimensionsCallback
```
public AxisDimensionsCallback getAxisDimensionsCallback()
```
    Returns the user callback that runs before/after dimensions are set.
    
    Returns:
    
    the user callback that runs before/after dimensions are set
  - setAxisDimensionsCallback
```
public void setAxisDimensionsCallback(AxisDimensionsCallback axisDimensionsCallback)
```
    Sets the user callback that runs before/after dimensions are set.
    
    Parameters:
    
    axisDimensionsCallback - the user callback that runs before/after dimensions are set
  - getAxisFitCallback
```
public AxisFitCallback getAxisFitCallback()
```
    Returns the user callback that runs before/after the scale fits to the canvas.
    
    Returns:
    
    the user callback that runs before/after the scale fits to the canvas
  - setAxisFitCallback
```
public void setAxisFitCallback(AxisFitCallback axisFitCallback)
```
    Sets the user callback that runs before/after the scale fits to the canvas.
    
    Parameters:
    
    axisFitCallback - the user callback that runs before/after the scale fits to the canvas
  - getAxisTickToLabelConversionCallback
```
public AxisTickToLabelConversionCallback getAxisTickToLabelConversionCallback()
```
    Returns the user callback that runs before/after ticks are converted into strings.
    
    Returns:
    
    the user callback that runs before/after ticks are converted into strings
  - setAxisTickToLabelConversionCallback
```
public void setAxisTickToLabelConversionCallback(AxisTickToLabelConversionCallback axisTickToLabelConversionCallback)
```
    Sets the user callback that runs before/after ticks are converted into strings.
    
    Parameters:
    
    axisTickToLabelConversionCallback - the user callback that runs before/after ticks are converted into strings
  - getAxisUpdateCallback
```
public AxisUpdateCallback getAxisUpdateCallback()
```
    Returns the user callback that runs before/after of the update process.
    
    Returns:
    
    the user callback that runs before/after of the update process
  - setAxisUpdateCallback
```
public void setAxisUpdateCallback(AxisUpdateCallback axisUpdateCallback)
```
    Sets the user callback that runs before/after of the update process.
    
    Parameters:
    
    axisUpdateCallback - the user callback that runs before/after of the update process
  - 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 Axis

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCharbaId

getType

setDisplay

setDisplay

getDisplay

setWeight

getWeight

getAxisCalculateTickRotationCallback

setAxisCalculateTickRotationCallback

getAxisDataLimitsCallback

setAxisDataLimitsCallback

getAxisDimensionsCallback

setAxisDimensionsCallback

getAxisFitCallback

setAxisFitCallback

getAxisTickToLabelConversionCallback

setAxisTickToLabelConversionCallback

getAxisUpdateCallback

setAxisUpdateCallback

setConfiguration

getConfiguration

merge

toJSON

getChart