TimeSpanScaleOptions Class

Settings of a scale when its type is time-span.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(TimeSpanScaleOptionsTypeConverter))]
public class TimeSpanScaleOptions :
    ScaleOptionsBase,
    ITimeSpanScaleOptions,
    IScaleOptionsBase<TimeSpanMeasureUnitNative>,
    IScaleOptionsBase

VB.NET

<TypeConverter(GetType(TimeSpanScaleOptionsTypeConverter))>
Public Class TimeSpanScaleOptions
    Inherits ScaleOptionsBase
    Implements ITimeSpanScaleOptions,
               IScaleOptionsBase(Of TimeSpanMeasureUnitNative),
               IScaleOptionsBase

Related API Members

The following members return TimeSpanScaleOptions objects:

• AxisBase.TimeSpanScaleOptions

Example

The following example shows how to group minute-by-minute data into data points with a greater measurement unit (“Hour”).

To do this, you can use the following code:

C#

private void Form1_Load(object sender, EventArgs e) {
    XYDiagram diagram = chartControl1.Diagram as XYDiagram;
    if (diagram != null) {
        diagram.AxisX.TimeSpanScaleOptions.ScaleMode = ScaleMode.Manual;
        diagram.AxisX.TimeSpanScaleOptions.MeasureUnit = TimeSpanMeasureUnit.Hour;
        diagram.AxisX.TimeSpanScaleOptions.AggregateFunction = AggregateFunction.Average;
        diagram.AxisX.TimeSpanScaleOptions.GridSpacing = 6;
        diagram.AxisX.TimeSpanScaleOptions.GridAlignment = TimeSpanGridAlignment.Hour;
    }             
}

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim diagram As XYDiagram = TryCast(chartControl1.Diagram, XYDiagram)
    If diagram IsNot Nothing Then
        diagram.AxisX.TimeSpanScaleOptions.ScaleMode = ScaleMode.Manual
        diagram.AxisX.TimeSpanScaleOptions.MeasureUnit = TimeSpanMeasureUnit.Hour
        diagram.AxisX.TimeSpanScaleOptions.AggregateFunction = AggregateFunction.Average
        diagram.AxisX.TimeSpanScaleOptions.GridSpacing = 6
        diagram.AxisX.TimeSpanScaleOptions.GridAlignment = TimeSpanGridAlignment.Hour
    End If
End Sub

The example uses the following API members:

Member	Description
ScaleOptionsBase.ScaleMode	Gets or sets the scale mode for an axis.
TimeSpanScaleOptions.MeasureUnit	Gets or sets the detail level for time-span values.
ScaleGridOptionsBase.AggregateFunction	Gets or sets the value indicating the aggregate function that should be used to relieve data.
ScaleGridOptionsBase.GridSpacing	Gets or sets the interval between grid lines and major tickmarks.

Inheritance

Object

ChartElement

ScaleGridOptionsBase

ScaleOptionsBase

TimeSpanScaleOptions