GaugeDashboardItem.Gauges Property

Gets the collection of objects that provide data for calculating values displayed by gauges.

Namespace: DevExpress.DashboardCommon

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

Declaration

public GaugeCollection Gauges { get; }

Property Value

Type Description
GaugeCollection

A collection of Gauge objects that provide data for calculating values displayed by gauges.

Remarks

Use the Gauges property to provide data for the GaugeDashboardItem. Each Gauge object in the Gauges collection contains two measures: the KpiElement.ActualValue and the KpiElement.TargetValue. These measures are used to calculate the actual and target values. Gauges displayed within the GaugeDashboardItem indicate the first value with a needle, and the second with a marker. In addition, the difference between the actual and target values is displayed within each gauge.

You can specify the type of summary function calculated against each measure using the Measure.SummaryType property. To specify how the difference between actual and target values should be displayed, use the options exposed by the KpiElement.DeltaOptions property.

The GaugeDashboardItem creates a single gauge for each element in the Gauges collection if no series dimensions are specified. Otherwise, if the SeriesDashboardItem.SeriesDimensions collection is not empty, the dashboard item creates multiple gauges for each Gauge object, so that each gauge corresponds to a particular dimension value (or a combination of values, if several dimensions are added). If there are also several Gauge objects within the Gauges collection, gauges that correspond to different Gauge objects are not displayed within a single screen but constitute several views. To switch between them, use the Other Gauges button located on the bottom toolbar.

Gauges_MultipleScreens

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

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.

See Also