This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.
ASPxDashboardViewer -> ASPxDashboard
MVCxDashboardViewer -> MVCxDashboard
The ASPxDashboardViewer allows you to apply master filtering and to perform drill-down on the client side. You can also provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting using the ASPxClientDashboardViewer.ItemVisualInteractivity event.
The ASPxClientDashboardViewer.CanSetMasterFilter method allows you to determine whether or not master filtering can be applied for the specified dashboard item. Use the ASPxClientDashboardViewer.GetAvailableFilterValues method to obtain the values of all elements that can be selected in the current state of the master filter item.
After filtering is applied or the state of the master filter item is changed, the ASPxClientDashboardViewer.MasterFilterSet event is raised. Its ASPxClientDashboardMasterFilterSetEventArgs.Values property allows you to obtain the currently selected values for the dashboard item that causes the event.
To clear the selection in the Master Filter item, use the ASPxClientDashboardViewer.ClearMasterFilter method.
After the selection is cleared, the ASPxClientDashboardViewer.MasterFilterCleared event is raised.
To learn how end-users can drill down using a particular dashboard item, refer to End-User Documentation for Dashboard.
To perform drill-down/drill-up in code, use the ASPxClientDashboardViewer.PerformDrillDown/ASPxClientDashboardViewer.PerformDrillUp methods. The ASPxClientDashboardViewer.GetAvailableDrillDownValues method allows you to obtain values that can be used to perform drill-down.
The ASPxClientDashboardDrillDownPerformedEventArgs.Values property allows you to obtain values from the current drill-down hierarchy.
The ASPxClientDashboardViewer allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting using the ASPxClientDashboardViewer.ItemVisualInteractivity event. This event is raised for dashboard items with disabled master filtering. Visual interactivity is enabled for master filter items by default. The ASPxClientDashboardViewer also fires this event when master filtering is applied to the current dashboard item or drill-down is performed in this dashboard item.
Use the ASPxClientDashboardItemVisualInteractivityEventArgs.ItemName event parameter to obtain the name of the dashboard item for which the event was raised. The ASPxClientDashboardItemVisualInteractivityEventArgs.SetTargetAxes method allows you to specify data axes used to perform custom interactivity actions (selection of grid rows, selection and highlighting of chart series points, etc.).
To specify the selection mode and enable highlighting, use the ASPxClientDashboardItemVisualInteractivityEventArgs.SetSelectionMode and ASPxClientDashboardItemVisualInteractivityEventArgs.EnableHighlighting methods respectively. The ASPxClientDashboardItemVisualInteractivityEventArgs.SetDefaultSelection method provides the capability to specify the default selection for the current dashboard item.
After the selection is changed, the ASPxClientDashboardViewer.ItemSelectionChanged event is raised. Its ASPxClientDashboardItemSelectionChangedEventArgs.GetCurrentSelection method returns the selected elements.
The following table lists possible target axes for each dashboard item and supported interactivity capabilities.