AxisModel

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

Direct Known Subclasses:

CategoricalAxisModel, DateTimeContinuousAxisModel, NumericalAxisModel
```
public abstract class AxisModel
extends ChartElement
```
This class represents the part of the Chart engine which calculates the position of labels, ticks and values on the different axes supported by the Chart component. This class is abstract and should not be used directly in your application.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class AxisModel.StackValue
- Nested classes/interfaces inherited from class com.telerik.widget.chart.engine.elementTree.ChartElement
  ChartElement.Predicate<T>

Nested Classes
Modifier and Type	Class and Description
`class`	`AxisModel.StackValue`

Field Summary

Fields
Modifier and Type Field and Description

static int PLOT_DIRECTION_PROPERTY_KEY

static int 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

Fields
Modifier and Type	Field and Description
`static int`	`PLOT_DIRECTION_PROPERTY_KEY`
`static int`	`PLOT_ORIGIN_PROPERTY_KEY`

Constructor Summary

Constructors
Constructor and Description

AxisModel()
Creates an instance of the AxisModel class.

Constructors
Constructor and Description
`AxisModel()` Creates an instance of the `AxisModel` class.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyLayoutRounding()` Applies layout snapping and corrects rounding errors.
`ModifyChildrenResult`	`canAddChild(ChartNode child)` Gets a `ModifyChildrenResult` value that determines if a child can be added to this element.
`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.
`RadThickness`	`desiredMargin()` Returns the desired margin for the axis associated with this `AxisModel`.
`abstract 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.
`RadSize`	`getDesiredSize()`
`AxisTickModel`	`getFirstTick()` Gets an instance of the `AxisTickModel` class representing the first tick of the axis.
`AxisHorizontalLocation`	`getHorizontalLocation()` Gets a `AxisHorizontalLocation` value determining the horizontal location of the axis (rendered vertically) in relation to the plot area.
`boolean`	`getIsPrimary()` Gets a boolean value determining whether the current `AxisModel` describes a primary axis in the associated chart.
`Object`	`getLabelContent(AxisTickModel tick)`
`AxisLabelFitMode`	`getLabelFitMode()` Gets a value from the `AxisLabelFitMode` enum which determines how labels are positioned on the axis.
`String`	`getLabelFormat()` Gets a string representing the format used to display the labels on the `Axis` associated with this `AxisModel`.
`int`	`getLabelInterval()` Gets the label interval in count of label positions.
`AxisLabelLayoutMode`	`getLabelLayoutMode()` Gets the label layout mode.
`float`	`getLabelMargin()` Gets the margin between the label and the axis line.
`int`	`getLabelOffset()` Gets the index of the label from the first label to be displayed.
`ElementCollection<AxisLabelModel>`	`getLabels()` Gets the `ElementCollection` instance holding all available labels on the axis.
`Function<Object,String>`	`getLabelValueToStringConverter()`
`AxisLastLabelVisibility`	`getLastLabelVisibility()` Gets a value from the `AxisLastLabelVisibility` enum which determines how the last axis label will be displayed.
`AxisTickModel`	`getLastTick()` Gets an instance of the `AxisTickModel` class representing the last tick of the axis.
`float`	`getLineThickness()` Gets the thickness of the `Axis` associated with this `AxisModel`.
`float`	`getMajorTickLength()` Gets the length of a single tick presented on the axis.
`int`	`getMajorTickOffset()` Gets the index of the tick from the first tick to be displayed.
`Iterable<AxisTickModel>`	`getMajorTicks()` Gets the `Iterable` collection with all the major ticks currently present on the axis.
`double`	`getNormalizedLabelRotationAngle()` Gets the normalized rotation angle of the labels.
`boolean`	`getShowLabels()` Gets a boolean value indicating whether labels will be displayed on this axis.
`AxisModel.StackValue`	`getStackValue(DataPoint point)` Gets the value for a DataPoint used by a CombineStrategy to calculate the stack sum for each stack group.
`float`	`getTickThickness()` Gets the thickness in pixels of a single tick presented on the axis.
`AxisType`	`getType()` Gets a value from the `AxisType` enum depicting the type of the axis represented by this `AxisModel`.
`AxisVerticalLocation`	`getVerticalLocation()` Gets a `AxisVerticalLocation` value determining the horizontal location of the axis (rendered horizontally) in relation to the plot area.
`int`	`getWidth()`
`boolean`	`isDataReady()`
`boolean`	`isPlotValid()` Gets a boolean value determining whether the current plot is valid.
`boolean`	`isUpdated()` Gets a boolean value indicating whether the current `AxisModel` class is in an up-to-date state.
`abstract int`	`majorTickCount()` Gets the count of the major ticks currently generated in this `AxisModel`.
`boolean`	`measure(RadSize availableSize)` Measures the axis associated with this `AxisModel` and initializes its desired size.
`void`	`onPanOffsetChanged()` Called when the pan offset of the owning chart changes.
`void`	`onZoomChanged()` Called when the zoom factor of the owning chart changes.
`void`	`plot(AxisUpdateContext context)` Plots the axis elements using the provided `AxisUpdateContext`.
`void`	`resetState()` Resets the state of the current `AxisModel` instance.
`void`	`setHorizontalLocation(AxisHorizontalLocation value)` Sets a `AxisHorizontalLocation` value determining the horizontal location of the axis (rendered vertically) in relation to the plot area.
`void`	`setIsPrimary(boolean value)` Sets a boolean value determining whether the current `AxisModel` describes a primary axis in the associated chart.
`void`	`setLabelFitMode(AxisLabelFitMode value)` Sets a value from the `AxisLabelFitMode` enum which determines how labels are positioned on the axis.
`void`	`setLabelFormat(String value)` Sets a string representing the format used to display the labels on the `Axis` associated with this `AxisModel`.
`void`	`setLabelInterval(int value)` Sets the label interval in count of label positions.
`void`	`setLabelLayoutMode(AxisLabelLayoutMode value)` Sets the labels layout mode.
`void`	`setLabelMargin(float value)` Sets the margin between the label and the axis line.
`void`	`setLabelOffset(int value)` Sets the index of the label from the first label to be displayed.
`void`	`setLabelValueToStringConverter(Function<Object,String> converter)`
`void`	`setLastLabelVisibility(AxisLastLabelVisibility value)` Gets a value from the `AxisLastLabelVisibility` enum which determines how the last axis label will be displayed.
`void`	`setLineThickness(float value)` Sets the thickness of the `Axis` associated with this `AxisModel`.
`void`	`setMajorTickLength(float value)` Sets the length of a single tick presented on the axis.
`void`	`setMajorTickOffset(int value)` Sets the index of the tick from the first tick to be displayed.
`void`	`setNormalizedLabelRotationAngle(double value)` Gets the normalized rotation angle of the labels.
`void`	`setShowLabels(boolean value)` Sets a value indicating whether labels will be displayed on this axis.
`void`	`setTickThickness(float value)` Sets the thickness in pixels of a single tick presented on the axis.
`void`	`setType(AxisType value)` Sets a value from the `AxisType` enum depicting the type of the axis represented by this `AxisModel`.
`void`	`setVerticalLocation(AxisVerticalLocation value)` Sets a `AxisVerticalLocation` value determining the horizontal location of the axis (rendered horizontally) in relation to the plot area.
`void`	`setWidth(int value)`
`ElementCollection<AxisTickModel>`	`ticks()` Returns an instance of the `ElementCollection` class holding all ticks associated with the current axis.
`AxisTitleModel`	`title()` Gets an instance of the `AxisTitleModel` class representing the title associated with this `AxisModel`
`void`	`update(AxisUpdateContext context)` Updates the current `AxisModel` instance with the provided `AxisUpdateContext`.
`void`	`updateTicksVisibility(RadRect clipRect)` Calculates which ticks should be visible according to the provided plot bounds.

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

- Field Detail
  - PLOT_ORIGIN_PROPERTY_KEY
```
public static final int PLOT_ORIGIN_PROPERTY_KEY
```
  - PLOT_DIRECTION_PROPERTY_KEY
```
public static final int PLOT_DIRECTION_PROPERTY_KEY
```
- Constructor Detail
  - AxisModel
```
public AxisModel()
```
    Creates an instance of the AxisModel class.
- Method Detail
  - getWidth
```
public int getWidth()
```
  - setWidth
```
public void setWidth(int value)
```
  - getDesiredSize
```
public RadSize getDesiredSize()
```
  - isUpdated
```
public boolean isUpdated()
```
    Gets a boolean value indicating whether the current AxisModel class is in an up-to-date state.
    
    Returns:
    
    true if the state is up to date, otherwise false.
  - getIsPrimary
```
public boolean getIsPrimary()
```
    Gets a boolean value determining whether the current AxisModel describes a primary axis in the associated chart.
    
    Returns:
    
    true if the axis is primary, otherwise false.
  - setIsPrimary
```
public void setIsPrimary(boolean value)
```
    Sets a boolean value determining whether the current AxisModel describes a primary axis in the associated chart.
    
    Parameters:
    
    value - true if the axis will be primary, otherwise false.
  - majorTickCount
```
public abstract int majorTickCount()
```
    Gets the count of the major ticks currently generated in this AxisModel.
    
    Returns:
    
    the count of the major ticks.
  - desiredMargin
```
public RadThickness desiredMargin()
```
    Returns the desired margin for the axis associated with this AxisModel.
    
    Returns:
    
    an instance of the RadThickness class describing the margin.
  - isPlotValid
```
public boolean isPlotValid()
```
    Gets a boolean value determining whether the current plot is valid.
    
    Returns:
    
    true if the plot is valid, otherwise false.
  - getLabelFormat
```
public String getLabelFormat()
```
    Gets a string representing the format used to display the labels on the Axis associated with this AxisModel.
    
    Returns:
    
    the label format.
  - setLabelFormat
```
public void setLabelFormat(String value)
```
    Sets a string representing the format used to display the labels on the Axis associated with this AxisModel.
    
    Parameters:
    
    value - the label format.
  - getLastLabelVisibility
```
public AxisLastLabelVisibility getLastLabelVisibility()
```
    Gets a value from the AxisLastLabelVisibility enum which determines how the last axis label will be displayed.
    
    Returns:
    
    the last label display mode.
  - setLastLabelVisibility
```
public void setLastLabelVisibility(AxisLastLabelVisibility value)
```
    Gets a value from the AxisLastLabelVisibility enum which determines how the last axis label will be displayed.
    
    Parameters:
    
    value - the last label display mode.
  - getLabelFitMode
```
public AxisLabelFitMode getLabelFitMode()
```
    Gets a value from the AxisLabelFitMode enum which determines how labels are positioned on the axis.
    
    Returns:
    
    the AxisLabelFitMode value.
  - setLabelFitMode
```
public void setLabelFitMode(AxisLabelFitMode value)
```
    Sets a value from the AxisLabelFitMode enum which determines how labels are positioned on the axis.
    
    Parameters:
    
    value - the AxisLabelFitMode value.
  - getLabelInterval
```
public int getLabelInterval()
```
    Gets the label interval in count of label positions.
    
    Returns:
    
    the count of the positions which represent the label interval.
  - setLabelInterval
```
public void setLabelInterval(int value)
```
    Sets the label interval in count of label positions.
    
    Parameters:
    
    value - the count of the positions which represent the label interval.
  - getLabelOffset
```
public int getLabelOffset()
```
    Gets the index of the label from the first label to be displayed.
  - setLabelOffset
```
public void setLabelOffset(int value)
```
    Sets the index of the label from the first label to be displayed.
  - getMajorTickOffset
```
public int getMajorTickOffset()
```
    Gets the index of the tick from the first tick to be displayed.
  - setMajorTickOffset
```
public void setMajorTickOffset(int value)
```
    Sets the index of the tick from the first tick to be displayed.
  - getNormalizedLabelRotationAngle
```
public double getNormalizedLabelRotationAngle()
```
    Gets the normalized rotation angle of the labels.
    
    Returns:
    
    the rotation angle.
  - setNormalizedLabelRotationAngle
```
public void setNormalizedLabelRotationAngle(double value)
```
    Gets the normalized rotation angle of the labels.
    
    Parameters:
    
    value - the rotation angle.
  - getMajorTicks
```
public Iterable<AxisTickModel> getMajorTicks()
```
    Gets the Iterable collection with all the major ticks currently present on the axis.
  - getLabels
```
public ElementCollection<AxisLabelModel> getLabels()
```
    Gets the ElementCollection instance holding all available labels on the axis.
  - getTickThickness
```
public float getTickThickness()
```
    Gets the thickness in pixels of a single tick presented on the axis.
    
    Returns:
    
    the thickness.
  - setTickThickness
```
public void setTickThickness(float value)
```
    Sets the thickness in pixels of a single tick presented on the axis.
    
    Parameters:
    
    value - the thickness.
  - getLabelMargin
```
public float getLabelMargin()
```
    Gets the margin between the label and the axis line.
    
    Returns:
    
    the label margin.
  - setLabelMargin
```
public void setLabelMargin(float value)
```
    Sets the margin between the label and the axis line.
    
    Parameters:
    
    value - The label margin.
  - getShowLabels
```
public boolean getShowLabels()
```
    Gets a boolean value indicating whether labels will be displayed on this axis.
    
    Returns:
    
    true if labels are shown, otherwise false.
  - setShowLabels
```
public void setShowLabels(boolean value)
```
    Sets a value indicating whether labels will be displayed on this axis.
    
    Parameters:
    
    value - true if labels are shown, otherwise false.
  - getLabelLayoutMode
```
public AxisLabelLayoutMode getLabelLayoutMode()
```
    Gets the label layout mode. See AxisLabelLayoutMode for more information.
  - setLabelLayoutMode
```
public void setLabelLayoutMode(AxisLabelLayoutMode value)
```
    Sets the labels layout mode. The default value is OUTER. See AxisLabelLayoutMode for more information.
    
    Parameters:
    
    value - The new layout mode.
  - getMajorTickLength
```
public float getMajorTickLength()
```
    Gets the length of a single tick presented on the axis. The default tick length is 5.
    
    Returns:
    
    the tick length.
  - setMajorTickLength
```
public void setMajorTickLength(float value)
```
    Sets the length of a single tick presented on the axis.
    
    Parameters:
    
    value - the tick length.
  - getLineThickness
```
public float getLineThickness()
```
    Gets the thickness of the Axis associated with this AxisModel.
    
    Returns:
    
    the thickness of the Axis.
  - setLineThickness
```
public void setLineThickness(float value)
```
    Sets the thickness of the Axis associated with this AxisModel.
    
    Parameters:
    
    value - the thickness of the Axis.
  - getHorizontalLocation
```
public AxisHorizontalLocation getHorizontalLocation()
```
    Gets a AxisHorizontalLocation value determining the horizontal location of the axis (rendered vertically) in relation to the plot area.
    
    Returns:
    
    the AxisHorizontalLocation value.
  - setHorizontalLocation
```
public void setHorizontalLocation(AxisHorizontalLocation value)
```
    Sets a AxisHorizontalLocation value determining the horizontal location of the axis (rendered vertically) in relation to the plot area.
    
    Parameters:
    
    value - the AxisHorizontalLocation value.
  - getVerticalLocation
```
public AxisVerticalLocation getVerticalLocation()
```
    Gets a AxisVerticalLocation value determining the horizontal location of the axis (rendered horizontally) in relation to the plot area.
    
    Returns:
    
    the AxisVerticalLocation value.
  - setVerticalLocation
```
public void setVerticalLocation(AxisVerticalLocation value)
```
    Sets a AxisVerticalLocation value determining the horizontal location of the axis (rendered horizontally) in relation to the plot area.
    
    Parameters:
    
    value - the AxisVerticalLocation value.
  - getFirstTick
```
public AxisTickModel getFirstTick()
```
    Gets an instance of the AxisTickModel class representing the first tick of the axis. Can be called when the axis is loaded.
    
    Returns:
    
    the AxisTickModel instance.
  - getLastTick
```
public AxisTickModel getLastTick()
```
    Gets an instance of the AxisTickModel class representing the last tick of the axis. Can be called when the axis is loaded.
    
    Returns:
    
    the AxisTickModel instance.
  - getType
```
public AxisType getType()
```
    Gets a value from the AxisType enum depicting the type of the axis represented by this AxisModel.
    
    Returns:
    
    the AxisType value.
  - setType
```
public void setType(AxisType value)
```
    Sets a value from the AxisType enum depicting the type of the axis represented by this AxisModel.
    
    Parameters:
    
    value - the AxisType value.
  - title
```
public AxisTitleModel title()
```
    Gets an instance of the AxisTitleModel class representing the title associated with this AxisModel
    
    Returns:
    
    the AxisTitleModel instance.
  - getActualPlotMode
```
public AxisPlotMode getActualPlotMode()
```
    Gets a value from the AxisPlotMode enum depicting the plot mode actually used by the axis associated with this AxisModel.
    
    Returns:
    
    the AxisPlotMode value.
  - ticks
```
public ElementCollection<AxisTickModel> ticks()
```
    Returns an instance of the ElementCollection class holding all ticks associated with the current axis.
    
    Returns:
    
    the ElementCollection instance.
  - applyLayoutRounding
```
public void applyLayoutRounding()
```
    Description copied from class: ChartNode
    
    Applies layout snapping and corrects rounding errors.
    
    Overrides:
    
    applyLayoutRounding in class ChartNode
  - resetState
```
public void resetState()
```
    Resets the state of the current AxisModel instance. Marks the plot data and the layout params as invalid and resets the range.
  - onZoomChanged
```
public void onZoomChanged()
```
    Called when the zoom factor of the owning chart changes.
  - onPanOffsetChanged
```
public void onPanOffsetChanged()
```
    Called when the pan offset of the owning chart changes.
  - update
```
public void update(AxisUpdateContext context)
```
    Updates the current AxisModel instance with the provided AxisUpdateContext. Called by the associated ChartAreaModel.
    
    Parameters:
    
    context - the AxisUpdateContext used for the update.
  - measure
```
public boolean measure(RadSize availableSize)
```
    Measures the axis associated with this AxisModel and initializes its desired size.
    
    Parameters:
    
    availableSize - an instance of RadSize depicting the measure size for the axis.
    
    Returns:
    
    true if a measure pass was performed, otherwise false.
  - plot
```
public void plot(AxisUpdateContext context)
```
    Plots the axis elements using the provided AxisUpdateContext.
    
    Parameters:
    
    context - the AxisUpdateContext
  - updateTicksVisibility
```
public void updateTicksVisibility(RadRect clipRect)
```
    Calculates which ticks should be visible according to the provided plot bounds.
    
    Parameters:
    
    clipRect - an instance of the RadRect class describing the plot bounds.
  - getCombineGroupKey
```
public Object getCombineGroupKey(DataPoint point)
```
    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.
    
    Returns:
    
    an object representing the combine group key.
  - getLabelValueToStringConverter
```
public Function<Object,String> getLabelValueToStringConverter()
```
  - setLabelValueToStringConverter
```
public void setLabelValueToStringConverter(Function<Object,String> converter)
```
  - getStackValue
```
public AxisModel.StackValue getStackValue(DataPoint point)
```
    Gets the value for a DataPoint used by a CombineStrategy to calculate the stack sum for each stack group.
    
    Parameters:
    
    point - the point for which we need to get the stack value.
  - isDataReady
```
public boolean isDataReady()
```
  - getLabelContent
```
public Object getLabelContent(AxisTickModel tick)
```
  - canAddChild
```
public ModifyChildrenResult canAddChild(ChartNode child)
```
    Description copied from class: ChartElement
    
    Gets a ModifyChildrenResult value that determines if a child can be added to this element.
    
    Overrides:
    
    canAddChild in class ChartElement
    
    Parameters:
    
    child - The child to be considered.
  - createPlotInfo
```
public AxisPlotInfo createPlotInfo(Object value)
```
    Creates an instance of the AxisPlotInfo class containing the plot information about the provided axis value.
    
    Parameters:
    
    value - the value to create the plot information for.
    
    Returns:
    
    the AxisPlotInfo instance.
  - convertPhysicalUnitsToData
```
public Object convertPhysicalUnitsToData(double coordinate)
```
    Calculates the value which corresponds to the provided axis coordinate.
    
    Parameters:
    
    coordinate - the coordinate to calculate the value for.
    
    Returns:
    
    the calculated value.
  - generateLastLabel
```
public abstract AxisLabelModel generateLastLabel()
```

Class AxisModel

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

PLOT_ORIGIN_PROPERTY_KEY

PLOT_DIRECTION_PROPERTY_KEY

Constructor Detail

AxisModel

Method Detail

getWidth

setWidth

getDesiredSize

isUpdated

getIsPrimary

setIsPrimary

majorTickCount

desiredMargin

isPlotValid

getLabelFormat

setLabelFormat

getLastLabelVisibility

setLastLabelVisibility

getLabelFitMode

setLabelFitMode

getLabelInterval

setLabelInterval

getLabelOffset

setLabelOffset

getMajorTickOffset

setMajorTickOffset

getNormalizedLabelRotationAngle

setNormalizedLabelRotationAngle

getMajorTicks

getLabels

getTickThickness

setTickThickness

getLabelMargin

setLabelMargin

getShowLabels

setShowLabels

getLabelLayoutMode

setLabelLayoutMode

getMajorTickLength

setMajorTickLength

getLineThickness

setLineThickness

getHorizontalLocation

setHorizontalLocation

getVerticalLocation

setVerticalLocation

getFirstTick

getLastTick

getType

setType

title

getActualPlotMode

ticks

applyLayoutRounding

resetState

onZoomChanged

onPanOffsetChanged

update

measure

plot

updateTicksVisibility

getCombineGroupKey

getLabelValueToStringConverter

setLabelValueToStringConverter

getStackValue

isDataReady

getLabelContent