GaugeDashboardItem Class

A Gauge dashboard item that visualizes data within a series of KPI elements (gauges).

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class GaugeDashboardItem :
    KpiDashboardItem<Gauge>

VB.NET

Public Class GaugeDashboardItem
    Inherits KpiDashboardItem(Of Gauge)

Remarks

The Gauge dashboard item visualizes data within a series of KPI elements called gauges.

The following documentation is available.

• WinForms Designer - Creating Gauges
• Web Dashboard - Creating Gauges

Example

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

View Example: How to Bind a Gauge Dashboard Item to Data at Runtime

Form1.cs

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

namespace Dashboard_CreateGauges {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm
    {
        public Form1() {
            InitializeComponent();
        }
        private GaugeDashboardItem CreateGauges(DashboardObjectDataSource dataSource) {

            GaugeDashboardItem gauges = new GaugeDashboardItem();
            gauges.ViewType = GaugeViewType.CircularHalf;
            gauges.DataSource = dataSource;

            Gauge gauge = new Gauge();
            gauge.ActualValue = new Measure("Extended Price", SummaryType.Sum);
            gauges.Gauges.Add(gauge);

            gauges.SeriesDimensions.Add(new Dimension("Sales Person"));

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

            dashboardViewer1.Dashboard = new Dashboard();

            DashboardObjectDataSource dataSource = new DashboardObjectDataSource();
            dashboardViewer1.AsyncDataLoading+=(s,ev) => {
                ev.Data = (new nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData();
            };
            dashboardViewer1.Dashboard.DataSources.Add(dataSource);

            GaugeDashboardItem gauges = CreateGauges(dataSource);
            dashboardViewer1.Dashboard.Items.Add(gauges);

            dashboardViewer1.ReloadData();
        }
    }
}

Form1.vb

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

Namespace Dashboard_CreateGauges
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

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

            Dim gauges As New GaugeDashboardItem()
            gauges.ViewType = GaugeViewType.CircularHalf
            gauges.DataSource = dataSource

            Dim gauge As New Gauge()
            gauge.ActualValue = New Measure("Extended Price", SummaryType.Sum)
            gauges.Gauges.Add(gauge)

            gauges.SeriesDimensions.Add(New Dimension("Sales Person"))

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

            dashboardViewer1.Dashboard = New Dashboard()

            Dim dataSource As New DashboardObjectDataSource()
            AddHandler dashboardViewer1.AsyncDataLoading, Sub(s,ev)
                ev.Data = (New nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData()
            End Sub
            dashboardViewer1.Dashboard.DataSources.Add(dataSource)

            Dim gauges As GaugeDashboardItem = CreateGauges(dataSource)
            dashboardViewer1.Dashboard.Items.Add(gauges)

            dashboardViewer1.ReloadData()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GaugeDashboardItem 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.

C#

how-to-bind-a-gauge-dashboard-item-to-data-in-code-e4771/CS/Dashboard_CreateGauges/Form1.cs#L11

}
private GaugeDashboardItem CreateGauges(DashboardObjectDataSource dataSource) {

web-forms-dashboard-gauge-ranges/CS/Default.aspx.cs#L35

XRGaugeDashboardItem gaugeControl = control.Value as XRGaugeDashboardItem;
GaugeDashboardItem gaugeItem = e.GetDashboardItem(componentName) as GaugeDashboardItem;

VB.NET

how-to-bind-a-gauge-dashboard-item-to-data-in-code-e4771/VB/Dashboard_CreateGauges/Form1.vb#L12

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

Implements

ICustomPropertyProvider

Inheritance

Object

DashboardItem

DataDashboardItem

SeriesDashboardItem

KpiDashboardItem<Gauge>

GaugeDashboardItem