GroupItem Class

A group used to arrange dashboard items within a dashboard.

Declaration

export class GroupItem extends DashboardItem

Remarks

A dashboard item group arranges dashboard items within the dashboard into a separate layout group. Moreover, the dashboard item group allows you to manage interaction between dashboard items within and outside the group.

Use the interactivityOptions property to get access to the group's interactivity settings.

Examples

The following example shows how to create a dashboard group. Create the GroupItem instance and add it to the Dashboard.groups collection.

Call the Dashboard.rebuildLayout method to rebuild the dashboard layout and display changes.

// Use the line below for a modular approach:
// import * as Model from 'devexpress-dashboard/model'
// Use the line below for an approach with global namespaces:
// var Model = DevExpress.Dashboard.Model;

public createGroup() { 
    var groupItem = new Model.GroupItem();
    groupItem.componentName('groupItem');

    control.dashboard().groups.push(groupItem);
    // ...
    control.dashboard().rebuildLayout();
}

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

dashboardItem.parentContainer("groupItem");

Inherited Members

DevExpress.Dashboard.Model.DataDashboardItem.componentName
DevExpress.Dashboard.Model.DataDashboardItem.customProperties
DevExpress.Dashboard.Model.DataDashboardItem.name
DevExpress.Dashboard.Model.DataDashboardItem.parentContainer
DevExpress.Dashboard.Model.DataDashboardItem.showCaption
DevExpress.Dashboard.Model.DataDashboardItem.getInfo
DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix

constructor

Initializes a new instance of the GroupItem class.

Declaration

constructor(dashboardItemJSON?: any, serializer?: DevExpress.Analytics.Utils.ModelSerializer)

Parameters

Name Type Description
dashboardItemJSON any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

interactivityOptions Property

Provides access to options that control interactivity features, such as Master Filtering and drill-down.

Declaration

interactivityOptions: DashboardItemGroupInteractivityOptions

Property Value

Type Description
DashboardItemGroupInteractivityOptions

A DashboardItemGroupInteractivityOptions object that defines interactivity options.