com.telerik.widget.chart.engine.axes.categorical

Class CategoricalAxisModel

java.lang.Object

com.telerik.widget.chart.engine.propertyStore.PropertyBagObject

com.telerik.widget.chart.engine.elementTree.ChartNode

com.telerik.widget.chart.engine.elementTree.ChartElement

com.telerik.widget.chart.engine.axes.AxisModel

com.telerik.widget.chart.engine.axes.categorical.CategoricalAxisModel

All Implemented Interfaces:

AxisSupportsCombinedSeriesPlot

Direct Known Subclasses:

DateTimeCategoricalAxisModel

public class CategoricalAxisModel
extends AxisModel
implements AxisSupportsCombinedSeriesPlot

Handles the internal logic of the categorical axis in RadChartView.

Nested Class Summary

Nested classes/interfaces inherited from class com.telerik.widget.chart.engine.axes.AxisModel

AxisModel.StackValue

Nested classes/interfaces inherited from class com.telerik.widget.chart.engine.elementTree.ChartElement

ChartElement.Predicate<T>

Field Summary

Fields inherited from class com.telerik.widget.chart.engine.axes.AxisModel

PLOT_DIRECTION_PROPERTY_KEY, PLOT_ORIGIN_PROPERTY_KEY

Fields inherited from class com.telerik.widget.chart.engine.elementTree.ChartElement

children

Fields inherited from class com.telerik.widget.chart.engine.elementTree.ChartNode

PROPERTY_CHANGED_MESSAGE, PROPERTY_CHANGING_MESSAGE, trackPropertyChanged, trackPropertyChanging

Constructor Summary

Constructors

Constructor and Description
CategoricalAxisModel() Creates a new instance of the CategoricalAxisModel class.

Method Summary

Modifier and Type	Method and Description
Object	convertPhysicalUnitsToData(double coordinate) Calculates the value which corresponds to the provided axis coordinate.
AxisPlotInfo	createPlotInfo(Object value) Creates an instance of the AxisPlotInfo class containing the plot information about the provided axis value.
AxisLabelModel	generateLastLabel()
AxisPlotMode	getActualPlotMode() Gets a value from the AxisPlotMode enum depicting the plot mode actually used by the axis associated with this AxisModel.
Object	getCombineGroupKey(DataPoint point) Gets the key used to group series when combination mode like STACK is specified.
float	getGapLength() Gets or sets the length of the gap to be applied for each category.
int	getMajorTickInterval() Gets the step at which ticks are positioned.
AxisPlotMode	getPlotMode() Gets or sets the plot mode used to position points along the axis.
boolean	isDataReady()
int	majorTickCount() Gets the count of the major ticks currently generated in this AxisModel.
void	setGapLength(float value) Gets or sets the length of the gap to be applied for each category.
void	setMajorTickInterval(int value) Sets the step at which ticks are positioned.
void	setPlotMode(AxisPlotMode value)

Methods inherited from class com.telerik.widget.chart.engine.axes.AxisModel

applyLayoutRounding, canAddChild, desiredMargin, getDesiredSize, getFirstTick, getHorizontalLocation, getIsPrimary, getLabelContent, getLabelFitMode, getLabelFormat, getLabelInterval, getLabelLayoutMode, getLabelMargin, getLabelOffset, getLabels, getLabelValueToStringConverter, getLastLabelVisibility, getLastTick, getLineThickness, getMajorTickLength, getMajorTickOffset, getMajorTicks, getNormalizedLabelRotationAngle, getShowLabels, getStackValue, getTickThickness, getType, getVerticalLocation, getWidth, isPlotValid, isUpdated, measure, onPanOffsetChanged, onZoomChanged, plot, resetState, setHorizontalLocation, setIsPrimary, setLabelFitMode, setLabelFormat, setLabelInterval, setLabelLayoutMode, setLabelMargin, setLabelOffset, setLabelValueToStringConverter, setLastLabelVisibility, setLineThickness, setMajorTickLength, setMajorTickOffset, setNormalizedLabelRotationAngle, setShowLabels, setTickThickness, setType, setVerticalLocation, setWidth, ticks, title, update, updateTicksVisibility

Methods inherited from class com.telerik.widget.chart.engine.elementTree.ChartElement

enumDescendants, enumDescendants, enumDescendants, findAncestor, findDescendant, getPresenter, isAncestorOf, setPresenter

Methods inherited from class com.telerik.widget.chart.engine.elementTree.ChartNode

arrange, arrange, chartArea, clearValue, collectionIndex, getLayoutSlot, getNodeState, getParent, index, invalidate, isTreeLoaded, isVisible, load, setIsVisible, setParent, setValue

Methods inherited from class com.telerik.widget.chart.engine.propertyStore.PropertyBagObject

getTypedValue, getValue, isLocalValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoricalAxisModel

public CategoricalAxisModel()

Creates a new instance of the CategoricalAxisModel class.

Method Detail

getMajorTickInterval

public int getMajorTickInterval()

Gets the step at which ticks are positioned.

Returns:

The major tick interval.

setMajorTickInterval

public void setMajorTickInterval(int value)

Sets the step at which ticks are positioned.

Parameters:

value - The major tick interval.

getPlotMode

public AxisPlotMode getPlotMode()

Gets or sets the plot mode used to position points along the axis.

Returns:

The AxisPlotMode.

setPlotMode

public void setPlotMode(AxisPlotMode value)

getGapLength

public float getGapLength()

Gets or sets the length of the gap to be applied for each category.

Returns:

The gap length.

majorTickCount

public int majorTickCount()

Description copied from class: AxisModel

Gets the count of the major ticks currently generated in this AxisModel.

Specified by:

majorTickCount in class AxisModel

Returns:

the count of the major ticks.

setGapLength

public void setGapLength(float value)

Gets or sets the length of the gap to be applied for each category.

Parameters:

value - The new gap length.

isDataReady

public boolean isDataReady()

Overrides:

isDataReady in class AxisModel

getActualPlotMode

public AxisPlotMode getActualPlotMode()

Description copied from class: AxisModel

Gets a value from the AxisPlotMode enum depicting the plot mode actually used by the axis associated with this AxisModel.

Overrides:

getActualPlotMode in class AxisModel

Returns:

the AxisPlotMode value.

getCombineGroupKey

public Object getCombineGroupKey(DataPoint point)

Description copied from class: AxisModel

Gets the key used to group series when combination mode like STACK is specified. This method is used by the Chart engine and is not meant to be called by you.

Overrides:

getCombineGroupKey in class AxisModel

Returns:

an object representing the combine group key.

generateLastLabel

public AxisLabelModel generateLastLabel()

Specified by:

generateLastLabel in class AxisModel

createPlotInfo

public AxisPlotInfo createPlotInfo(Object value)

Description copied from class: AxisModel

Creates an instance of the AxisPlotInfo class containing the plot information about the provided axis value.

Overrides:

createPlotInfo in class AxisModel

Parameters:

value - the value to create the plot information for.

Returns:

the AxisPlotInfo instance.

convertPhysicalUnitsToData

public Object convertPhysicalUnitsToData(double coordinate)

Description copied from class: AxisModel

Calculates the value which corresponds to the provided axis coordinate.

Overrides:

convertPhysicalUnitsToData in class AxisModel

Parameters:

coordinate - the coordinate to calculate the value for.

Returns:

the calculated value.