DashboardLayoutItem Class

Represents a layout item that displays a dashboard item.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class DashboardLayoutItem :
    DashboardLayoutNode

VB.NET

Public Class DashboardLayoutItem
    Inherits DashboardLayoutNode

Related API Members

The following members return DashboardLayoutItem objects:

• DashboardLayoutGroup.FindRecursive(DashboardItem)

Remarks

To display a dashboard item within a layout item, pass the DashboardItem descendant to the DashboardLayoutItem constructor.

The DashboardLayoutNode.Weight property allows you to specify the relative size of the created layout item.

Example

This example constructs the layout of a sample dashboard that contains the following items:

• DateFilterDashboardItem
• ChartDashboardItem
• DashboardItemGroup that contains the DateFilter and Chart items
• GridDashboardItem
• RangeFilterDashboardItem

The Dashboard.LoadFromXml method loads a sample dashboard.

The following steps are taken to create a new layout:

1. Create DashboardLayoutItem objects to display the existing dashboard items and DashboardLayoutGroup object to display a dashboard group. The weight parameter specifies the layout item’s relative size in a group.
2. Create DashboardLayoutGroup objects to organize items which do not belong to a dashboard group item. Add layout items as child nodes to form a layout tree.
3. Create a root group - a new DashboardLayoutGroup object whose DashboardLayoutGroup.DashboardItem property is null. Add the layout tree nodes to the root as its child nodes.
4. Assign the root group to the Dashboard.LayoutRoot property.

Note

The complete sample project How to modify dashboard layout in code is available in the DevExpress Examples repository.

Form1.cs

using System;
using System.Linq;
using DevExpress.XtraEditors;
using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
//...
            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXml(@"Data\LayoutUnordered.xml");
            dashboard.BeginUpdate();
            // Switch off the DateFilter item's AutoHeight arrangement mode so that the DateFilter layout does not ignore its layout weight.
            ((DateFilterDashboardItem)(dashboard.Items["dateFilterDashboardItem1"])).ArrangementMode = DateFilterArrangementMode.Horizontal;
            // Hide captions.
            dashboard.Items.ForEach(item => item.ShowCaption = false);
            dashboard.Groups.ForEach(item => item.ShowCaption = false);
            // Create layout items for the DateFilter and Chart dashboard items.
            DashboardLayoutItem dateFilterLayoutItem = new DashboardLayoutItem(dashboard.Items["dateFilterDashboardItem1"], 13);
            DashboardLayoutItem chartLayoutItem = new DashboardLayoutItem(dashboard.Items["chartDashboardItem1"], 87);
            // Create a layout item for the dashboard Group item.
            DashboardLayoutGroup groupLayoutItem = new DashboardLayoutGroup()
            {
                Orientation = DashboardLayoutGroupOrientation.Vertical,
                DashboardItem = dashboard.Groups["dashboardItemGroup1"],
                Weight = 70
            };
            // Connect layout items in the layout tree.
            groupLayoutItem.ChildNodes.AddRange(dateFilterLayoutItem, chartLayoutItem);
            // Create a Grid layout item.
            DashboardLayoutItem gridLayoutItem = new DashboardLayoutItem(dashboard.Items["gridDashboardItem1"], 30);
            // Create a group layout item to organize the Grid layout item and a Dashboard Group layout item.
            DashboardLayoutGroup layoutGroup = new DashboardLayoutGroup(DashboardLayoutGroupOrientation.Horizontal, 85);
            // Connect layout items in the layout tree.
            layoutGroup.ChildNodes.AddRange(gridLayoutItem, groupLayoutItem);
            // Create a RangeFilter layout item.
            DashboardLayoutItem rangeFilterLayoutItem = new DashboardLayoutItem(dashboard.Items["rangeFilterDashboardItem1"], 15);            
            // Create a root layout group. Its DashboardItem property is null.
            DashboardLayoutGroup rootGroup = new DashboardLayoutGroup()
            {
                Orientation = DashboardLayoutGroupOrientation.Vertical,
                Weight = 100,
                DashboardItem = null
            };
            // Connect layout items in the layout tree. 
            rootGroup.ChildNodes.AddRange(layoutGroup, rangeFilterLayoutItem);
            // The layout treee is built. Set the dashboard's root layout node to finalize the layout.
            dashboard.LayoutRoot = rootGroup;
            dashboard.EndUpdate();

            dashboardViewer1.Dashboard = dashboard;

Form1.vb

Imports System
Imports System.Linq
Imports DevExpress.XtraEditors
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
'...
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("Data\LayoutUnordered.xml")
            dashboard.BeginUpdate()
            ' Switch off the DateFilter item's AutoHeight arrangement mode so that the DateFilter layout does not ignore its layout weight.
            CType(dashboard.Items("dateFilterDashboardItem1"), DateFilterDashboardItem).ArrangementMode = DateFilterArrangementMode.Horizontal
            ' Hide captions.
            dashboard.Items.ForEach(Sub(item) item.ShowCaption = False)
            dashboard.Groups.ForEach(Sub(item) item.ShowCaption = False)
            ' Create layout items for the DateFilter and Chart dashboard items.
            Dim dateFilterLayoutItem As New DashboardLayoutItem(dashboard.Items("dateFilterDashboardItem1"), 13)
            Dim chartLayoutItem As New DashboardLayoutItem(dashboard.Items("chartDashboardItem1"), 87)
            ' Create a layout item for the dashboard Group item.
            Dim groupLayoutItem As New DashboardLayoutGroup() With {.Orientation = DashboardLayoutGroupOrientation.Vertical, .DashboardItem = dashboard.Groups("dashboardItemGroup1"), .Weight = 70}
            ' Connect layout items in the layout tree.
            groupLayoutItem.ChildNodes.AddRange(dateFilterLayoutItem, chartLayoutItem)
            ' Create a Grid layout item.
            Dim gridLayoutItem As New DashboardLayoutItem(dashboard.Items("gridDashboardItem1"), 30)
            ' Create a group layout item to organize the Grid layout item and a Dashboard Group layout item.
            Dim layoutGroup As New DashboardLayoutGroup(DashboardLayoutGroupOrientation.Horizontal, 85)
            ' Connect layout items in the layout tree.
            layoutGroup.ChildNodes.AddRange(gridLayoutItem, groupLayoutItem)
            ' Create a RangeFilter layout item.
            Dim rangeFilterLayoutItem As New DashboardLayoutItem(dashboard.Items("rangeFilterDashboardItem1"), 15)
            ' Create a root layout group. Its DashboardItem property is null.
            Dim rootGroup As New DashboardLayoutGroup() With {.Orientation = DashboardLayoutGroupOrientation.Vertical, .Weight = 100, .DashboardItem = Nothing}
            ' Connect layout items in the layout tree. 
            rootGroup.ChildNodes.AddRange(layoutGroup, rangeFilterLayoutItem)
            ' The layout treee is built. Set the dashboard's root layout node to finalize the layout.
            dashboard.LayoutRoot = rootGroup
            dashboard.EndUpdate()

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DashboardLayoutItem class.

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.

VB.NET

wpf-dashboard-olap-data-provider/VB/WpfDashboard_OlapDataProvider/MainWindow.xaml.vb#L74

dBoard.Items.AddRange(cardItem, chartItem)
Dim cardLayoutItem As DashboardLayoutItem = New DashboardLayoutItem(cardItem)
Dim chartLayoutItem As DashboardLayoutItem = New DashboardLayoutItem(chartItem)

Inheritance

Object

DashboardLayoutNode

DashboardLayoutItem