New to Telerik ReportingStart a free 30-day trial

Using the Linear Gauge Report Item

The steps below will demonstrate how to add the Telerik Reporting Linear Gauge report item to reports.

Adding a Linear Gauge to the Report

Properties of the Gauge Report Item

The Gauge Report Item is a data item and as such inherits the properties of the Telerik.Reporting.DataItem class.

Properties specific to the Appearance

  • Mirrored - The Linear Gauge item generates a mirrored projection of its contents. The default layout for Horizontal is to display it below the ranges while for Vertical, it is rendered to the left of the gauge.
  • Orientation - Determines whether the gauge will be rendered using a horizontal or vertical scale.
  • Reversed - Determines the direction of the ranges and scale of the gauge. For Horizontal orientation, the default direction is left-to-right while for Vertical gauge, it is bottom-to-top.
  • Value - Represents the value of the gauge for the current instance.

Properties specific to the Presentation

  • Indicator - Represents a LinearGaugeIndicator instance defining the visual type of the indicator.

    • Length - Represents the length of the indicator used to display the current value. The value is used as a percentage ratio to the total Width of the gauge.
    • Offset - Represents the offset of the indicator used to display the current value relative to the gauge range. The value is used as a percentage ratio to the total Width of the gauge. For example, if the value is 0, the indicator would start at the left border of the item and vice versa.
    • Style - Represents a Style instance used to style indicator elements.
    • Thickness - Represents a ratio of the value of the Style.LineWidth of the indicator.
    • Type - Represents the type of indicator to be displayed next to the linear gauge. The available options are listed in the IndicatorType enum.
  • Labels - The LinearGaugeLabels collection associated with this gauge item.

    • FirstVisibleValue - Represents the minimum value for which a label will be rendered. Can be used to restrict the label set. If left empty, all labels will be visible.
    • Format - Represents the format that will be applied on the labels of the linear gauge.
    • Offset - Represents the offset of the label strings from the gauge range. The value is used as a percentage ratio to the total Width of the gauge.
    • RenderingType - Represents the selected RenderingType options for the given label.
    • LastVisibleValue - Represents the maximum value for which a label will be rendered. Can be used to restrict the label set. If left empty, all labels will be visible.
    • SegmentCount - Represents the total count of labels that will be generated. It is recommended to be equal to the Ticks count.
    • Style - Represents a Style instance used to style the labels.
  • Ranges - The LinearGaugeRangeCollection associated with this gauge item. A gauge can have multiple ranges. This is how the Multi-Range gauge is implemented.

    • End - Represents the top value of the linear gauge's range.
    • EndWidth - Represents the end width of the linear gauge item as a percentage of the total Width of the item. A value of 50 would mean that the last point of the gauge range area will be half the whole item's width.
    • Offset - Represents the offset of the range area from the left/top border of the item. The value is used as a percentage ratio to the total Width of the gauge.
    • Start - Represents the bottom value of the linear gauge's range.
    • StartWidth - Represents the start width of the linear gauge item as a percentage of the total Width of the item. A value of 50 would mean that the first point of the gauge range area will be half the whole item's width.
    • Style - Represents a Style instance used to style the range area.
  • Scales - The LinearGaugeScaleCollection associated with this gauge item. A gauge can have multiple scales. This is how the Three-Range gauge is implemented.

    • End - Represents the top value of the linear gauge's scale line.
    • Offset - Represents the offset of the scale line from the left/top border of the item. The value is used as a percentage ratio to the total Width of the gauge.
    • Start - Represents the bottom value of the linear gauge's scale line.
    • Style - Represents a Style instance used to style the scale line.
  • Ticks - The LinearGaugeTicks collection associated with this gauge item.

    • FirstVisibleIndex - Represents the starting tick index from which ticks will be rendered. Can be used to restrict the tick set to a smaller range than the full scale. Tick indexing starts at 0.
    • LastVisibleIndex - Represents the last tick index until which ticks will be rendered. Can be used to restrict the tick set to a smaller range than the full scale. Tick indexing starts at 0.
    • Length - Represents the size of the tick's visual element as a percentage ratio to the gauge's range.
    • Offset - Represents the offset of the tick area from the left/top border of the item. The value is used as a percentage ratio to the total Width of the gauge.
    • SegmentCount - Represents the total count of ticks that will be generated for the given gauge range.
    • TickType - Represents the type of the shape that will be used for rendering the ticks.
    • Style - Represents a Style instance used to style the ticks.

See Also