ClientDataSourceProviderCustomizeSeriesEventArgs.View Property

Gets or sets the view type for the chart range control client.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public ChartRangeControlClientView View { get; set; }

VB.NET

Public Property View As ChartRangeControlClientView

Property Value

Type	Description
ChartRangeControlClientView	A ChartRangeControlClientView object descendant that is the chart client view type.

Remarks

Use the View property to specify a chart client view to display numeric or date-time data as lines or areas.

Note that chart clients show a Line view by default.

Example

This example shows how to adjust series of a numeric chart range control client using the ChartRangeControlClientBase.CustomizeSeries event. This event occurs before a series of the chart range control client is drawn in the range control’s viewport.

Use the ClientDataSourceProviderCustomizeSeriesEventArgs.View property to change the series view of the chart range control client. In addition, you can access the data source value using the ClientDataSourceProviderCustomizeSeriesEventArgs.DataSourceValue property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-series-of-a-chart-range-control-client-at-runtime-t130182

Form1.cs

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraEditors;

namespace ChartClientCustomizeSeries {
    public partial class Form1 : Form {

        const int pointCount = 20;
        const int seriesCount = 3;
        Random rand = new Random();
        List<NumericItem> data = new List<NumericItem>();

        public Form1() {
            InitializeComponent();
            SetUpNumericChartRangeControlClient();
        }

        private void numericChartRangeControlClient1_CustomizeSeries(object sender, ClientDataSourceProviderCustomizeSeriesEventArgs e) {

            // Change the default Line view of the chart client to Area. 
            AreaChartRangeControlClientView areaView = new AreaChartRangeControlClientView();
            e.View = areaView;

            // Customize the Area view properties.
            areaView.AreaOpacity = 30;
            areaView.LineWidth = 1;
            areaView.ShowMarkers = true;
            areaView.MarkerColor = Color.Purple;
            areaView.MarkerSize = 3;

            // Change the Area series color.  
            if (e.DataSourceValue.ToString() == "Series0") {
                e.View.Color = Color.Red;
            }
            if (e.DataSourceValue.ToString() == "Series1") {
                e.View.Color = Color.Blue;
            }
            if (e.DataSourceValue.ToString() == "Series2") {
                e.View.Color = Color.Orange;
            }
        }

        private void SetUpNumericChartRangeControlClient() {

            // Assign a numeric chart client to the Range control. 
            rangeControl1.Client = numericChartRangeControlClient1;

            // Generate a list of NumericItem objects and bind the numeric chart client to it.
            numericChartRangeControlClient1.DataProvider.DataSource = GenerateNumericData();

            // Handle the CustomizeSeries event.
            numericChartRangeControlClient1.CustomizeSeries += numericChartRangeControlClient1_CustomizeSeries;

            // Specify data members to bind the chart client.         
            numericChartRangeControlClient1.DataProvider.ArgumentDataMember = "Argument";
            numericChartRangeControlClient1.DataProvider.ValueDataMember = "Value";
            numericChartRangeControlClient1.DataProvider.SeriesDataMember = "Series";

            // Customize the grid options of the numeric chart range control client.          
            numericChartRangeControlClient1.GridOptions.GridSpacing = 2;
            numericChartRangeControlClient1.GridOptions.SnapSpacing = 1;
        }

        List<NumericItem> GenerateNumericData() {

            for (int seriesIndex = 0; seriesIndex < seriesCount; seriesIndex++) {
                for (int i = 0; i < pointCount; i++) {
                    data.Add(new NumericItem() {
                        Argument = i,
                        Value = rand.Next(0, 30) + i,
                        Series = "Series" + seriesIndex.ToString()
                    });
                }
            }
            return data;
        }
    }

    public class NumericItem {
        public double Argument { get; set; }
        public double Value { get; set; }
        public string Series { get; set; }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraEditors

Namespace ChartClientCustomizeSeries
    Partial Public Class Form1
        Inherits Form

        Private Const pointCount As Integer = 20
        Private Const seriesCount As Integer = 3
        Private rand As New Random()
        Private data As New List(Of NumericItem)()

        Public Sub New()
            InitializeComponent()
            SetUpNumericChartRangeControlClient()
        End Sub

        Private Sub numericChartRangeControlClient1_CustomizeSeries(ByVal sender As Object, ByVal e As ClientDataSourceProviderCustomizeSeriesEventArgs)

            ' Change the default Line view of the chart client to Area. 
            Dim areaView As New AreaChartRangeControlClientView()
            e.View = areaView

            ' Customize the Area view properties.
            areaView.AreaOpacity = 30
            areaView.LineWidth = 1
            areaView.ShowMarkers = True
            areaView.MarkerColor = Color.Purple
            areaView.MarkerSize = 3

            ' Change the Area series color.  
            If e.DataSourceValue.ToString() = "Series0" Then
                e.View.Color = Color.Red
            End If
            If e.DataSourceValue.ToString() = "Series1" Then
                e.View.Color = Color.Blue
            End If
            If e.DataSourceValue.ToString() = "Series2" Then
                e.View.Color = Color.Orange
            End If
        End Sub

        Private Sub SetUpNumericChartRangeControlClient()

            ' Assign a numeric chart client to the Range control. 
            rangeControl1.Client = numericChartRangeControlClient1

            ' Generate a list of NumericItem objects and bind the numeric chart client to it.
            numericChartRangeControlClient1.DataProvider.DataSource = GenerateNumericData()

            ' Handle the CustomizeSeries event.
            AddHandler numericChartRangeControlClient1.CustomizeSeries, AddressOf numericChartRangeControlClient1_CustomizeSeries

            ' Specify data members to bind the chart client.         
            numericChartRangeControlClient1.DataProvider.ArgumentDataMember = "Argument"
            numericChartRangeControlClient1.DataProvider.ValueDataMember = "Value"
            numericChartRangeControlClient1.DataProvider.SeriesDataMember = "Series"

            ' Customize the grid options of the numeric chart range control client.          
            numericChartRangeControlClient1.GridOptions.GridSpacing = 2
            numericChartRangeControlClient1.GridOptions.SnapSpacing = 1
        End Sub

        Private Function GenerateNumericData() As List(Of NumericItem)

            For seriesIndex As Integer = 0 To seriesCount - 1
                For i As Integer = 0 To pointCount - 1
                    data.Add(New NumericItem() With {.Argument = i, .Value = rand.Next(0, 30) + i, .Series = "Series" & seriesIndex.ToString()})
                Next i
            Next seriesIndex
            Return data
        End Function
    End Class

    Public Class NumericItem
        Private privateArgument As Double
        Public Property Argument() As Double
            Get
                Return privateArgument
            End Get
            Set(ByVal value As Double)
                privateArgument = value
            End Set
        End Property
        Private privateValue As Double
        Public Property Value() As Double
            Get
                Return privateValue
            End Get
            Set(ByVal value As Double)
                privateValue = value
            End Set
        End Property
        Private privateSeries As String
        Public Property Series() As String
            Get
                Return privateSeries
            End Get
            Set(ByVal value As String)
                privateSeries = value
            End Set
        End Property
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the View property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-customize-series-of-a-chart-range-control-client-at-runtime-t130182/CS/ChartClientCustomizeSeries/Form1.cs#L25

AreaChartRangeControlClientView areaView = new AreaChartRangeControlClientView();
e.View = areaView;

VB.NET

how-to-customize-series-of-a-chart-range-control-client-at-runtime-t130182/VB/ChartClientCustomizeSeries/Form1.vb#L26

Dim areaView As New AreaChartRangeControlClientView()
e.View = areaView