CustomItemSelection.GetDashboardFlatDataSourceRows(DashboardFlatDataSource) Method

Returns the master filter selection as a list of DashboardFlatDataSourceRow objects.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public IList<DashboardFlatDataSourceRow> GetDashboardFlatDataSourceRows(
    DashboardFlatDataSource flatDataSource
)

VB.NET

Public Function GetDashboardFlatDataSourceRows(
    flatDataSource As DashboardFlatDataSource
) As IList(Of DashboardFlatDataSourceRow)

Parameters

Name	Type	Description
flatDataSource	DashboardFlatDataSource	A DashboardFlatDataSource object that contains custom item data in a tabular format.

Returns

Type	Description
IList<DashboardFlatDataSourceRow>	A list of DashboardFlatDataSource rows.

Remarks

The following code snippet updates a custom control according to the current master filter selection:

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.XtraCharts;

namespace TutorialsCustomItems {
  public class FunnelItemControlProvider : CustomControlProviderBase {
      DashboardFlatDataSource flatData;
      ChartControl chart;
      // ...
        protected override void SetSelection(CustomItemSelection selection){
          chart.ClearSelection();
          foreach (DashboardFlatDataSourceRow item in selection.GetDashboardFlatDataSourceRows(flatData))  
            chart.SelectedItems.Add(item);
        }
  }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.XtraCharts

Namespace TutorialsCustomItems
    Public Class FunnelItemControlProvider
        Inherits CustomControlProviderBase
    Private flatData As DashboardFlatDataSource
    Dim chart As ChartControl
    ' ...
      Protected Overrides Sub SetSelection(ByVal selection As CustomItemSelection)
        chart.ClearSelection()
          For Each item As DashboardFlatDataSourceRow In selection.GetDashboardFlatDataSourceRows(flatData)
              chart.SelectedItems.Add(item)
          Next item
      End Sub
  End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDashboardFlatDataSourceRows(DashboardFlatDataSource) method.

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#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.cs#L46

protected override void SetSelection(CustomItemSelection selection) {
    IList<DashboardFlatDataSourceRow> selectedRows = selection.GetDashboardFlatDataSourceRows(flatData);
    sankey.SelectedItems.Clear();

winforms-dashboard-custom-items/CS/TutorialsCustomItems/CustomItems/FunnelItemControlProvider.cs#L74

chart.ClearSelection();
foreach (DashboardFlatDataSourceRow item in selection.GetDashboardFlatDataSourceRows(flatData))
    chart.SelectedItems.Add(item);

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.vb#L55

Protected Overrides Sub SetSelection(ByVal selection As CustomItemSelection)
    Dim selectedRows As IList(Of DashboardFlatDataSourceRow) = selection.GetDashboardFlatDataSourceRows(flatData)
    sankey.SelectedItems.Clear()

winforms-dashboard-custom-items/VB/TutorialsCustomItems/CustomItems/FunnelItemControlProvider.vb#L74

chart.ClearSelection()
For Each item As DashboardFlatDataSourceRow In selection.GetDashboardFlatDataSourceRows(flatData)
    chart.SelectedItems.Add(item)