DashboardDesigner.DashboardItemVisualInteractivity Event

Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.

Namespace: DevExpress.DashboardWin

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

Declaration

public event DashboardItemVisualInteractivityEventHandler DashboardItemVisualInteractivity

Event Data

The DashboardItemVisualInteractivity event's data class is DashboardItemVisualInteractivityEventArgs. The following properties provide information specific to this event:

Property Description
DashboardItemName Gets the component name of the dashboard item for which the event was raised. Inherited from DashboardItemVisualInteractivityBaseEventArgs.
Data Gets client data visualized within the dashboard item.
EnableHighlighting Gets or sets whether to enable highlighting for the current dashboard item. Inherited from DashboardItemVisualInteractivityBaseEventArgs.
SelectionMode Gets or sets the selection mode for dashboard item elements.
TargetAxes Gets or sets data axes used to perform custom interactivity actions.

The event data class exposes the following methods:

Method Description
SetDefaultSelection(AxisPoint) Sets the default selection for the current dashboard item.
SetDefaultSelection(AxisPointTuple) Sets the default selection for the current dashboard item.
SetDefaultSelection(List<AxisPoint>) Sets the default selection for the current dashboard item.
SetDefaultSelection(List<AxisPointTuple>) Sets the default selection for the current dashboard item.

Remarks

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

NOTE

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

Use the DashboardItemVisualInteractivityBaseEventArgs.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 DashboardItemVisualInteractivityBaseEventArgs.SelectionMode and DashboardItemVisualInteractivityBaseEventArgs.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 DashboardDesigner.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.

Dashboard Item

Target Axes

Selection

Highlighting

GridDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

ChartDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

DashboardDataAxisNames.ChartSeriesAxis

Dashboard_GreenTick

Dashboard_GreenTick

ScatterChartDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

Dashboard_GreenTick

Dashboard_GreenTick

PieDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

DashboardDataAxisNames.ChartSeriesAxis

Dashboard_GreenTick

Dashboard_GreenTick

CardDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

GaugeDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

MapDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

TreemapDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

NOTE

A Grid dashboard item with enabled Cell Merging does not support custom interactivity.

Example

This code snippet demonstrates how to handle the DashboardDesigner.DashboardItemVisualInteractivity event to implement custom visual interactivity instead of the built-in master filtering.

View Example: How to Use Dashboard Items in Tab Pages as Independent Master Filters

using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.ViewerData;
using DevExpress.DashboardWin;
// ...
        dashboardDesigner1.DashboardItemVisualInteractivity += DashboardDesigner1_DashboardItemVisualInteractivity;
// ...
        private void DashboardDesigner1_DashboardItemVisualInteractivity(object sender, DashboardItemVisualInteractivityEventArgs e)
        {
            if (e.DashboardItemName == "gridDashboardItem1")
            {
                e.SelectionMode = DashboardSelectionMode.Single;
                e.EnableHighlighting = true;
                e.SetDefaultSelection(selectionCache);

            };
            if (e.DashboardItemName == "gridDashboardItem2")
            {
                e.SelectionMode = DashboardSelectionMode.Single;
                e.EnableHighlighting = true;
                e.SetDefaultSelection(selectionCache);
            };
        }
See Also