Back to Devexpress

TimeSpanScaleOptions.MeasureUnit Property

corelibraries-devexpress-dot-xtracharts-dot-timespanscaleoptions.md

latest5.6 KB
Original Source

TimeSpanScaleOptions.MeasureUnit Property

Gets or sets the detail level for time-span values.

Namespace : DevExpress.XtraCharts

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
public TimeSpanMeasureUnit MeasureUnit { get; set; }
vb
Public Property MeasureUnit As TimeSpanMeasureUnit

Property Value

TypeDescription
TimeSpanMeasureUnit

A value that represents the axis detail level.

|

Available values:

NameDescription
Millisecond

Specifies a millisecond as the measurement unit for time-span values.

| | Second |

Specifies a second as the measurement unit for time-span values.

| | Minute |

Specifies a minute as the measurement unit for time-span values.

| | Hour |

Specifies an hour as the measurement unit for time-span values.

| | Day |

Specifies a day as the measurement unit for time-span values.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to MeasureUnit
AxisBase

.TimeSpanScaleOptions .MeasureUnit

|

Remarks

This property is available when the SeriesBase.ArgumentScaleType or SeriesBase.ValueScaleType property is set to TimeSpan , and the ScaleOptionsBase.ScaleMode property is set to Manual.

TimeSpanScaleOptions.MeasureUnit = MinuteTimeSpanScaleOptions.MeasureUnit = Hour

Note

To access TimeSpanScaleOptions, use the AxisBase.TimeSpanScaleOptions property.

To define a time-span measurement unit to which the beginning of a diagram’s gridlines and labels should be aligned, use the TimeSpanScaleOptions.GridAlignment property.

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:

csharp
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
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:

MemberDescription
ScaleOptionsBase.ScaleModeGets or sets the scale mode for an axis.
TimeSpanScaleOptions.MeasureUnitGets or sets the detail level for time-span values.
ScaleGridOptionsBase.AggregateFunctionGets or sets the value indicating the aggregate function that should be used to relieve data.
ScaleGridOptionsBase.GridSpacingGets or sets the interval between grid lines and major tickmarks.

See Also

TimeSpanScaleOptions Class

TimeSpanScaleOptions Members

DevExpress.XtraCharts Namespace