ChartRangeControlClientDateTimeGridOptions Class

Contains specific settings which define the representation of date-time grid lines and labels in the chart range control client.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public class ChartRangeControlClientDateTimeGridOptions :
    ChartRangeControlClientGridOptions
Public Class ChartRangeControlClientDateTimeGridOptions
    Inherits ChartRangeControlClientGridOptions

Related API Members

The following members accept/return ChartRangeControlClientDateTimeGridOptions objects:

Remarks

Use the ChartRangeControlClientDateTimeOptions.RangeControlDateTimeGridOptions property to get access to the ChartRangeControlClientDateTimeGridOptions object.

Then, you can customize grid settings using the ChartRangeControlClientDateTimeGridOptions.GridAlignment, ChartRangeControlClientDateTimeGridOptions.SnapAlignment, ChartRangeControlClientGridOptions.SnapSpacing and ChartRangeControlClientGridOptions.GridSpacing properties.

NOTE

Grid properties provided by the ChartRangeControlClientDateTimeGridOptions class are calculated automatically, because the ChartRangeControlClientGridOptions.GridMode is set to Auto by default. When you change the default value of the specific property, this resets the grid automatic calculation (the ChartRangeControlClientGridOptions.GridMode is set to Manual).

To format chart client label values, use the ChartRangeControlClientGridOptions.LabelFormat property.

Examples

This example demonstrates how the grid lines and grid snapping of the chart within the range control's viewport can be customized at runtime.

To access the client options of the chart inside the range control's viewport, use the RangeControl.ClientOptions property. In this example, the chart control contains data with date-time arguments, so this property returns an object of the ChartRangeControlClientDateTimeOptions type.

To access the grid properties (e.g., ChartRangeControlClientGridOptions.SnapSpacing, ChartRangeControlClientDateTimeGridOptions.SnapAlignment, ChartRangeControlClientGridOptions.GridSpacing and ChartRangeControlClientDateTimeGridOptions.GridAlignment) of the chart range control client, access the ChartRangeControlClientDateTimeGridOptions object using the ChartRangeControlClientDateTimeOptions.RangeControlDateTimeGridOptions property.

using System;
using System.Windows.Forms;
using DevExpress.XtraCharts;

namespace DateTimeChartRangeControlClient {
    public partial class Form1 : Form {

        const int daysForYear = 30;

        public Form1() {
            InitializeComponent();

            // Call the InitializeChart method. 
            InitializeChart();

            // Specify a Chart control as the Range control client. 
            rangeControl1.Client = chartControl1;

            // Access the date-time grid options of the chart range control client.
            var clientOptions = (ChartRangeControlClientDateTimeOptions)rangeControl1.ClientOptions;
            ChartRangeControlClientDateTimeGridOptions gridOptions = clientOptions.RangeControlDateTimeGridOptions;

            // Specify the manual grid mode of the chart range control client. 
            gridOptions.GridMode = ChartRangeControlClientGridMode.Manual;

            // Customize snap and grid properties of the chart range control client.            
            gridOptions.SnapOffset = 2;
            gridOptions.SnapSpacing = 7;
            gridOptions.SnapAlignment = DateTimeGridAlignment.Day;
            gridOptions.GridSpacing = 7;
            gridOptions.GridAlignment = DateTimeGridAlignment.Day;
            gridOptions.GridOffset = 1;

            // Format labels of the chart range control client.
            gridOptions.LabelFormat = "D";
        }

        void InitializeChart() {

            DateTime baseDate = new DateTime(2000, 1, 1);
            Random rnd = new Random();
            Series series = new Series("Series", ViewType.Bar);

            for (int dayCount = 0; dayCount < daysForYear; dayCount++) {
                DateTime argument = baseDate.AddDays(dayCount);
                double value = rnd.Next(50, 100);
                var seriesPoint = new SeriesPoint(argument, value);
                series.Points.Add(seriesPoint);
            }
            chartControl1.Series.Add(series);
        }
    }
}

Inheritance

Object
ChartElement
ChartRangeControlClientGridOptions
ChartRangeControlClientDateTimeGridOptions
See Also