Class
DateTimeScale

A graph axis scale that displays dates in chronological order at specific intervals, or base units, even if the dates from the data source are not in order or in the same base units.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
public class DateTimeScale : Scale

Inheritance: objectScaleDateTimeScale

Inherited Members Scale.GetDefaultCrossAxisPosition(bool)Scale.ToString()Scale.ReversedScale.CrossAxisPositionScale.SpacingSlotCount

Constructors

DateTimeScale()

TODO: Add documentation.

Declaration

cs-api-definition
public DateTimeScale()

Properties

BaseUnit

Gets or sets the base unit for the current DateTimeScale. The base unit defines the interval between the points on the axis. By default the base units are according to the smallest difference between any two dates in the data.

Declaration

cs-api-definition
public DateTimeScaleUnits BaseUnit { get; set; }

Property Value

DateTimeScaleUnits

CrossAxisPositions

TODO: Add documentation.

Declaration

cs-api-definition
public DateTimeScaleCrossAxisPositionCollection CrossAxisPositions { get; }

Property Value

DateTimeScaleCrossAxisPositionCollection

CrossAxisValue

Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific. Zero value is where the other axis crosses the current axis.

Declaration

cs-api-definition
[Obsolete("The CrossAxisValue property is now obsolete. Please use the CrossAxisPositions property instead.")]
[Browsable(false)]
public DateTime CrossAxisValue { get; set; }

Property Value

DateTime

DataPointTicks

Gets or sets a value indicating weather to shows ticks and labels on the axis for every point in the data set instead of regular major ticks.

Declaration

cs-api-definition
public bool DataPointTicks { get; set; }

Property Value

bool

LabelStep

Gets or sets the step/interval between the labels. In conjunction with the LabelUnit property defines the interval between the labels on the axis, ex.: 1 day, 3 months, 1 year. The property is applied only when LabelUnit is set to a value other than Auto.

Declaration

cs-api-definition
public int LabelStep { get; set; }

Property Value

int

LabelUnit

Gets or sets the unit for the interval/step between the labels. In conjunction with the LabelStep property defines the interval between the labels on the axis, ex.: 1 day, 3 months, 1 year.

Declaration

cs-api-definition
public DateTimeScaleUnits LabelUnit { get; set; }

Property Value

DateTimeScaleUnits

MajorStep

Gets or sets the step/interval between the major ticks/grid lines. In conjunction with the MajorUnit property defines the interval between the major ticks and major grid lines, ex.: 1 day, 3 months, 1 year.

Declaration

cs-api-definition
public int MajorStep { get; set; }

Property Value

int

MajorUnit

Gets or sets the unit for the interval/step between the major ticks/grid lines. In conjunction with the MajorStep property defines the interval between the major ticks and major grid lines, ex.: 1 day, 3 months, 1 year.

Declaration

cs-api-definition
public DateTimeScaleUnits MajorUnit { get; set; }

Property Value

DateTimeScaleUnits

Maximum

Gets or sets the maximum value for the current axis.

Declaration

cs-api-definition
public DateTime? Maximum { get; set; }

Property Value

DateTime?

A DateTime value that is the maximum value of the scale's range. The default value is null.

Remarks

When the Maximum property is set to null (Nothing in Visual Basic) then the maximum value of the scale's range is defined by the data. In case there are no data points available then the Maximum value is set according to Now and the selected BaseUnit. In case the Maximum and Minimum values are set to an equal value, then their values are ignored.

Minimum

Gets or sets the minimum value for the current axis.

Declaration

cs-api-definition
public DateTime? Minimum { get; set; }

Property Value

DateTime?

A DateTime value that is the minimum value of the scale's range. The default value is null.

Remarks

When the Minimum property is set to null (Nothing in Visual Basic) then the minimum value of the scale's range is defined by the data. In case there are no data points available then the Minimum value is set according to Now and the selected BaseUnit. In case the Maximum and Minimum values are set to an equal value, then their values are ignored.

MinorStep

Gets or sets the step/interval for the minor ticks/grid lines. In conjunction with the MinorStep property defines the interval between the minor ticks and minor grid lines, ex.: 1 day, 3 months, 1 year.

Declaration

cs-api-definition
public int MinorStep { get; set; }

Property Value

int

MinorUnit

Gets or sets the unit for the interval/step between the minor ticks/grid lines. In conjunction with the MinorStep property defines the interval between the minor ticks and minor grid lines, ex.: 1 day, 3 months, 1 year.

Declaration

cs-api-definition
public DateTimeScaleUnits MinorUnit { get; set; }

Property Value

DateTimeScaleUnits

PositionMode

TODO: Add documentation.

Declaration

cs-api-definition
public AxisPositionMode PositionMode { get; set; }

Property Value

AxisPositionMode