Report Designer/Gauge

Gauge is a built-in type of report part that displays data using a speedometer.

Define a Linear Gauge

../_images/Gauge_Properties.png

Fig. 280 Report Designer - Gauge Properties

  1. Select the chart in Report Body (See Manage Report Parts for how to add a chart).
  2. Click the expand icon (<) on the right to open the Properties boxes if needed.
  3. Select the vertical Report Part Properties box.
  4. The properties are listed in Report Part Properties box in these sections. (Fig. 280)
    • General Info
    • Gauge
    • Grouping
    • View
    • Printing

User can configure the properties and see changes reflected in Preview pane:

  • Select Linear Gauge in Gauge Type drop-down. (See below for Solid Gauge and Simple Gauge.)

  • ../_images/Gauge_Border_Settings.png

    Fig. 281 Report Designer - Gauge Border Settings

    Configure border settings:

    1. In Gauge group, click the gear icon (⚙) to open Gauge Border Settings pop-up.
    2. Choose the border to be visible or not.
    3. Select a border color.
    4. Select the border thickness (in pixels).
    5. Click OK to close the Border Settings pop-up.

    Note

    The Preview section will not be shown if the Show Preview section in Configuration Mode checkbox is unticked in Others tab in Advanced Settings.

    ../_images/Gauge_Border_Settings_No_Preview.PNG

    Report Designer - Gauge Border Settings without Preview section

    Please see Update Others Settings for more details.

  • Customize the relative distance between the tick marks (in Intervals box for Linear Gauge only).

  • ../_images/Color_Theme_Selection.PNG

    Fig. 282 Report Designer - Color Theme Selection

    Configure color theme settings:

    1. In Gauge group, click the gear icon (⚙) after the Color Theme option to open Color Theme Selection pop-up.
    2. Choose a color theme.
    3. Click OK to close the Color Theme Selection pop-up.

    Notes:

    When System Admin change the Default Color Setting, all report parts using the default color theme will update properly.

  • Select to use Separator. (See Define Separator)

  • It looks better to invert the Linear Gauge (to horizontal direction).

  • ../_images/Gauge_Data_Refresh_Interval_Settings.png

    Fig. 283 Report Designer - Gauge Data Refresh Interval Settings

    Configure Data Refresh Interval if needed.

  • Optionally display a long report in multiple pages.

  • Optionally choose to print each grid in a new page by checking Page Break After Separator in Printing group.

../_images/NW_Orders_Linear_Gauge_Sum(Freight)_Group(ShipCity).png

Fig. 284 Northwind Orders Linear Gauge

To define the above sample gauge:

  1. Select Northwind Orders table in Data Source.
  2. Add a gauge report part and select Linear Gauge as the type.
  3. Add [ShipCity] to Labels (X-axis) box, it will show up as Group(ShipCity).
  4. Click Add Metrics to create Metrics 1.
  5. Add [Freight] to Value box, it will show up as Sum(Freight).
  6. Optionally set the threshold values like following:
../_images/NW_Orders_Linear_Gauge_Sum(Freight)_Group(ShipCity)_Threshold.png

Fig. 285 Northwind Orders Line Gauge with Threshold

Screenshot for Dynamic Threshold to be updated.

Define Separator

The Separator option displays multiple sections of gauges according to each unique value of the field(s) defined in Separators box.

For example: this report with multiple gauges, each one for each country in Northwind Orders table.

../_images/NW_Orders_Gauge_Separator_ShipCountry_Sum(Freight)_Group(ShipCity).png

Fig. 286 Northwind Orders Gauge with ShipCountry Separator

  1. Tick Use Separator check-box in Grouping in Report Part Properties to see Separators box inside the gauge configuration.
  2. Add [ShipCity] to Labels (X-axis) box, it will show up as Group(ShipCity).
  3. Click Add Metrics to create Metrics 1.
  4. Add [Freight] to Value box, it will show up as Sum(Freight).
  5. Add [ShipCountry] to Separators box, it will show up as Group(ShipCountry).

Define a Solid Gauge

  1. Select Solid Gauge in Gauge Type drop-down.
  2. The rest of the properties are similar to Linear Gauge.

An example solid gauge with separator and threshold:

../_images/NW_Orders_Gauge_Separator_ShipCountry_Sum(Freight)_Group(ShipCity)_Threshold.png

Fig. 287 Northwind Orders Gauge with ShipCountry Separator and Threshold

../_images/Report_Simple_Gauge.png

Fig. 288 Sample Simple Gauge

Sample Simple Gauge.

Others

  • Grid view popup option. This option is available from version 2.10.0.

    Click gridViewIcon icon to see the grid view of the gauge data associated with the current metric.

    ../_images/Gauge_Grid_View_Popup.png

    Fig. 289 Grid View Popup Showing Total Freight


- Metric dropdown.

../_images/Gauge_Metric_Dropdown.png

Fig. 290 Gauge Metric dropdown