CartesianAxis (Sencha GXT 3.1.1)

java.lang.Object
- com.sencha.gxt.chart.client.chart.axis.Axis<M,V>
- - com.sencha.gxt.chart.client.chart.axis.CartesianAxis<M,V>

Type Parameters:
M - the data type of the axis
V - the variable type of axis

All Implemented Interfaces:

AxisHandler.HasAxisHandlers, AxisItemOutEvent.HasAxisItemOutHandlers, AxisItemOverEvent.HasAxisItemOverHandlers, AxisItemUpEvent.HasAxisItemUpHandlers, AxisSelectionEvent.HasAxisSelectionHandlers

Direct Known Subclasses:

CategoryAxis, NumericAxis
```
public abstract class CartesianAxis<M,V>
extends Axis<M,V>
```
An axis in Cartesian coordinates.

Constructor Summary

Constructors
Constructor and Description

CartesianAxis()
Create a Cartesian axis.

Constructors
Constructor and Description
`CartesianAxis()` Create a Cartesian axis.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all the sprites of the axis from the surface.
`void`	`drawAxis(boolean init)` Renders the axis into the screen and updates it's position.
`void`	`drawLabels()` Renders the labels in the axes.
`int`	`getDashSize()` Returns the dash size of the axis.
`double`	`getDepth()` Returns the depth of the axis.
`PathSprite`	`getGridDefaultConfig()` Returns the config for the default axis grid.
`PathSprite`	`getGridEvenConfig()` Returns the config for the grid on the even indices.
`PathSprite`	`getGridOddConfig()` Returns the config for the grid on the odd indices.
`double`	`getHeight()` Returns the height of the axis.
`int`	`getLabelStepRatio()` Returns the number of tick marks per label.
`double`	`getLabelTolerance()` Returns the intersection tolerance of labels on the axis.
`double`	`getLength()` Returns the length of the axis.
`int`	`getMinorTickSteps()` Returns the number of ticks between major ticks.
`Chart.Position`	`getPosition()` Returns the `Chart.Position` of the axis.
`int`	`getTextLabelPadding()` Returns the padding between labels on the axis.
`double`	`getWidth()` Returns the width of the axis.
`boolean`	`isLabelOverlapHiding()` Returns whether or not the axis uses label hiding.
`void`	`setDashSize(int dashSize)` Sets the dash size of the axis.
`void`	`setDepth(double depth)` Sets the depth of the axis.
`void`	`setGridDefaultConfig(PathSprite defaultGridConfig)` Sets the config for the default axis grid.
`void`	`setGridEvenConfig(PathSprite gridEvenConfig)` Sets the config for the grid on the even indices.
`void`	`setGridOddConfig(PathSprite gridOddConfig)` Sets the config for the grid on the odd indices.
`void`	`setHeight(double height)` Sets the height of the axis.
`void`	`setLabelOverlapHiding(boolean labelOverlapHiding)` Sets whether or not the axis uses label hiding.
`void`	`setLabelPadding(int textLabelPadding)` Sets the padding between labels on the axis.
`void`	`setLabelStepRatio(int labelStepRatio)` Sets the number of tick marks per label.
`void`	`setLabelTolerance(double labelTolerance)` Sets the intersection tolerance of labels on the axis.
`void`	`setLength(double length)` Sets the length of the axis.
`void`	`setMinorTickSteps(int minorTickSteps)` Sets the number of ticks between major ticks.
`void`	`setPosition(Chart.Position position)` Sets the `Chart.Position` of the axis.
`void`	`setWidth(double width)` Sets the width of the axis.

Methods inherited from class com.sencha.gxt.chart.client.chart.axis.Axis
addAxisHandler, addAxisItemOutHandler, addAxisItemOverHandler, addAxisItemUpHandler, addAxisSelectionHandler, getAxisConfig, getBBox, getChart, getFrom, getLabelConfig, getLabelProvider, getTitleConfig, getTo, getX, getY, isDisplayGrid, isHidden, onMouseDown, onMouseMove, onMouseOut, onMouseUp, removeToolTip, setAxisConfig, setChart, setDisplayGrid, setHidden, setLabelConfig, setLabelProvider, setTitleConfig, setToolTipConfig, setX, setY

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

- Constructor Detail
  - CartesianAxis
```
public CartesianAxis()
```
    Create a Cartesian axis.
- Method Detail
  - clear
```
public void clear()
```
    Description copied from class: Axis
    
    Removes all the sprites of the axis from the surface.
    
    Overrides:
    
    clear in class Axis<M,V>
  - drawAxis
```
public void drawAxis(boolean init)
```
    Description copied from class: Axis
    
    Renders the axis into the screen and updates it's position.
    
    Specified by:
    
    drawAxis in class Axis<M,V>
    
    Parameters:
    init - true if the initial draw call
  - drawLabels
```
public void drawLabels()
```
    Description copied from class: Axis
    
    Renders the labels in the axes.
    
    Specified by:
    
    drawLabels in class Axis<M,V>
  - getDashSize
```
public int getDashSize()
```
    Returns the dash size of the axis.
    
    Returns:
    the dash size of the axis
  - getDepth
```
public double getDepth()
```
    Returns the depth of the axis.
    
    Returns:
    the depth of the axis
  - getGridDefaultConfig
```
public PathSprite getGridDefaultConfig()
```
    Returns the config for the default axis grid.
    
    Returns:
    the config for the default axis grid
  - getGridEvenConfig
```
public PathSprite getGridEvenConfig()
```
    Returns the config for the grid on the even indices.
    
    Returns:
    the config for the grid on the even indices
  - getGridOddConfig
```
public PathSprite getGridOddConfig()
```
    Returns the config for the grid on the odd indices.
    
    Returns:
    the config for the grid on the odd indices
  - getHeight
```
public double getHeight()
```
    Returns the height of the axis.
    
    Returns:
    the height of the axis
  - getLabelStepRatio
```
public int getLabelStepRatio()
```
    Returns the number of tick marks per label.
    
    Returns:
    the number of tick marks per label
  - getLabelTolerance
```
public double getLabelTolerance()
```
    Returns the intersection tolerance of labels on the axis.
    
    Returns:
    the intersection tolerance of labels on the axis
  - getLength
```
public double getLength()
```
    Returns the length of the axis.
    
    Returns:
    the length of the axis
  - getMinorTickSteps
```
public int getMinorTickSteps()
```
    Returns the number of ticks between major ticks.
    
    Returns:
    the number of ticks between major ticks
  - getPosition
```
public Chart.Position getPosition()
```
    Description copied from class: Axis
    
    Returns the Chart.Position of the axis.
    
    Specified by:
    
    getPosition in class Axis<M,V>
    
    Returns:
    the position of the axis
  - getTextLabelPadding
```
public int getTextLabelPadding()
```
    Returns the padding between labels on the axis.
    
    Returns:
    the padding between labels on the axis
  - getWidth
```
public double getWidth()
```
    Returns the width of the axis.
    
    Returns:
    the width of the axis
  - isLabelOverlapHiding
```
public boolean isLabelOverlapHiding()
```
    Returns whether or not the axis uses label hiding.
    
    Returns:
    whether or not the axis uses label hiding
  - setDashSize
```
public void setDashSize(int dashSize)
```
    Sets the dash size of the axis.
    
    Parameters:
    dashSize - the dash size of the axis
  - setDepth
```
public void setDepth(double depth)
```
    Sets the depth of the axis.
    
    Parameters:
    depth - the depth of the axis
  - setGridDefaultConfig
```
public void setGridDefaultConfig(PathSprite defaultGridConfig)
```
    Sets the config for the default axis grid.
    
    Parameters:
    defaultGridConfig - the config for the default axis grid
  - setGridEvenConfig
```
public void setGridEvenConfig(PathSprite gridEvenConfig)
```
    Sets the config for the grid on the even indices. Overrides the default grid.
    
    Parameters:
    gridEvenConfig - the config for the grid on the even indices
  - setGridOddConfig
```
public void setGridOddConfig(PathSprite gridOddConfig)
```
    Sets the config for the grid on the odd indices. Overrides the default grid.
    
    Parameters:
    gridOddConfig - the config for the grid on the odd indices
  - setHeight
```
public void setHeight(double height)
```
    Sets the height of the axis.
    
    Parameters:
    height - the height of the axis
  - setLabelOverlapHiding
```
public void setLabelOverlapHiding(boolean labelOverlapHiding)
```
    Sets whether or not the axis uses label hiding. Defaults to false.
    
    Parameters:
    labelOverlapHiding - whether or not the axis uses label hiding
  - setLabelPadding
```
public void setLabelPadding(int textLabelPadding)
```
    Sets the padding between labels on the axis.
    
    Parameters:
    textLabelPadding - the padding between labels on the axis
  - setLabelStepRatio
```
public void setLabelStepRatio(int labelStepRatio)
```
    Sets the number of tick marks per label. Ratio needs to be greater than 0. The last step label of an axis will always be drawn even the label step ratio is not a divisor of the last array index.
    
    Parameters:
    labelStepRatio - the number of tick marks per label
  - setLabelTolerance
```
public void setLabelTolerance(double labelTolerance)
```
    Sets the intersection tolerance of labels on the axis.
    
    Parameters:
    labelTolerance - the intersection tolerance of labels on the axis
  - setLength
```
public void setLength(double length)
```
    Sets the length of the axis.
    
    Parameters:
    length - the length of the axis
  - setMinorTickSteps
```
public void setMinorTickSteps(int minorTickSteps)
```
    Sets the number of ticks between major ticks.
    
    Parameters:
    minorTickSteps - the number of ticks between major ticks
  - setPosition
```
public void setPosition(Chart.Position position)
```
    Sets the Chart.Position of the axis.
    
    Parameters:
    position - the position of the axis
  - setWidth
```
public void setWidth(double width)
```
    Sets the width of the axis.
    
    Parameters:
    width - the width of the axis

Class CartesianAxis<M,V>

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.chart.client.chart.axis.Axis

Methods inherited from class java.lang.Object

Constructor Detail

CartesianAxis

Method Detail

clear

drawAxis

drawLabels

getDashSize

getDepth

getGridDefaultConfig

getGridEvenConfig

getGridOddConfig

getHeight

getLabelStepRatio

getLabelTolerance

getLength

getMinorTickSteps

getPosition

getTextLabelPadding

getWidth

isLabelOverlapHiding

setDashSize

setDepth

setGridDefaultConfig

setGridEvenConfig

setGridOddConfig

setHeight

setLabelOverlapHiding

setLabelPadding

setLabelStepRatio

setLabelTolerance

setLength

setMinorTickSteps

setPosition

setWidth