com.sencha.gxt.chart.client.chart.axis

Class NumericAxis<M>

java.lang.Object

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

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

com.sencha.gxt.chart.client.chart.axis.NumericAxis<M>

Type Parameters:

M - the data type that the axis uses

All Implemented Interfaces:

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

public class NumericAxis<M>
extends CartesianAxis<M,Number>

An axis to handle numeric values. This axis is used for quantitative data as opposed to the category axis. You can set minimum and maximum values to the axis so that the values are bound to that. If no values are set, then the scale will auto-adjust to the values.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	adjustMaximumByMajorUnit
protected boolean	adjustMinimumByMajorUnit
protected double	interval
protected double	maximum
protected double	minimum
protected double	step
protected int	stepsMax

Fields inherited from class com.sencha.gxt.chart.client.chart.axis.CartesianAxis

minorTickSteps, position, ticks

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

axisConfig, bbox, chart, displayGrid, from, hidden, labelConfig, labelNames, labelProvider, labels, lastIndex, lines, steps, titleConfig, titleSprite, to, toolTip, toolTipConfig, x, y

Constructor Summary

Constructors

Constructor and Description
NumericAxis() Creates a numeric axis.

Method Summary

Modifier and Type	Method and Description
void	addField(ValueProvider<? super M,? extends Number> field) Adds a ValueProvider to provide data to a field of the axis.
protected void	applyData() Applies the field data to the labels of the axis.
void	calcEnds() Calculate the start, end and step points.
protected void	createLabels() Creates the list of labels to display.
List<ValueProvider<? super M,? extends Number>>	getFields()
double	getInterval() Returns the manually set interval between tick marks.
double	getMaximum() Returns the maximum value of the axis.
double	getMinimum() Returns the minimum value of the axis.
int	getSteps() Returns the steps of the axis.
boolean	isAdjustMaximumByMajorUnit() Returns true if the axis adjusts the minimum.
boolean	isAdjustMinimumByMajorUnit() Returns true if the axis adjusts the maximum.
void	removeField(ValueProvider<? super M,? extends Number> field)
void	setAdjustMaximumByMajorUnit(boolean adjustMaximumByMajorUnit) Sets true if the axis adjusts the maximum.
void	setAdjustMinimumByMajorUnit(boolean adjustMinimumByMajorUnit) Sets true if the axis adjusts the minimum.
void	setFields(List<ValueProvider<? super M,? extends Number>> fields)
void	setInterval(double interval) Sets the interval between tick marks.
void	setMaximum(double maximum) Sets the maximum value of the axis.
void	setMinimum(double minimum) Sets the minimum value of the axis.
void	setSteps(int steps) Sets the number of steps on the axis.

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

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

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

addAxisHandler, addAxisItemOutHandler, addAxisItemOverHandler, addAxisItemUpHandler, addAxisSelectionHandler, ensureHandlers, 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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minimum

protected double minimum

maximum

protected double maximum

adjustMaximumByMajorUnit

protected boolean adjustMaximumByMajorUnit

adjustMinimumByMajorUnit

protected boolean adjustMinimumByMajorUnit

step

protected double step

stepsMax

protected int stepsMax

interval

protected double interval

Constructor Detail

NumericAxis

public NumericAxis()

Creates a numeric axis.

Method Detail

addField

public void addField(ValueProvider<? super M,? extends Number> field)

Adds a ValueProvider to provide data to a field of the axis.

Parameters:

field - the value provider

calcEnds

public void calcEnds()

Calculate the start, end and step points.

getFields

public List<ValueProvider<? super M,? extends Number>> getFields()

getInterval

public double getInterval()

Returns the manually set interval between tick marks.

Returns:

the manually set interval between tick marks

getMaximum

public double getMaximum()

Returns the maximum value of the axis.

Returns:

the maximum value of the axis

getMinimum

public double getMinimum()

Returns the minimum value of the axis.

Returns:

the minimum value of the axis

getSteps

public int getSteps()

Returns the steps of the axis.

Returns:

the steps of the axis

isAdjustMaximumByMajorUnit

public boolean isAdjustMaximumByMajorUnit()

Returns true if the axis adjusts the minimum.

Returns:

true if the axis adjusts the minimum

isAdjustMinimumByMajorUnit

public boolean isAdjustMinimumByMajorUnit()

Returns true if the axis adjusts the maximum.

Returns:

true if the axis adjusts the maximum

removeField

public void removeField(ValueProvider<? super M,? extends Number> field)

setAdjustMaximumByMajorUnit

public void setAdjustMaximumByMajorUnit(boolean adjustMaximumByMajorUnit)

Sets true if the axis adjusts the maximum.

Parameters:

adjustMaximumByMajorUnit - true if the axis adjusts the maximum

setAdjustMinimumByMajorUnit

public void setAdjustMinimumByMajorUnit(boolean adjustMinimumByMajorUnit)

Sets true if the axis adjusts the minimum.

Parameters:

adjustMinimumByMajorUnit - true if the axis adjusts the minimum

setFields

public void setFields(List<ValueProvider<? super M,? extends Number>> fields)

setInterval

public void setInterval(double interval)

Sets the interval between tick marks. Is overridden if the number of steps is also set. If no maximum or minimum is set, this will be treated as a suggestion, not a requirement.

Parameters:

interval - the interval between tick marks

setMaximum

public void setMaximum(double maximum)

Sets the maximum value of the axis. When the axis has either a minimum or maximum value set, the bounds of the axis will not be automatically adjusted.

Parameters:

maximum - the maximum value of the axis, or NaN to unset this property

setMinimum

public void setMinimum(double minimum)

Sets the minimum value of the axis. When the axis has either a minimum or maximum value set, the bounds of the axis will not be automatically adjusted.

Parameters:

minimum - the minimum value of the axis, or NaN to unset this property

setSteps

public void setSteps(int steps)

Sets the number of steps on the axis. If no maximum or minimum are set, this will be treated as a suggestion, not a requirement.

Parameters:

steps - the number of steps on the axis

applyData

protected void applyData()

Description copied from class: CartesianAxis

Applies the field data to the labels of the axis.

Specified by:

applyData in class CartesianAxis<M,Number>

createLabels

protected void createLabels()

Description copied from class: CartesianAxis

Creates the list of labels to display.

Specified by:

createLabels in class CartesianAxis<M,Number>