com.sencha.gxt.chart.client.chart.axis
Class CartesianAxis<M,V>

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, AxisSelectionEvent.HasAxisSelectionHandlers

Direct Known Subclasses:

CategoryAxis, NumericAxis

public abstract class CartesianAxis<M,V>
extends Axis<M,V>

An axis in Cartesian coordinates.

Constructor Summary

CartesianAxis()
Create a Cartesian axis.

Method Summary

void	delete() 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.
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.
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	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	setTextLabelPadding(int textLabelPadding) Sets the padding between labels on 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, addAxisSelectionHandler, getAxisConfig, getBBox, getChart, getFrom, getLabelConfig, getLabelProvider, getSteps, getTitleConfig, getTo, getX, getY, isDisplayGrid, isHidden, onMouseDown, onMouseMove, onMouseOut, removeToolTip, setAxisConfig, setChart, setDisplayGrid, setHidden, setLabelConfig, setLabelProvider, setSteps, 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

delete

public void delete()

Description copied from class: Axis

Removes all the sprites of the axis from the surface.

Overrides:

delete 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

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

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

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

setTextLabelPadding

public void setTextLabelPadding(int textLabelPadding)

Sets the padding between labels on the axis.

Parameters:

textLabelPadding - the padding between labels on the axis

setWidth

public void setWidth(double width)

Sets the width of the axis.

Parameters:

width - the width of the axis