DateTimeScaleOptions Class

Contains settings for an axis scale when its data type is date-time.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(DateTimeScaleOptionsTypeConverter))]
public sealed class DateTimeScaleOptions :
    ScaleOptionsBase,
    IDateTimeScaleOptions,
    IScaleOptionsDivisionModeSupport<DateTimeMeasureUnitNative>,
    IScaleOptionsBase<DateTimeMeasureUnitNative>,
    IScaleOptionsBase,
    IXtraSupportDeserializeCollectionItem

VB.NET

<TypeConverter(GetType(DateTimeScaleOptionsTypeConverter))>
Public NotInheritable Class DateTimeScaleOptions
    Inherits ScaleOptionsBase
    Implements IDateTimeScaleOptions,
               IScaleOptionsDivisionModeSupport(Of DateTimeMeasureUnitNative),
               IScaleOptionsBase(Of DateTimeMeasureUnitNative),
               IScaleOptionsBase,
               IXtraSupportDeserializeCollectionItem

Related API Members

The following members return DateTimeScaleOptions objects:

• AxisBase.DateTimeScaleOptions

Remarks

An object of the DateTimeScaleOptions type is returned by the AxisBase.DateTimeScaleOptions property.

Example

This example shows how to use DateTimeScaleOptions to reduce the number of visible series points.

The following code configures the axis scale settings to resemble to the chart appearance above:

C#

DateTimeScaleOptions dateTimeScaleOptions = ((XYDiagram)chartControl.Diagram).AxisX.DateTimeScaleOptions;

dateTimeScaleOptions.WorkdaysOnly = true;
dateTimeScaleOptions.ScaleMode = ScaleMode.Manual;
dateTimeScaleOptions.AggregateFunction = AggregateFunction.Average;
dateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Month;
dateTimeScaleOptions.GridAlignment = DateTimeGridAlignment.Quarter;
dateTimeScaleOptions.GridSpacing = 1;

VB.NET

Dim dateTimeScaleOptions As DateTimeScaleOptions = CType(chartControl.Diagram,XYDiagram).AxisX.DateTimeScaleOptions

dateTimeScaleOptions.WorkdaysOnly = true
dateTimeScaleOptions.ScaleMode = ScaleMode.Manual
dateTimeScaleOptions.AggregateFunction = AggregateFunction.Average
dateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Month
dateTimeScaleOptions.GridAlignment = DateTimeGridAlignment.Quarter
dateTimeScaleOptions.GridSpacing = 1

The following table lists the API members the code above uses:

Member	Description
AxisBase.DateTimeScaleOptions	Stores the options that define the behavior of a scale when its type is date-time.
ScaleOptionsBase.ScaleMode	Gets or sets the scale mode for an axis.
ScaleMode	Lists the values that specify the scale mode for an axis.
DateTimeScaleOptions.MeasureUnit	Gets or sets the detail level for date-time values.
DateTimeMeasureUnit	Lists the values that specify the detail level for date-time values.
ScaleGridOptionsBase.GridOffset	Gets or sets the offset of grid lines and major tickmarks.
ScaleGridOptionsBase.AggregateFunction	Gets or sets the value indicating the aggregate function that should be used to relieve data.
AggregateFunction	Lists the values that specify the aggregate function used for an axis.
DateTimeScaleOptions.GridAlignment	Gets or sets the date-time measure unit to which the beginning of an axis’ gridlines and labels should be aligned.
DateTimeGridAlignment	Lists the values that specify the date-time measurement unit, to which the beginning of a diagram’s gridlines and labels should be aligned.
ScaleGridOptionsBase.GridSpacing	Gets or sets the interval between grid lines and major tickmarks.

Implements

IXtraSupportDeserializeCollectionItem

Inheritance

Object

ChartElement

ScaleGridOptionsBase

ScaleOptionsBase

DateTimeScaleOptions