LinearGauge
Linear Gauge
Definition
Namespace:Telerik.Reporting
Assembly:Telerik.Reporting.dll
Syntax:
[ToolboxBitmap(typeof(LinearGauge), "Resources.GaugeLinear.png")]
public class LinearGauge : DataItem, IToggleVisibilityTarget, IActionTarget, IDataItem, IDataFlow, IDataSourceContainerInheritance: objectReportObjectReportItemBaseReportItemDataItemLinearGauge...
Implements:
Inherited Members
Constructors
The linear gauge report item used to visualize key performance indicators (KPIs) along a horizontal or vertical scale. It displays values using pointers, ranges, labels, and ticks to show progress relative to defined minimum and maximum values. Commonly used in reports and dashboards to present metrics such as percentages, capacity usage, or progress toward a goal.
public LinearGauge()Properties
DataSource
object
The data source that the LinearGauge is displaying data for. If not set, the Gauge will use the parent item's data scope.
[TypeConverter(typeof(DataSourceConverter))]
[AIAssistantByRef("/DataSources")]
[AIAssistantRequired(false)]
public override object DataSource { get; set; }An object that functions as a data source.
Overrides:
Telerik Reporting includes dedicated data source components that enable retrieving and feeding all data items from various sources. See all the available data source components at: https://docs.telerik.com/reporting/designing-reports/connecting-to-data/data-source-components/overview
For convenience, all the objects applicable to the DataSource property can be directly assigned to this DataSource property. At runtime, the report engine will wrap them in an ObjectDataSource to resolve the actual data.
Gets the LinearGaugeIndicator defined for the current Gauge.
[AIAssistantRequired]
[AIAssistantDescription("The pointer that marks the current Value on the gauge's scale. It is always present, so configure it rather than omitting it - set its Offset to place it along the gauge and its Style to control its appearance.")]
public LinearGaugeIndicator Indicator { get; }The collection of LinearGaugeLabels defined for the current Gauge.
[AIAssistantRequired]
[AIAssistantDescription("The numeric labels rendered along the gauge's scale. Without them the gauge shows no readable values.")]
public LinearGaugeLabelsCollection Labels { get; }Mirrored
bool
The Mirrored property of the gauge which generates a mirrored projection of its contents. The default layout is scales-below-the-ranges for horizontal and scales-on-the-left-of-the-ranges for vertical gauge.
public bool Mirrored { get; set; }The orientation of the gauge.
public GaugeOrientation Orientation { get; set; }The collection of LinearGaugeRange defined for the current Gauge.
[AIAssistantRequired]
[AIAssistantDescription("The color ranges (bands) drawn along the gauge's scale. Each range covers the interval between its Start and End values and is painted with its Style.BackgroundColor. A range is only visible when its StartWidth and EndWidth are set, because both default to 0.")]
public LinearGaugeRangeCollection Ranges { get; }Reversed
bool
The Reversed property of the gauge which determines the drawing direction for its ranges. The default direction is left-to-right for horizontal and bottom-to-top for vertical gauge.
public bool Reversed { get; set; }The collection of LinearGaugeScale defined for the current Gauge.
[AIAssistantRequired]
[AIAssistantDescription("The scales of the gauge. A scale defines the Start and End values the gauge plots, so the ranges, ticks, labels and indicator are all positioned against it. Author at least one scale.")]
public LinearGaugeScaleCollection Scales { get; }The collection of LinearGaugeTicks defined for the current Gauge.
[AIAssistantRequired]
[AIAssistantDescription("The tick marks rendered along the gauge's scale. Without them the scale has no visible subdivisions.")]
public LinearGaugeTicksCollection Ticks { get; }Value
object
The current value of the Gauge.
[TypeConverter(typeof(ObjectValueConverter))]
[AIAssistantDescription("The value to be displayed by the Gauge. Can be a numeric value or an expression that evaluates to a numeric value. Expressions are a string that starts with '='. Often, the value is a percentage, showing the progress or part of a whole. For example, if the Gauge is used to show the percentage of sales % of product 'A' achieved, the value might be '= (SUM(If(Fields.Product = \"A\", Fields.Value, 0)) / SUM(Fields.Value)) * 100'.")]
public object Value { get; set; }Can be a numeric value or an expression that evaluates to a numeric value. Expressions are a string that starts with "=". Often, the value is a percentage, showing the progress or part of a whole. For example, if the Gauge is used to show the percentage of sales % of product "A" achieved, the value might be "= (SUM(If(Fields.Product = "A", Fields.Value, 0)) / SUM(Fields.Value)) * 100".