ASPxClientDashboard.ItemVisualInteractivity Event
Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.
Namespace: DevExpress.DashboardWeb.Scripts
Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll
Declaration
public event ASPxClientDashboardItemVisualInteractivityEventHandler ItemVisualInteractivityEvent Data
The ItemVisualInteractivity event's data class is ASPxClientDashboardItemVisualInteractivityEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ItemName | Gets the component name of the dashboard item for which the event was raised. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| EnableHighlighting(Boolean) | Enables highlighting for the current dashboard item. |
| GetDefaultSelection() | Gets the default selection for the current dashboard item. |
| GetSelectionMode() | Gets the selection mode for dashboard item elements. |
| GetTargetAxes() | Gets data axes used to perform custom interactivity actions. |
| IsHighlightingEnabled() | Returns whether highlighting is enabled for the current dashboard item. |
| SetDefaultSelection(ASPxClientDashboardItemDataAxisPointTuple[]) | Sets the default selection for the current dashboard item. |
| SetSelectionMode(String) | Sets the selection mode for dashboard item elements. |
| SetTargetAxes(String[]) | Sets data axes used to perform custom interactivity actions. |
Remarks
The ItemVisualInteractivity 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 is enabled for master filter items by default. The ASPxClientDashboard 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 ASPxClientDashboard.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.
Dashboard Item | Target Axes | Selection | Highlighting |
|---|---|---|---|
| |||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
Note
Note that the Grid dashboard item does not support custom interactivity when Cell Merging is enabled.