The requested page is not available for the requested platform. You are viewing the content for Default platform.

DataDashboardItem.DataSource Property

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

Namespace: DevExpress.DashboardCommon

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

Declaration

[DefaultValue(null)]
public IDashboardDataSource DataSource { get; set; }
<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.

Examples

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

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
See Also