DashboardItemInteractivityOptions.IsDrillDownEnabled Property

Gets or sets whether drill-down is enabled.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(false)]
public virtual bool IsDrillDownEnabled { get; set; }

VB.NET

<DefaultValue(False)>
Public Overridable Property IsDrillDownEnabled As Boolean

Property Value

Type	Default	Description
Boolean	false	true, to enable drill-down; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to IsDrillDownEnabled
CustomDashboardItem	.InteractivityOptions .IsDrillDownEnabled
GridDashboardItem	.InteractivityOptions .IsDrillDownEnabled
KpiDashboardItem<TKpiElement>	.InteractivityOptions .IsDrillDownEnabled
MapDashboardItem	.InteractivityOptions .IsDrillDownEnabled
ScatterChartDashboardItem	.InteractivityOptions .IsDrillDownEnabled

Remarks

Drill-down allows end-users to see what is behind a particular value in the dashboard. When drill-down is enabled, end-users can click a dashboard item element (for instance, a chart bar or a gauge) and view details related to the selected element.

To enable drill-down for the current dashboard item, set the IsDrillDownEnabled property to true.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsDrillDownEnabled property.

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-bind-card-item-to-data-in-code/CS/DXApplication1/ViewerForm1.cs#L44

cards.SeriesDimensions.Add(new Dimension("Product"));
cards.InteractivityOptions.IsDrillDownEnabled = true;

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L114

}
if(dashboardItem.InteractivityOptions.IsDrillDownEnabled) {
    validationError = "The Tree List Item does not support Drill-Down";

VB.NET

winforms-dashboard-bind-card-item-to-data-in-code/VB/DXApplication1/ViewerForm1.vb#L42

cards.SeriesDimensions.Add(New Dimension("Product"))
cards.InteractivityOptions.IsDrillDownEnabled = True

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L123

End If
If dashboardItem.InteractivityOptions.IsDrillDownEnabled Then
    validationError = "The Tree List Item does not support Drill-Down"