General Information
.NET Subscription
Desktop
Enterprise and Analytic Tools
Code / Debug / Refactor
Frameworks and Libraries
IOS, Android & Xamarin
DashboardItemGroup Class
Represents a group used to arrange dashboard items within a dashboard.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v18.2.Core.dll
Declaration
[DashboardItemType("GROUP")]
public class DashboardItemGroup :
DashboardItem,
IMasterFilterItem,
IFilterGroupOwner,
IFiltersProvider,
IInteractivityOptionsProvider,
IDashboardItemContainer<DashboardItemType("GROUP")>
Public Class DashboardItemGroup
Inherits DashboardItem
Implements IMasterFilterItem,
IFilterGroupOwner,
IFiltersProvider,
IInteractivityOptionsProvider,
IDashboardItemContainerA dashboard item group arranges dashboard items within the dashboard into a separate layout group. Moreover, the dashboard item group provides the capability to manage interaction between dashboard items within and outside of the group.
To create and manage a dashboard item group in code, use the following members.
- A newly created dashboard item group should belong to the dashboard. To add a group to the dashboard, use the Dashboard.Groups property or create a new group using the Dashboard.CreateGroup method.
- To add or remove dashboard items to/from the group, use the DashboardItemGroup.Add/DashboardItemGroup.Remove methods. The DashboardItemGroup.Items property provides access to dashboard items contained within the current group.
To access interactivity settings for the current DashboardItemGroup, use the DashboardItemGroup.InteractivityOptions property. The DashboardItemGroupInteractivityOptions object returned by this property exposes the following members.
- The DashboardItemGroupInteractivityOptions.IsMasterFilter property provides the capability to filter external dashboard items using master filter items contained within the current dashboard item group. If this property is set to false, master filter items contained within the group can filter only dashboard items from this group.
- The FilterableDashboardItemInteractivityOptions.IgnoreMasterFilters property allows you to isolate dashboard items contained within the group from being filtered using external master filter items.
Examples
The following example demonstrates how to combine filter elements to a group and bind them to data in code.
In this example, the dashboard contains the ComboBoxDashboardItem, ListBoxDashboardItem and TreeViewDashboardItem combined into a group. These filter elements allow you to apply filtering to a Chart dashboard item by selecting the required values.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-combine-filter-elements-to-a-group-and-bind-them-to-data-t191632.
Imports System
Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.XtraEditors
Namespace Dashboard_FilterElements_and_Groups
Partial Public Class Form1
Inherits XtraForm
Public Sub New()
InitializeComponent()
Dim dashboard1 As New Dashboard()
Dim dataSource As New DashboardSqlDataSource()
dataSource.ConnectionParameters =
New XmlFileConnectionParameters("..\..\Data\WebsiteStatisticsData.xml")
Dim selectQuery As SelectQuery = SelectQueryFluentBuilder.AddTable("Data") _
.SelectColumns("Browser", "BrowserDetails", "Date", "Count") _
.Build("Statistics")
dataSource.Queries.Add(selectQuery)
dashboard1.DataSources.Add(dataSource)
Dim comboBox1 As New ComboBoxDashboardItem()
comboBox1.Name = "Browser"
comboBox1.DataSource = dataSource
comboBox1.DataMember = "Statistics"
comboBox1.FilterDimensions.Add(New Dimension("Browser"))
comboBox1.ComboBoxType = ComboBoxDashboardItemType.Checked
Dim listBox1 As New ListBoxDashboardItem()
listBox1.Name = "Browser Version"
listBox1.DataSource = dataSource
listBox1.DataMember = "Statistics"
listBox1.FilterDimensions.Add(New Dimension("BrowserDetails"))
listBox1.InteractivityOptions.IgnoreMasterFilters = False
Dim treeView1 As New TreeViewDashboardItem()
treeView1.Name = "Date"
treeView1.DataSource = dataSource
treeView1.DataMember = "Statistics"
treeView1.FilterDimensions.AddRange(New Dimension("Date", DateTimeGroupInterval.Year), _
New Dimension("Date", DateTimeGroupInterval.Quarter))
treeView1.AutoExpandNodes = True
Dim group1 As New DashboardItemGroup()
group1.Name = "Filters"
group1.InteractivityOptions.IsMasterFilter = True
dashboard1.Groups.Add(group1)
group1.AddRange(comboBox1, treeView1, listBox1)
Dim chart1 As New ChartDashboardItem()
chart1.Name = "Browser Statistics"
chart1.DataSource = dataSource
chart1.DataMember = "Statistics"
chart1.Arguments.Add(New Dimension("Date", DateTimeGroupInterval.MonthYear))
chart1.SeriesDimensions.AddRange(New Dimension("Browser"), New Dimension("BrowserDetails"))
chart1.Panes.Add(New ChartPane())
Dim salesAmountSeries As New SimpleSeries(SimpleSeriesType.SplineArea)
salesAmountSeries.Value = New Measure("Count")
chart1.Panes(0).Series.Add(salesAmountSeries)
dashboard1.Items.Add(chart1)
dashboardViewer1.Dashboard = dashboard1
End Sub
Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
Dim layoutGroup1 As DashboardLayoutGroup =
dashboardViewer1.Dashboard.LayoutRoot.FindRecursive(dashboardViewer1.Dashboard.Groups(0))
layoutGroup1.Orientation = DashboardLayoutGroupOrientation.Vertical
layoutGroup1.Weight = dashboardViewer1.Dashboard.LayoutRoot.Weight / 5
dashboardViewer1.SetMasterFilter("comboBoxDashboardItem1", "Internet Explorer")
End Sub
End Class
End Namespace
Inheritance
Object
DashboardItem
DashboardItemGroup
Implements
DevExpress.DashboardCommon.Native.IDashboardComponent
DevExpress.DashboardCommon.Native.IChangeService
DevExpress.DataAccess.Native.ISupportPrefix
DevExpress.DashboardCommon.Native.ICurrencyCultureNameProvider
DevExpress.DashboardCommon.Native.IMasterFilterItem
DevExpress.DashboardCommon.Native.IFilterGroupOwner
DevExpress.DashboardCommon.Native.IFiltersProvider
DevExpress.DashboardCommon.Native.IInteractivityOptionsProvider
See Also