GridDashboardItem Class

A Grid dashboard item that visualizes data in tabular form.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class GridDashboardItem :
    DataDashboardItem,
    ISparklineArgumentHolder

VB.NET

Public Class GridDashboardItem
    Inherits DataDashboardItem
    Implements ISparklineArgumentHolder

Remarks

The Grid shows data in tabular form while allowing you to summarize against specific measures or calculate differences between them.

The following documentation is available.

• WinForms Designer - Creating a Grid
• Web Dashboard - Creating a Grid

Example

The following example demonstrates how to create Grid columns and bind a Grid dashboard item to data in code.

As a result, you get the Grid dashboard item with predefined columns.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-new-dashboard-add-a-grid-dashboard-item-to-it-and-bind-it-to-data-in-code-e4768.

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.DataAccess.Excel;
using DevExpress.XtraEditors;
using System;

namespace Dashboard_CreateGrid {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e) {

            // Creates the Excel data source.
            DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource();
            excelDataSource = CreateExcelDataSource();

            // Creates the Grid dashboard item and adds it to a dashboard.
            dashboardViewer1.Dashboard = new Dashboard();
            dashboardViewer1.Dashboard.DataSources.Add(excelDataSource);
            GridDashboardItem grid = CreateGrid(excelDataSource);
            dashboardViewer1.Dashboard.Items.Add(grid);

            // Reloads data in the data sources.
            dashboardViewer1.ReloadData();
        }
        private GridDashboardItem CreateGrid(DashboardExcelDataSource dataSource) {

            // Creates a grid dashboard item and specifies its data source.
            GridDashboardItem grid = new GridDashboardItem();
            grid.DataSource = dataSource;

            // Creates new grid columns of the specified type and with the specified dimension or
            // measure. Then, adds these columns to the grid's Columns collection.
            grid.Columns.Add(new GridHyperlinkColumn(new Dimension("Product"), "Product") 
                {UriPattern= "https://www.google.com/search?q={0}" });
            grid.Columns.Add(new GridDimensionColumn(new Dimension("Category")));
            grid.Columns.Add(new GridMeasureColumn(new Measure("Count")));
            grid.Columns.Add(new GridDeltaColumn(new Measure("Count"),
                                                 new Measure("TargetCount")));
            grid.Columns.Add(new GridSparklineColumn(new Measure("Count")));
            grid.SparklineArgument = new Dimension("Date", DateTimeGroupInterval.MonthYear);

            grid.GridOptions.EnableBandedRows = true;
            grid.GridOptions.ShowHorizontalLines = false;           

            return grid;
        }

        public DashboardExcelDataSource CreateExcelDataSource() {

            // Generates the Excel Data Source.
            DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource();
            excelDataSource.FileName = @"Data\SimpleDataSource.xls";
            ExcelWorksheetSettings worksheetSettings = new ExcelWorksheetSettings("Simple Data", "A1:F12");
            excelDataSource.SourceOptions = new ExcelSourceOptions(worksheetSettings);
            excelDataSource.Fill();

            return excelDataSource;
        }
    }
}

Form1.vb

Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.Excel
Imports DevExpress.XtraEditors

Namespace Dashboard_CreateGrid
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load

            ' Creates the Excel data source.
            Dim excelDataSource As New DashboardExcelDataSource()
            excelDataSource = CreateExcelDataSource()

            ' Creates the Grid dashboard item and adds it to a dashboard.
            dashboardViewer1.Dashboard = New Dashboard()
            dashboardViewer1.Dashboard.DataSources.Add(excelDataSource)
            Dim grid As GridDashboardItem = CreateGrid(excelDataSource)
            dashboardViewer1.Dashboard.Items.Add(grid)

            ' Reloads data in the data sources.
            dashboardViewer1.ReloadData()
        End Sub
        Private Function CreateGrid(ByVal dataSource As DashboardExcelDataSource) As GridDashboardItem

            ' Creates a grid dashboard item and specifies its data source.
            Dim grid As New GridDashboardItem()
            grid.DataSource = dataSource

            ' Creates new grid columns of the specified type and with the specified dimension or
            ' measure. Then, adds these columns to the grid's Columns collection.
            grid.Columns.Add(New GridHyperlinkColumn(New Dimension("Product"), "Product") _
                    With {.UriPattern= "https://www.google.com/search?q={0}"})
            grid.Columns.Add(New GridDimensionColumn(New Dimension("Category")))
            grid.Columns.Add(New GridMeasureColumn(New Measure("Count")))
            grid.Columns.Add(New GridDeltaColumn(New Measure("Count"), New Measure("TargetCount")))
            grid.Columns.Add(New GridSparklineColumn(New Measure("Count")))
            grid.SparklineArgument = New Dimension("Date", DateTimeGroupInterval.MonthYear)

            grid.GridOptions.EnableBandedRows = True
            grid.GridOptions.ShowHorizontalLines = False

            Return grid
        End Function

        Public Function CreateExcelDataSource() As DashboardExcelDataSource

            ' Generates the Excel Data Source.
            Dim excelDataSource As New DashboardExcelDataSource()
            excelDataSource.FileName = "Data\SimpleDataSource.xls"
            Dim worksheetSettings As New ExcelWorksheetSettings("Simple Data", "A1:F12")
            excelDataSource.SourceOptions = New ExcelSourceOptions(worksheetSettings)
            excelDataSource.Fill()

            Return excelDataSource
        End Function
    End Class
End Namespace

Inheritance

Object

DashboardItem

DataDashboardItem

GridDashboardItem