Axis (ChartistJSF 1.0 API)

java.lang.Object
- org.chartistjsf.model.chart.Axis

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LinearAxis
```
public abstract class Axis
extends Object
implements Serializable
```
Since:

0.1

Author:

Hatem Alimam

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Axis()

Constructors
Constructor and Description
`Axis()`

Method Summary

Methods
Modifier and Type	Method and Description
`AxisPosition`	`getAxisPosition()` Position where labels are placed.
`String`	`getLabelInterpolationFnc()` Interpolation function that allows you to intercept the value from the axis label
`int`	`getOffset()` The offset of the labels to the chart area
`int`	`getScaleMinSpace()` This value specifies the minimum height in pixel of the scale steps
`boolean`	`getShowGrid()` If the axis grid should be drawn or not
`boolean`	`getShowLabel()` If labels should be shown or not
`int`	`getXLabelOffset()` Allows to correct label positioning on this axis by positive or negative x offset.
`int`	`getYLabelOffset()` Allows to correct label positioning on this axis by positive or negative y offset.
`abstract void`	`render(ResponseWriter writer, AxisType axisType)`
`void`	`setAxisPosition(AxisPosition axisPosition)` Position where labels are placed.
`void`	`setLabelInterpolationFnc(String labelInterpolationFnc)` Interpolation function that allows you to intercept the value from the axis label
`void`	`setOffset(int offset)` The offset of the labels to the chart area
`void`	`setScaleMinSpace(int scaleMinSpace)` This value specifies the minimum height in pixel of the scale steps
`void`	`setShowGrid(boolean showGrid)` If the axis grid should be drawn or not
`void`	`setShowLabel(boolean showLabel)` If labels should be shown or not
`void`	`setXLabelOffset(int xLabelOffset)` Allows to correct label positioning on this axis by positive or negative x offset.
`void`	`setYLabelOffset(int yLabelOffset)` Allows to correct label positioning on this axis by positive or negative y offset.

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

- Constructor Detail
  - Axis
```
public Axis()
```
- Method Detail
  - getOffset
```
public int getOffset()
```
    The offset of the labels to the chart area
    
    Returns:
    the offset
  - setOffset
```
public void setOffset(int offset)
```
    The offset of the labels to the chart area
    
    Parameters:
    offset -
  - getAxisPosition
```
public AxisPosition getAxisPosition()
```
    Position where labels are placed. Can be set to AxisPosition.START or AxisPosition.END where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    
    Returns:
    the axisPosition
  - setAxisPosition
```
public void setAxisPosition(AxisPosition axisPosition)
```
    Position where labels are placed. Can be set to AxisPosition.START or AxisPosition.END where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    
    Parameters:
    axisPosition - the axisPosition to set
  - getXLabelOffset
```
public int getXLabelOffset()
```
    Allows to correct label positioning on this axis by positive or negative x offset.
    
    Returns:
    the xLabelOffset
  - setXLabelOffset
```
public void setXLabelOffset(int xLabelOffset)
```
    Allows to correct label positioning on this axis by positive or negative x offset.
    
    Parameters:
    xLabelOffset -
  - getYLabelOffset
```
public int getYLabelOffset()
```
    Allows to correct label positioning on this axis by positive or negative y offset.
    
    Returns:
    the yLabelOffset
  - setYLabelOffset
```
public void setYLabelOffset(int yLabelOffset)
```
    Allows to correct label positioning on this axis by positive or negative y offset.
    
    Parameters:
    yLabelOffset -
  - getShowLabel
```
public boolean getShowLabel()
```
    If labels should be shown or not
    
    Returns:
    the showLabel
  - setShowLabel
```
public void setShowLabel(boolean showLabel)
```
    If labels should be shown or not
    
    Parameters:
    showLabel - the showLabel to set
  - getShowGrid
```
public boolean getShowGrid()
```
    If the axis grid should be drawn or not
    
    Returns:
    the showGrid
  - setShowGrid
```
public void setShowGrid(boolean showGrid)
```
    If the axis grid should be drawn or not
    
    Parameters:
    showGrid - the showGrid to set
  - getLabelInterpolationFnc
```
public String getLabelInterpolationFnc()
```
    Interpolation function that allows you to intercept the value from the axis label
    
    Returns:
    the labelInterpolationFnc
  - setLabelInterpolationFnc
```
public void setLabelInterpolationFnc(String labelInterpolationFnc)
```
    Interpolation function that allows you to intercept the value from the axis label
    
    Parameters:
    labelInterpolationFnc - the labelInterpolationFnc to set
  - getScaleMinSpace
```
public int getScaleMinSpace()
```
    This value specifies the minimum height in pixel of the scale steps
    
    Returns:
    the scaleMinSpace
  - setScaleMinSpace
```
public void setScaleMinSpace(int scaleMinSpace)
```
    This value specifies the minimum height in pixel of the scale steps
    
    Parameters:
    scaleMinSpace - the scaleMinSpace to set
  - render
```
public abstract void render(ResponseWriter writer,
          AxisType axisType)
                     throws IOException
```
    Throws:
    
    IOException

Class Axis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Axis

Method Detail

getOffset

setOffset

getAxisPosition

setAxisPosition

getXLabelOffset

setXLabelOffset

getYLabelOffset

setYLabelOffset

getShowLabel

setShowLabel

getShowGrid

setShowGrid

getLabelInterpolationFnc

setLabelInterpolationFnc

getScaleMinSpace

setScaleMinSpace

render