Axis (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.commons.ChartContainer
  - - org.pepstock.charba.client.options.scales.Axis

Direct Known Subclasses:

CartesianCategoryAxis, CartesianLinearAxis, CartesianLogarithmicAxis, CartesianTimeAxis, RadialAxis
```
public abstract class Axis
extends ChartContainer
```
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

Constructor Summary

Constructors
Modifier Constructor and Description

protected Axis(AbstractChart<?,?> chart)
Builds the object storing the chart instance.

Constructors
Modifier	Constructor and Description
`protected`	`Axis(AbstractChart<?,?> chart)` Builds the object storing the chart instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AxisBuildTicksCallback`	`getBuildTicksCallback()`
`AxisCalculateTickRotationCallback`	`getCalculateTickRotationCallback()`
`AxisDataLimitsCallback`	`getDataLimitsCallback()`
`AxisDimensionsCallback`	`getDimensionsCallback()`
`AxisFitCallback`	`getFitCallback()`
`protected Scale`	`getScale()` Returns the global options for this chart.
`AxisTickToLabelConversionCallback`	`getTickToLabelConversionCallback()`
`AxisType`	`getType()` Returns the type of axis.
`AxisUpdateCallback`	`getUpdateCallback()`
`int`	`getWeight()` The weight used to sort the axis.
`boolean`	`isDisplay()` Returns if axis is hidden.
`protected void`	`onAfterBuildTicks(GenericJavaScriptObject item)` Callback that runs after ticks are created.
`protected void`	`onAfterCalculateTickRotation(GenericJavaScriptObject item)` Callback that runs after tick rotation is determined.
`protected void`	`onAfterDataLimits(GenericJavaScriptObject item)` Callback that runs after data limits are determined.
`protected void`	`onAfterFit(GenericJavaScriptObject item)` Callback that runs after the scale fits to the canvas.
`protected void`	`onAfterSetDimensions(GenericJavaScriptObject item)` Callback that runs after dimensions are set.
`protected void`	`onAfterTickToLabelConversion(GenericJavaScriptObject item)` Callback that runs after ticks are converted into strings.
`protected void`	`onAfterUpdate(GenericJavaScriptObject item)` Callback that runs at the end of the update process.
`protected void`	`onBeforeBuildTicks(GenericJavaScriptObject item)` Callback that runs before ticks are created.
`protected void`	`onBeforeCalculateTickRotation(GenericJavaScriptObject item)` Callback that runs before tick rotation is determined.
`protected void`	`onBeforeDataLimits(GenericJavaScriptObject item)` Callback that runs before data limits are determined.
`protected void`	`onBeforeFit(GenericJavaScriptObject item)` Callback that runs before the scale fits to the canvas.
`protected void`	`onBeforeSetDimensions(GenericJavaScriptObject item)` Callback that runs before dimensions are set.
`protected void`	`onBeforeTickToLabelConversion(GenericJavaScriptObject item)` Callback that runs before ticks are converted into strings.
`protected void`	`onBeforeUpdate(GenericJavaScriptObject item)` Callback called before the update process starts.
`void`	`setBuildTicksCallback(AxisBuildTicksCallback buildTicksCallback)`
`void`	`setCalculateTickRotationCallback(AxisCalculateTickRotationCallback calculateTickRotationCallback)`
`void`	`setDataLimitsCallback(AxisDataLimitsCallback dataLimitsCallback)`
`void`	`setDimensionsCallback(AxisDimensionsCallback dimensionsCallback)`
`void`	`setDisplay(boolean display)` If set to false the axis is hidden from view.
`void`	`setFitCallback(AxisFitCallback fitCallback)`
`void`	`setTickToLabelConversionCallback(AxisTickToLabelConversionCallback tickToLabelConversionCallback)`
`void`	`setType(AxisType type)` Type of scale being employed.
`void`	`setUpdateCallback(AxisUpdateCallback axisUpdateCallback)`
`void`	`setWeight(int weight)` The weight used to sort the axis.

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
  - Axis
```
protected Axis(AbstractChart<?,?> chart)
```
    Builds the object storing the chart instance.
    
    Parameters:
    
    chart - chart instance
- Method Detail
  - setType
```
public void setType(AxisType type)
```
    Type of scale being employed.
    
    Parameters:
    
    type - type of axis
    
    See Also:
    
    AxisType
  - getType
```
public AxisType getType()
```
    Returns the type of axis.
    
    Returns:
    
    the type of axis
    
    See Also:
    
    AxisType
  - 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
  - getScale
```
protected Scale getScale()
```
    Returns the global options for this chart.
    
    Returns:
    
    the global options for this chart.
  - getUpdateCallback
```
public AxisUpdateCallback getUpdateCallback()
```
    Returns:
    
    the axisUpdateCallback
  - setUpdateCallback
```
public void setUpdateCallback(AxisUpdateCallback axisUpdateCallback)
```
    Parameters:
    
    axisUpdateCallback - the axisUpdateCallback to set
  - getDimensionsCallback
```
public AxisDimensionsCallback getDimensionsCallback()
```
    Returns:
    
    the dimensionsCallback
  - setDimensionsCallback
```
public void setDimensionsCallback(AxisDimensionsCallback dimensionsCallback)
```
    Parameters:
    
    dimensionsCallback - the dimensionsCallback to set
  - getDataLimitsCallback
```
public AxisDataLimitsCallback getDataLimitsCallback()
```
    Returns:
    
    the dataLimitsCallback
  - setDataLimitsCallback
```
public void setDataLimitsCallback(AxisDataLimitsCallback dataLimitsCallback)
```
    Parameters:
    
    dataLimitsCallback - the dataLimitsCallback to set
  - getBuildTicksCallback
```
public AxisBuildTicksCallback getBuildTicksCallback()
```
    Returns:
    
    the buildTicksCallback
  - setBuildTicksCallback
```
public void setBuildTicksCallback(AxisBuildTicksCallback buildTicksCallback)
```
    Parameters:
    
    buildTicksCallback - the buildTicksCallback to set
  - getTickToLabelConversionCallback
```
public AxisTickToLabelConversionCallback getTickToLabelConversionCallback()
```
    Returns:
    
    the tickToLabelConversionCallback
  - setTickToLabelConversionCallback
```
public void setTickToLabelConversionCallback(AxisTickToLabelConversionCallback tickToLabelConversionCallback)
```
    Parameters:
    
    tickToLabelConversionCallback - the tickToLabelConversionCallback to set
  - getCalculateTickRotationCallback
```
public AxisCalculateTickRotationCallback getCalculateTickRotationCallback()
```
    Returns:
    
    the calculateTickRotationCallback
  - setCalculateTickRotationCallback
```
public void setCalculateTickRotationCallback(AxisCalculateTickRotationCallback calculateTickRotationCallback)
```
    Parameters:
    
    calculateTickRotationCallback - the calculateTickRotationCallback to set
  - getFitCallback
```
public AxisFitCallback getFitCallback()
```
    Returns:
    
    the fitCallback
  - setFitCallback
```
public void setFitCallback(AxisFitCallback fitCallback)
```
    Parameters:
    
    fitCallback - the fitCallback to set
  - onBeforeUpdate
```
protected void onBeforeUpdate(GenericJavaScriptObject item)
```
    Callback called before the update process starts.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterUpdate
```
protected void onAfterUpdate(GenericJavaScriptObject item)
```
    Callback that runs at the end of the update process.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeSetDimensions
```
protected void onBeforeSetDimensions(GenericJavaScriptObject item)
```
    Callback that runs before dimensions are set.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterSetDimensions
```
protected void onAfterSetDimensions(GenericJavaScriptObject item)
```
    Callback that runs after dimensions are set.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeDataLimits
```
protected void onBeforeDataLimits(GenericJavaScriptObject item)
```
    Callback that runs before data limits are determined.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterDataLimits
```
protected void onAfterDataLimits(GenericJavaScriptObject item)
```
    Callback that runs after data limits are determined.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeBuildTicks
```
protected void onBeforeBuildTicks(GenericJavaScriptObject item)
```
    Callback that runs before ticks are created.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterBuildTicks
```
protected void onAfterBuildTicks(GenericJavaScriptObject item)
```
    Callback that runs after ticks are created. Useful for filtering ticks.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeTickToLabelConversion
```
protected void onBeforeTickToLabelConversion(GenericJavaScriptObject item)
```
    Callback that runs before ticks are converted into strings.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterTickToLabelConversion
```
protected void onAfterTickToLabelConversion(GenericJavaScriptObject item)
```
    Callback that runs after ticks are converted into strings.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeCalculateTickRotation
```
protected void onBeforeCalculateTickRotation(GenericJavaScriptObject item)
```
    Callback that runs before tick rotation is determined.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterCalculateTickRotation
```
protected void onAfterCalculateTickRotation(GenericJavaScriptObject item)
```
    Callback that runs after tick rotation is determined.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onBeforeFit
```
protected void onBeforeFit(GenericJavaScriptObject item)
```
    Callback that runs before the scale fits to the canvas.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem
  - onAfterFit
```
protected void onAfterFit(GenericJavaScriptObject item)
```
    Callback that runs after the scale fits to the canvas.
    
    Parameters:
    
    item - axis item got from java script
    
    See Also:
    
    AxisItem

Class Axis

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Axis

Method Detail

setType

getType

setDisplay

isDisplay

setWeight

getWeight

getScale

getUpdateCallback

setUpdateCallback

getDimensionsCallback

setDimensionsCallback

getDataLimitsCallback

setDataLimitsCallback

getBuildTicksCallback

setBuildTicksCallback

getTickToLabelConversionCallback

setTickToLabelConversionCallback

getCalculateTickRotationCallback

setCalculateTickRotationCallback

getFitCallback

setFitCallback

onBeforeUpdate

onAfterUpdate

onBeforeSetDimensions

onAfterSetDimensions

onBeforeDataLimits

onAfterDataLimits

onBeforeBuildTicks

onAfterBuildTicks

onBeforeTickToLabelConversion

onAfterTickToLabelConversion

onBeforeCalculateTickRotation

onAfterCalculateTickRotation

onBeforeFit

onAfterFit