ICustomItemInteractivityProvider.SetMasterFilter(DashboardFlatDataSourceRow) Method

Selects required elements in the specified master filter item.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

void SetMasterFilter(
    DashboardFlatDataSourceRow row
)

VB.NET

Sub SetMasterFilter(
    row As DashboardFlatDataSourceRow
)

Parameters

Name	Type	Description
row	DashboardFlatDataSourceRow	Identifies a master filter element.

Remarks

The following code snippet sets a master filter:

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.XtraCharts;
using System.Linq;

namespace TutorialsCustomItems {
    public class FunnelItemControlProvider : CustomControlProviderBase {
        CustomDashboardItem<FunnelItemMetadata> dashboardItem;
        ChartControl chart;
      public FunnelItemControlProvider(CustomDashboardItem<FunnelItemMetadata> dashboardItem){
        // ...
        chart.SelectedItemsChanged += ChartSelectedItemsChanged;
      }
      // ...
      void ChartSelectedItemsChanged(object sender, SelectedItemsChangedEventArgs e){
        if (chart.SelectedItems.Count == 0 && Interactivity.CanClearMasterFilter)
            Interactivity.ClearMasterFilter();
        else if (Interactivity.CanSetMasterFilter)
            Interactivity.SetMasterFilter(chart.SelectedItems.OfType<DashboardFlatDataSourceRow>());
      }
  }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.XtraCharts
Imports System.Linq

Namespace TutorialsCustomItems
    Public Class FunnelItemControlProvider
        Inherits CustomControlProviderBase

        Private dashboardItem As CustomDashboardItem(Of FunnelItemMetadata)
        Private chart As ChartControl
      Public Sub New(ByVal dashboardItem As CustomDashboardItem(Of FunnelItemMetadata))
        ' ...
        AddHandler chart.SelectedItemsChanged, AddressOf ChartSelectedItemsChanged
      End Sub
      ' ...
      Private Sub ChartSelectedItemsChanged(ByVal sender As Object, ByVal e As SelectedItemsChangedEventArgs)
        If chart.SelectedItems.Count = 0 AndAlso Interactivity.CanClearMasterFilter Then
            Interactivity.ClearMasterFilter()
        ElseIf Interactivity.CanSetMasterFilter Then
            Interactivity.SetMasterFilter(chart.SelectedItems.OfType(Of DashboardFlatDataSourceRow)())
        End If
      End Sub
    End Class
End Namespace

Refer to the following tutorial for more information on how to configure master filtering for a custom Funnel item: Create an Interactive Data-Aware Item.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetMasterFilter(DashboardFlatDataSourceRow) 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/SunburstChart/SunburstItemControlProvider.cs#L117

    if(Interactivity.CanSetMasterFilter)
        Interactivity.SetMasterFilter(hi.SunburstItem.Tag as DashboardFlatDataSourceRow);
}

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/SunburstChart/SunburstItemControlProvider.vb#L126

If Interactivity.CanSetMasterFilter Then
    Interactivity.SetMasterFilter(TryCast(hi.SunburstItem.Tag, DashboardFlatDataSourceRow))
End If