Dashboard Item Group

Like the Tab Container, the Dashboard Item Group (the GroupItem class) allows you to combine dashboard items within a dashboard. The dashboard item group serves two main purposes:

  • To combine dashboard items within the dashboard into a separate layout group.
  • Manage interaction between dashboard items within and outside the group.

For example, you can combine related filter elements and data visualization dashboard items into a group.

wdd-dashboard-group

Create a Group in UI

To create a new group, use the Group button (the wdd-group-icon icon) in the Toolbox.

You can combine dashboard items into a group in several ways.

  • Create a new dashboard item using the buttons inside a group.
  • Drag a new item from the Toolbox and drop it to the tab page.
  • Move the existing items into a group using drag-and-drop.
Note

A dashboard item group cannot be added to another group.

Interactivity

The dashboard item group provides the capability to manage interaction between dashboard items within and outside the group.

The Master Filter option allows you to specify whether the current group allows you to filter external dashboard items using master filter items contained within the group. If this option is disabled, master filter items contained within the group can filter only dashboard items from this group.

The Ignore Master Filters option allows you to isolate dashboard items contained within the group from being filtered using external master filter items.

wdd-group-interactivity

The default group behaves opposite to the default tab page. While the group isolates filter items from the outside, the tab page does not change the item's data interactivity behavior.

To access interactivity settings for the dashboard item group in code, use the GroupItem.interactivityOptions property. This property returns the DashboardItemGroupInteractivityOptions object that exposes the following members:

Property

Description

DashboardItemGroupInteractivityOptions.IsMasterFilter

Gets or sets whether external dashboard items can be filtered using master filter items contained in the current DashboardItemGroup / TabContainerDashboardItem.

FilterableDashboardItemInteractivityOptions.IgnoreMasterFilters

Gets or sets whether the current dashboard item ignores filtering applied by master filters.

Create a Group in Code

Follow the steps below to create a tab container in code:

  1. Create a GroupItem class instance.
  2. Add the created group to the Dashboard.items collection.
  3. Rebuild the current dashboard's layout using the Dashboard.rebuildLayout property.

To add dashboard items to the group, assign the group's componentName to the dashboard item's parentContainer property.

The following code sample shows how to add an empty group:

var groupItem1 = new DevExpress.Dashboard.Model.GroupItem();

dashboardControl.dashboard().groups.push(groupItem1);

dashboardControl.dashboard().rebuildLayout();