SnapChart.DataSource Property

Gets or sets the chart’s data source.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v19.1.Core.dll

Declaration

C#

object DataSource { get; set; }

VB.NET

Property DataSource As Object

Property Value

Type	Description
Object	A Object representing the chart’s data source.

Remarks

Use the DataSource property to specify the data source from which the current chart obtains information about its data series.

Note

If the chart’s data source isn’t set (the DataSource property is null), the default data source of the SnapDocument containing the chart is used.

There are two types of data binding available in a chart: you can bind each series separately (series binding) or the entire chart (chart binding) to data. In both cases, you first need to create a data source, and then assign it to the DataSource property.

If series binding is used (i.e., one or more series are added to the SnapChart.Series collection and both the SeriesBase.ArgumentDataMember and SeriesBase.ValueDataMembers properties of each series are set), you can specify different data sources for each series using a series’ Series.DataSource property. In this case, the Series.DataSource property has a higher priority than the DataSource property of the chart.

Note that data binding performed at the chart level (chart binding) can force series objects to be created dynamically based on the common template settings. To do this, you should set the chart’s DataSource and SnapChart.SeriesDataMember properties and assign the required data fields to the SeriesBase.ArgumentDataMember and SeriesBase.ValueDataMembers properties, accessible from the chart’s SnapChart.SeriesTemplate property. The series objects obtained automatically from a data source specified in this way do not appear in the SnapChart.Series collection and can be customized using the SnapChart.SeriesTemplate settings.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-chart-to-visualize-data-in-a-snap-report-t569171

Form1.cs

using System;
using System.Data;
using DevExpress.XtraCharts;
using DevExpress.Snap.Core.API;

namespace SnapChartAPI
{
    public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm
    {
        public Form1() {
            InitializeComponent();
            #region #CreateChart
            SnapDocument document = snapControl.Document;
            // Insert a chart into the document.
            SnapChart chart = document.CreateSnChart(document.Range.Start);
            chart.BeginUpdate();
            // Create a data table and bind the chart to it.
            chart.DataSource = CreateChartData();

            // Populate chart series with data.
            chart.SeriesDataMember = "Year";
            chart.SeriesTemplate.ArgumentDataMember = "Region";
            chart.SeriesTemplate.ValueDataMembers.AddRange(new string[] { "Sales" });

            // Specify the series view options.
            chart.SeriesTemplate.ChangeView(ViewType.Bar);
            chart.SeriesNameTemplate.BeginText = "Year: ";

            // Add the chart title.
            ChartTitle chartTitle = new ChartTitle();
            chartTitle.Text = "DevAV Sales by Regions";
            chartTitle.Alignment = System.Drawing.StringAlignment.Center;
            chartTitle.Dock = ChartTitleDockStyle.Top;
            chart.Titles.Add(chartTitle);

            // Add the value axis title.
            XYDiagram diagram = (XYDiagram)chart.Diagram;
            diagram.AxisY.Title.Visibility = DevExpress.Utils.DefaultBoolean.True;
            diagram.AxisY.Title.Alignment = System.Drawing.StringAlignment.Center;
            diagram.AxisY.Title.Text = "Millions of Dollars";

            // Set the chart size.
            chart.Size = new System.Drawing.Size(640, 425);
            chart.UseExplicitSize = true;

            // Change the chart palette.
            chart.PaletteName = "Slipstream";
            chart.EndUpdate();

            document.Fields.Update();
            #endregion #CreateChart
        }

        #region #CreateDataSource
        DataView CreateChartData() {
            int prevYear = DateTime.Now.Year - 1;

            // Create a data table.
            DataTable table = new DataTable("ChartData");

            // Add three columns to the table.
            table.Columns.Add("Year", typeof(int));
            table.Columns.Add("Region", typeof(string));
            table.Columns.Add("Sales", typeof(decimal));

            // Add data rows to the table.
            table.Rows.Add(prevYear - 2, "Asia", 4.2372D);
            table.Rows.Add(prevYear - 2, "Australia", 1.7871D);
            table.Rows.Add(prevYear - 2, "Europe", 3.0884D);
            table.Rows.Add(prevYear - 2, "North America", 3.4855D);
            table.Rows.Add(prevYear - 2, "South America", 1.6027D);

            table.Rows.Add(prevYear - 1, "Asia", 4.7685D);
            table.Rows.Add(prevYear - 1, "Australia", 1.9576D);
            table.Rows.Add(prevYear - 1, "Europe", 3.3579D);
            table.Rows.Add(prevYear - 1, "North America", 3.7477D);
            table.Rows.Add(prevYear - 1, "South America", 1.8237D);

            table.Rows.Add(prevYear, "Asia", 5.2890D);
            table.Rows.Add(prevYear, "Australia", 2.2727D);
            table.Rows.Add(prevYear, "Europe", 3.7257D);
            table.Rows.Add(prevYear, "North America", 4.1825D);
            table.Rows.Add(prevYear, "South America", 2.1172D);

            return new DataView(table);
        }
        #endregion #CreateDataSource
    }
}

Form1.vb

Imports System
Imports System.Data
Imports DevExpress.XtraCharts
Imports DevExpress.Snap.Core.API

Namespace SnapChartAPI
    Partial Public Class Form1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Public Sub New()
            InitializeComponent()
'            #Region "#CreateChart"
            Dim document As SnapDocument = snapControl.Document
            ' Insert a chart into the document.
            Dim chart As SnapChart = document.CreateSnChart(document.Range.Start)
            chart.BeginUpdate()
            ' Create a data table and bind the chart to it.
            chart.DataSource = CreateChartData()

            ' Populate chart series with data.
            chart.SeriesDataMember = "Year"
            chart.SeriesTemplate.ArgumentDataMember = "Region"
            chart.SeriesTemplate.ValueDataMembers.AddRange(New String() { "Sales" })

            ' Specify the series view options.
            chart.SeriesTemplate.ChangeView(ViewType.Bar)
            chart.SeriesNameTemplate.BeginText = "Year: "

            ' Add the chart title.
            Dim chartTitle As New ChartTitle()
            chartTitle.Text = "DevAV Sales by Regions"
            chartTitle.Alignment = System.Drawing.StringAlignment.Center
            chartTitle.Dock = ChartTitleDockStyle.Top
            chart.Titles.Add(chartTitle)

            ' Add the value axis title.
            Dim diagram As XYDiagram = CType(chart.Diagram, XYDiagram)
            diagram.AxisY.Title.Visibility = DevExpress.Utils.DefaultBoolean.True
            diagram.AxisY.Title.Alignment = System.Drawing.StringAlignment.Center
            diagram.AxisY.Title.Text = "Millions of Dollars"

            ' Set the chart size.
            chart.Size = New System.Drawing.Size(640, 425)
            chart.UseExplicitSize = True

            ' Change the chart palette.
            chart.PaletteName = "Slipstream"
            chart.EndUpdate()

            document.Fields.Update()
'            #End Region ' #CreateChart
        End Sub

        #Region "#CreateDataSource"
        Private Function CreateChartData() As DataView
            Dim prevYear As Integer = Date.Now.Year - 1

            ' Create a data table.
            Dim table As New DataTable("ChartData")

            ' Add three columns to the table.
            table.Columns.Add("Year", GetType(Integer))
            table.Columns.Add("Region", GetType(String))
            table.Columns.Add("Sales", GetType(Decimal))

            ' Add data rows to the table.
            table.Rows.Add(prevYear - 2, "Asia", 4.2372R)
            table.Rows.Add(prevYear - 2, "Australia", 1.7871R)
            table.Rows.Add(prevYear - 2, "Europe", 3.0884R)
            table.Rows.Add(prevYear - 2, "North America", 3.4855R)
            table.Rows.Add(prevYear - 2, "South America", 1.6027R)

            table.Rows.Add(prevYear - 1, "Asia", 4.7685R)
            table.Rows.Add(prevYear - 1, "Australia", 1.9576R)
            table.Rows.Add(prevYear - 1, "Europe", 3.3579R)
            table.Rows.Add(prevYear - 1, "North America", 3.7477R)
            table.Rows.Add(prevYear - 1, "South America", 1.8237R)

            table.Rows.Add(prevYear, "Asia", 5.2890R)
            table.Rows.Add(prevYear, "Australia", 2.2727R)
            table.Rows.Add(prevYear, "Europe", 3.7257R)
            table.Rows.Add(prevYear, "North America", 4.1825R)
            table.Rows.Add(prevYear, "South America", 2.1172R)

            Return New DataView(table)
        End Function
        #End Region ' #CreateDataSource
    End Class
End Namespace