GaugeDashboardItem Class

A Gauge dashboard item that visualizes data within a series of gauges.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v18.2.Core.dll

Declaration

C#
VB.NET

public class GaugeDashboardItem :
    KpiDashboardItem<Gauge>

Public Class GaugeDashboardItem
    Inherits KpiDashboardItem(Of Gauge)

Remarks

The gauge dashboard item visualizes data within a series of gauges.

MainFeatures_Gauges

The following documentation is available.

Example

The following example demonstrates how to bind a Gauge dashboard item to data in code.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-gauge-dashboard-item-to-data-in-code-e4771.

Form1.vb
Form1.cs

Imports System
Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess

Namespace Dashboard_CreateGauges
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub
        Private Function CreateGauges(ByVal dataSource As DashboardObjectDataSource) As GaugeDashboardItem

            ' Creates a gauge dashboard item and specifies its data source.
            Dim gauges As New GaugeDashboardItem()
            gauges.DataSource = dataSource

            ' Creates the Gauge object with measures that provide data for calculating actual and target
            ' values, and then adds this object to the Gauges collection of the gauge dashboard item.
            Dim gauge As New Gauge()
            gauge.ActualValue = New Measure("Extended Price", SummaryType.Average)
            gauge.TargetValue = New Measure("Extended Price", SummaryType.Max)
            gauges.Gauges.Add(gauge)

            ' Specifies the dimension that provides data for a gauge dashboard item series.
            gauges.SeriesDimensions.Add(New Dimension("Sales Person"))

            Return gauges
        End Function
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load

            ' Creates a dashboard and sets it as the currently opened dashboard in the dashboard viewer.
            dashboardViewer1.Dashboard = New Dashboard()

            ' Creates a data source and adds it to the dashboard data source collection.
            Dim dataSource As New DashboardObjectDataSource()
            dataSource.DataSource = (New nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData()
            dashboardViewer1.Dashboard.DataSources.Add(dataSource)

            ' Creates a gauge dashboard item with the specified data source 
            ' and adds it to the Items collection to display within the dashboard.
            Dim gauges As GaugeDashboardItem = CreateGauges(dataSource)
            dashboardViewer1.Dashboard.Items.Add(gauges)

            ' Reloads data in the data sources.
            dashboardViewer1.ReloadData()
        End Sub
    End Class
End Namespace

using System;
using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.DataAccess;

namespace Dashboard_CreateGauges {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }
        private GaugeDashboardItem CreateGauges(DashboardObjectDataSource dataSource) {

            // Creates a gauge dashboard item and specifies its data source.
            GaugeDashboardItem gauges = new GaugeDashboardItem();
            gauges.DataSource = dataSource;

            // Creates the Gauge object with measures that provide data for calculating actual and target
            // values, and then adds this object to the Gauges collection of the gauge dashboard item.
            Gauge gauge = new Gauge();
            gauge.ActualValue = new Measure("Extended Price", SummaryType.Average);
            gauge.TargetValue = new Measure("Extended Price", SummaryType.Max);
            gauges.Gauges.Add(gauge);

            // Specifies the dimension that provides data for a gauge dashboard item series.
            gauges.SeriesDimensions.Add(new Dimension("Sales Person"));

            return gauges;
        }
        private void Form1_Load(object sender, EventArgs e) {

            // Creates a dashboard and sets it as the currently opened dashboard in the dashboard viewer.
            dashboardViewer1.Dashboard = new Dashboard();

            // Creates a data source and adds it to the dashboard data source collection.
            DashboardObjectDataSource dataSource = new DashboardObjectDataSource();
            dataSource.DataSource = (new nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData();
            dashboardViewer1.Dashboard.DataSources.Add(dataSource);

            // Creates a gauge dashboard item with the specified data source 
            // and adds it to the Items collection to display within the dashboard.
            GaugeDashboardItem gauges = CreateGauges(dataSource);
            dashboardViewer1.Dashboard.Items.Add(gauges);

            // Reloads data in the data sources.
            dashboardViewer1.ReloadData();
        }
    }
}