DataDashboardItem.DataSource Property

Gets or sets a data source to which the dashboard item is bound.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

[DefaultValue(null)]
public IDashboardDataSource DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataSource As IDashboardDataSource

Property Value

Type	Default	Description
IDashboardDataSource	*null*	An object implementing the IDashboardDataSource interface that specifies a data source to which the dashboard item is bound.

Remarks

All data-aware dashboard items expose the DataSource property that specifies a data source to which this item is actually bound. The DataDashboardItem.DataMember property specifies the required data member in this data source.

To access the collection of existing dashboard data sources, use the Dashboard.DataSources property.

Note

For DashboardSqlDataSource or DashboardEFDataSource, specify the required data member using the DataDashboardItem.DataMember property.

Example

The following example demonstrates how to bind a Choropleth Map dashboard item to data in code.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-choropleth-map-dashboard-item-to-data-in-code-e5010.

Form1.vb

Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql

Namespace Dashboard_CreateChoroplethMap
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()

            ' Creates a new dashboard and a data source for this dashboard.
            Dim dashboard As New Dashboard()

            Dim dataSource As New DashboardSqlDataSource()
            Dim sqlQuery As New CustomSqlQuery("Countries", "select * from Countries")
            dataSource.ConnectionParameters = New Access97ConnectionParameters("..\..\Data\countriesDB.mdb", "", "")
            dataSource.Queries.Add(sqlQuery)

            ' Creates a choropleth map dashboard item and specifies its data source.
            Dim choroplethMap As New ChoroplethMapDashboardItem()
            choroplethMap.DataSource = dataSource
            choroplethMap.DataMember = "Countries"

            ' Loads the map of the world.
            choroplethMap.Area = ShapefileArea.WorldCountries

            ' Specifies a binding between the required map attribute and the data source field.
            choroplethMap.AttributeName = "NAME"
            choroplethMap.AttributeDimension = New Dimension("Country")

            ' Creates a ValueMap object with a measure that provides data for color map shapes.
            ' Then, adds this object to the Maps collection of the choropleth map dashboard item.
            Dim populationMap As New ValueMap(New Measure("Population"))
            choroplethMap.Maps.Add(populationMap)

            ' Adds the choropleth map dashboard item to the dashboard and opens this
            ' dashboard in the Dashboard Viewer.
            dashboard.Items.Add(choroplethMap)
            dashboardViewer1.Dashboard = dashboard
        End Sub
    End Class
End Namespace

Form1.cs

using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;

namespace Dashboard_CreateChoroplethMap {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();

            // Creates a new dashboard and a data source for this dashboard.
            Dashboard dashboard = new Dashboard();

            DashboardSqlDataSource dataSource = new DashboardSqlDataSource();
            CustomSqlQuery sqlQuery = new CustomSqlQuery("Countries", "select * from Countries");
            dataSource.ConnectionParameters = new Access97ConnectionParameters(@"..\..\Data\countriesDB.mdb", "", "");
            dataSource.Queries.Add(sqlQuery);

            // Creates a choropleth map dashboard item and specifies its data source.
            ChoroplethMapDashboardItem choroplethMap = new ChoroplethMapDashboardItem();
            choroplethMap.DataSource = dataSource;
            choroplethMap.DataMember = "Countries";

            // Loads the map of the world.
            choroplethMap.Area = ShapefileArea.WorldCountries;

            // Specifies a binding between the required map attribute and the data source field.
            choroplethMap.AttributeName = "NAME";
            choroplethMap.AttributeDimension = new Dimension("Country");

            // Creates a ValueMap object with a measure that provides data for color map shapes.
            // Then, adds this object to the Maps collection of the choropleth map dashboard item.
            ValueMap populationMap = new ValueMap(new Measure("Population"));
            choroplethMap.Maps.Add(populationMap);

            // Adds the choropleth map dashboard item to the dashboard and opens this
            // dashboard in the Dashboard Viewer.
            dashboard.Items.Add(choroplethMap);
            dashboardViewer1.Dashboard = dashboard;
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource 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#

wpf-dashboard-viewer-item-tabs/CS/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.cs#L11

cardItem.SparklineArgument = new Dimension("SalesDate", DateTimeGroupInterval.DayMonthYear);
cardItem.DataSource = dataSource;
cardItem.ShowCaption = false;

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/DashboardItemGenerator.cs#L16

cardItem.SparklineArgument = new Dimension("SalesDate", DateTimeGroupInterval.DayMonthYear);
cardItem.DataSource = dataSource;
cardItem.ShowCaption = false;

how-to-combine-filter-elements-to-a-group-and-bind-them-to-data-t191632/CS/Dashboard_FilterElements_and_Groups/Form1.cs#L25

comboBox1.Name = "Browser";
comboBox1.DataSource = dataSource; comboBox1.DataMember = "Statistics";
comboBox1.FilterDimensions.Add(new Dimension("Browser"));

how-to-bind-a-bound-image-dashboard-item-to-data-in-code-t382366/CS/Dashboard_BoundImage/Form1.cs#L26

BoundImageDashboardItem boundImage = new BoundImageDashboardItem();
boundImage.DataSource = xmlDataSource; boundImage.DataMember = "Query 1";
boundImage.DataBindingMode = ImageDataBindingMode.Uri;

how-to-bind-a-dashboard-to-a-sql-database-using-dashboardsqldatasource-e5107/CS/Dashboard_DashboardDataProviders/Form1.cs#L35

ChartDashboardItem chart = new ChartDashboardItem();
chart.DataSource = sqlDataSource; chart.DataMember = "Query 1";
chart.Arguments.Add(new Dimension("OrderDate", DateTimeGroupInterval.MonthYear));

VB.NET

wpf-dashboard-viewer-item-tabs/VB/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.vb#L13

cardItem.SparklineArgument = New Dimension("SalesDate", DateTimeGroupInterval.DayMonthYear)
cardItem.DataSource = dataSource
cardItem.ShowCaption = False

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/DashboardItemGenerator.vb#L18

cardItem.SparklineArgument = New Dimension("SalesDate", DateTimeGroupInterval.DayMonthYear)
cardItem.DataSource = dataSource
cardItem.ShowCaption = False

how-to-bind-a-dashboard-to-a-sql-database-using-dashboardsqldatasource-e5107/VB/Dashboard_DashboardDataProviders/Form1.vb#L34

Dim chart As New ChartDashboardItem()
chart.DataSource = sqlDataSource
chart.DataMember = "Query 1"

how-to-replace-dashboardsqldatasource-with-dashboardobjectdatasource-with-filtered-data-t556759/VB/ASPxDashboard/Default.aspx.vb#L83

dashboard.DataSources.Add(ods)
For Each item In dashboard.Items.OfType(Of DataDashboardItem)().Where(Function(i) Object.ReferenceEquals(i.DataSource, dsQuery.DataSource) AndAlso i.DataMember = dsQuery.Query.Name)
    item.DataMember = ""

wpf-dashboard-olap-data-provider/VB/WpfDashboard_OlapDataProvider/MainWindow.xaml.vb#L31

Dim cardItem As CardDashboardItem = New CardDashboardItem()
cardItem.DataSource = olapDataSource
cardItem.SeriesDimensions.Add(New Dimension("[Sales Territory].[Sales Territory Country].[Sales Territory Country]"))