com.telerik.widget.chart.engine.axes.continuous

Class DateTimeContinuousAxisModel

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.continuous.DateTimeContinuousAxisModel

All Implemented Interfaces:

AxisSupportsCombinedSeriesPlot, ContinuousAxisModel

public class DateTimeContinuousAxisModel
extends AxisModel
implements ContinuousAxisModel, AxisSupportsCombinedSeriesPlot

Defines a date axis that uses the actual time-line to plot series points.

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
DateTimeContinuousAxisModel() Creates a new instance of the DateTimeContinuousAxisModel.

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.
ValueRange<Calendar>	getActualRange() Gets the actual ValueRange of this axis.
Object	getCombineGroupKey(DataPoint point) Gets the key used to group series when combination mode like STACK is specified.
DateFormat	getDateFormat()
double	getGapLength() Gets the gap length.
double	getMajorStep() Gets a custom major step of the axis.
TimeInterval	getMajorStepUnit() Gets the unit that defines the custom major step of the axis.
Calendar	getMaximum() Gets the custom maximum of the axis.
int	getMaximumTicks() Gets the maximum ticks that might be displayed on the axis.
Calendar	getMinimum() Gets the custom minimum of the axis.
AxisPlotMode	getPlotMode() Gets the AxisPlotMode used to position points along the axis.
DateFormat	getSourceDateFormat()
int	majorTickCount() Gets the count of the major ticks currently generated in this AxisModel.
void	onZoomChanged() Called when the zoom factor of the owning chart changes.
void	resetState() Resets the state of the current AxisModel instance.
void	setDateFormat(DateFormat value)
void	setGapLength(double value) Sets the gap length.
void	setMajorStep(double value) Sets a custom major step of the axis.
void	setMajorStepUnit(TimeInterval value) Sets the unit that defines the custom major step of the axis.
void	setMaximum(Calendar value) Sets the custom maximum of the axis.
void	setMaximumTicks(int value) Sets the maximum ticks that might be displayed on the axis.
void	setMinimum(Calendar value) Sets the custom minimum of the axis.
void	setPlotMode(AxisPlotMode value) Sets the AxisPlotMode used to position points along the axis.
void	setSourceDateFormat(DateFormat 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, isDataReady, isPlotValid, isUpdated, measure, onPanOffsetChanged, plot, 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

DateTimeContinuousAxisModel

public DateTimeContinuousAxisModel()

Creates a new instance of the DateTimeContinuousAxisModel.

Method Detail

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.

getGapLength

public double getGapLength()

Gets the gap length.

Returns:

The gap length.

setGapLength

public void setGapLength(double value)

Sets the gap length.

Parameters:

value - The gap length.

getPlotMode

public AxisPlotMode getPlotMode()

Gets the AxisPlotMode used to position points along the axis.

Returns:

The plot mode.

setPlotMode

public void setPlotMode(AxisPlotMode value)

Sets the AxisPlotMode used to position points along the axis.

Parameters:

value - The plot mode.

getMajorStep

public double getMajorStep()

Gets a custom major step of the axis. The TimeInterval between each tick is calculated by using this value and the setMajorStepUnit(TimeInterval). Specify Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to clear the custom value and to generate the step automatically.

Returns:

The major step.

setMajorStep

public void setMajorStep(double value)

Sets a custom major step of the axis. The TimeInterval between each tick depends on the major step and the major step unit, set through setMajorStepUnit(com.telerik.widget.chart.engine.axes.common.TimeInterval). If the major step is set to 0.0, the value is reset and the steps are generated automatically.

Parameters:

value - The user-defined major step of the axis

getMajorStepUnit

public TimeInterval getMajorStepUnit()

Gets the unit that defines the custom major step of the axis. If no explicit step is defined, the axis will automatically calculate one, depending on the smallest difference between any two dates.

Returns:

The major step unit.

setMajorStepUnit

public void setMajorStepUnit(TimeInterval value)

Sets the unit that defines the custom major step of the axis. If no explicit step is defined, the axis will automatically calculate one, depending on the smallest difference between any two dates.

Parameters:

value - The major step unit.

getActualRange

public ValueRange<Calendar> getActualRange()

Gets the actual ValueRange of this axis.

Returns:

The value range.

getMinimum

public Calendar getMinimum()

Gets the custom minimum of the axis. Specify the calendar min value to clear the property value so that the minimum is auto-generated.

Returns:

The minimum value of the axis.

setMinimum

public void setMinimum(Calendar value)

Sets the custom minimum of the axis. Specify the Calendar min value to clear the property value so that the minimum is auto-generated.

Parameters:

value - The minimum value of the axis.

getMaximum

public Calendar getMaximum()

Gets the custom maximum of the axis. Specify Calendar max value to clear the property value so that the maximum is auto-generated.

Returns:

The maximum date of the axis.

setMaximum

public void setMaximum(Calendar value)

Sets the custom maximum of the axis. Specify Calendar max value to clear the property value so that the maximum is auto-generated.

Parameters:

value - The maximum date of the axis.

getMaximumTicks

public int getMaximumTicks()

Gets the maximum ticks that might be displayed on the axis. There are corner cases when ticks may become really huge number. Defaults to 31.

Returns:

The maximum ticks.

setMaximumTicks

public void setMaximumTicks(int value)

Sets the maximum ticks that might be displayed on the axis. There are corner cases when ticks may become really huge number. Defaults to 31.

Parameters:

value - The maximum ticks.

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.

resetState

public void resetState()

Description copied from class: AxisModel

Resets the state of the current AxisModel instance. Marks the plot data and the layout params as invalid and resets the range.

Overrides:

resetState in class AxisModel

onZoomChanged

public void onZoomChanged()

Description copied from class: AxisModel

Called when the zoom factor of the owning chart changes.

Overrides:

onZoomChanged in class AxisModel

setDateFormat

public void setDateFormat(DateFormat value)

getDateFormat

public DateFormat getDateFormat()

setSourceDateFormat

public void setSourceDateFormat(DateFormat value)

getSourceDateFormat

public DateFormat getSourceDateFormat()

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.

generateLastLabel

public AxisLabelModel generateLastLabel()

Specified by:

generateLastLabel in class AxisModel

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.