[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
 [Expand]Getting Started
 [Expand]Basic Concepts and Terminology
 [Expand]Main Features
 [Collapse]Building the Designer and Viewer Applications
  [Expand]WinForms Designer
  [Collapse]WinForms Viewer
    Touch Support
    Adding the DashboardViewer Control
    Loading a Dashboard
    Providing Data
    Manage Printing and Exporting Capabilities
    Manage Interactivity Capabilities
    Manage Dashboard Parameters
    Customize Dashboard Colors
    Manage Dashboard Layout
    Obtaining Underlying and Displayed Data
    Access to Underlying Controls
    Popup Menus
   [Expand]Dialogs and Wizards
  [Expand]Web Dashboard
  [Expand]WPF Viewer
  [Expand]Web Viewer
 [Expand]Creating Dashboards
 [Expand]Design-Time Features
  Video Tutorials
  End-User Documentation
 [Expand]Redistribution and Deployment
 [Expand]Member Tables
 [Expand]API Reference
[Expand]eXpressApp Framework
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
This documentation page describes implementations made in our v17.2 release cycle. To learn about functionality shipping with v18.1, navigate to our updated help file experience at docs.devexpress.com. Learn More

Manage Interactivity Capabilities

To enable interaction between various dashboard items, use the Master Filtering and Drill-Down features. You can also provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting using the DashboardViewer.DashboardItemVisualInteractivity event.

Expanded Master Filtering

To learn how to apply filtering using a specific dashboard item, refer to the Master Filtering topic in the Interactivity section for this item.

The DashboardViewer.CanSetMasterFilter method allows you to determine whether or not master filtering can be applied for the specified dashboard item. Use the DashboardViewer.GetAvailableFilterValues method to obtain axis point tuples that identify elements, which can be selected in the current state of the master filter item. The DashboardViewer.GetEntireRange method returns the visible range for the specified Range Filter dashboard item.

To apply filtering in code, use the DashboardViewer.SetMasterFilter method (or the DashboardViewer.SetRange method for the Range Filter dashboard item).

After filtering is applied or the state of the master filter item is changed, the DashboardViewer.MasterFilterSet event is raised. Its MasterFilterSetEventArgs.SelectedValues and MasterFilterSetEventArgs.SelectedRange properties allow you to obtain the currently selected values or the selected range for the dashboard item that causes the event.

For instance, for the dashboard in the image above, the MasterFilterSetEventArgs.SelectedValues property returns "Andrew Fuller", "Ann Dodsworth" and "Laura Callahan" for the Grid dashboard item. For the Range Filter dashboard item, the MasterFilterSetEventArgs.SelectedRange property returns minimum and maximum values in the selected range ("March, 1997" and "October, 1997", respectively).

To clear the selection in the Master Filter item, use the DashboardViewer.ClearMasterFilter method.

After the selection is cleared, the DashboardViewer.MasterFilterCleared event is raised.

How to: Apply Default Filtering to Master Filters in DashboardViewer
How to: Apply Master Filtering in DashboardViewer
How to: Apply Master Filtering in Code in OLAP Mode

Expanded Drill-Down

To learn how end-users can drill down using a particular dashboard item, refer to the Drill-Down topic in the Interactivity section for this item.

The DashboardViewer.GetAvailableDrillDownValues method allows you to obtain values that can be used to perform drill-down.

To perform drill-down/drill-up in code, use the DashboardViewer.PerformDrillDown/DashboardViewer.PerformDrillUp methods.

After drill-down (or drill-up) is performed, the DashboardViewer.DrillDownPerformed (or DashboardViewer.DrillUpPerformed) event is raised.

You can use the DrillActionEventArgs.DrillDownLevel event parameter to determine the current drill-down level.

The DrillActionEventArgs.Values property allows you to obtain values from the current drill-down hierarchy.

How to: Perform a Drill-Down in DashboardViewer

Expanded Custom Interactivity

The DashboardViewer allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting using the DashboardViewer.DashboardItemVisualInteractivity event. This event is raised for dashboard items with disabled master filtering. Visual interactivity for master filter items is already enabled by default. The DashboardViewer also fires this event when master filtering is applied to the current dashboard item.


Note that for dashboard items with enabled drill-down the DashboardViewer.DashboardItemVisualInteractivity event is raised on the bottommost drill-down level.

Use the DashboardItemVisualInteractivityEventArgs.DashboardItemName event parameter to obtain the name of the dashboard item for which the event was raised.

The DashboardItemVisualInteractivityEventArgs.TargetAxes property allows you to specify data axes used to perform custom interactivity actions (selection of grid rows, selection and highlighting of chart series points, etc.). The DashboardItemVisualInteractivityEventArgs.Data event parameter returns the MultiDimensionalData object whose members allow you to obtain the available data axes.

To specify the selection mode and manage highlighting, use the DashboardItemVisualInteractivityEventArgs.SelectionMode and DashboardItemVisualInteractivityEventArgs.EnableHighlighting properties respectively. The DashboardItemVisualInteractivityEventArgs.SetDefaultSelection method provides the capability to specify the default selection for the current dashboard item.

After the selection is changed, the DashboardViewer.DashboardItemSelectionChanged event is raised. Its DashboardItemSelectionChangedEventArgs.CurrentSelection parameter returns the selected elements.

The following table lists possible target axes for each dashboard item and supported interactivity capabilities.


Note that the Grid dashboard item does not support custom interactivity when Cell Merging is enabled.

How to: Add Custom Interactivity to a Dashboard Displayed in the WinForms Viewer

Is this topic helpful?​​​​​​​