Standard Gauge Properties

Overview

Most gauges share a standard set of gauge properties described below. The available properties depend on the gauge type, display model and firmware support. In addition to these standard properties, many gauges have additional properties that are described in their relevant section.

Standard Properties

The standard gauge properties are as follows:

Property Description
Name The name is used to identify the gauge. Dash Design assigns a name to a new gauge automatically. The gauge is also automatically renamed when changing the gauge text for Text Label gauges or changing the Input for all other gauges. This makes it easy to identify the purpose of a gauge in any lists or editors.
Input The output used by the gauge.
Display Name An editable display name for gauges whose Name is read-only. Shown in gauge structure tree view.
Input Filter Opens the input filtering/modifier settings used to process the value before it reaches the gauge. See Filter Channel for filter types.
Input Value A design-time input value used to preview the gauge’s appearance. This is a preview control, not a replacement for the assigned input on the display.
Visibility Input The output used to control whether the gauge is shown. A value of zero hides the gauge; any non-zero value shows it. When assigned, this input overrides the Visible flag. When no visibility input is assigned, the Visible flag determines whether the gauge is shown. Available on supported displays.
Visible The visibility flag used when no Visibility Input is assigned. Enabled by default: enable it to show the gauge or disable it to hide the gauge. Available on supported displays.
Minimum The value at which a gauge starts, for example the start value of a bar gauge.
Maximum The value at which a gauge finishes, for example the end value of a bar gauge.
Resolution The resolution of the bar or tacho gauge. This is the value change that will move the bar or tacho to the next segment.
Label Frequency Labels are drawn at every Label Frequency multiplied by the resolution.
Label Divisor Divides tacho label values before displaying them. For example, a divisor of 1000 displays 8000 as 8.
Label Font The font used for tacho labels. See Font Editor .
Label Colour The colour of tacho labels.
Font The font used by the gauge. See Font Editor . The Font property also allows changing the size and style of the font in-place.
Justify Aligns text to the left, right or centre of the gauge’s bounding rectangle.
Direction Controls text orientation or the direction in which gauge elements are arranged. The available choices depend on the gauge type; see Label Gauge and Bit Gauge .
Enable AA Enables anti-aliasing to reduce jagged edges when drawing the gauge. The default inherits the screen setting, which in turn inherits the General display setting. Anti-aliasing may affect performance on some displays.
Format Determines how numbers are formatted in the gauge. See the Value Formatting section for more information.
Special Format Displays internal system values. See the Value Formatting section for more information.
Left The left most (x) position of the gauge.
Top The top most (y) position of the gauge.
Width The width of the gauge. Some gauges are sized implicitly on their contents in which case the Width property will not be available.
Height The height of the gauge. Some gauges are sized implicitly on their contents in which case the Height property will not be available.
Background Colour of the gauge background.
Transparent Background Makes the gauge background transparent so that content behind it remains visible.
Background Gradient Sets a gradient for the background of supported bar gauges instead of a single background colour.
Line Colour of the graticules and/or outline of the gauge.
Fill Colour in which to draw a filled part of the gauge, for example the part of a bar graph that has data.
Fill Gradient Sets a gradient for the filled part of supported bar gauges instead of a single fill colour.
Text Colour of all text in the gauge.
Colour Mode Selects input-driven or alarm-based colouring where supported. The associated Colour Input, Colour Preview, Alarm Limit, Alarm Colour and Alarm Flash controls depend on the mode. See Value Gauge .
Colour Source, Colour Map, Colour Preview Control input-driven colouring on displays with the shared colour controller. See Colour Source.

Colour Source

On supported gauges and displays, the shared colour controller provides a colour source and up to four warning levels. These settings are separate from the older Colour Mode controls described for individual gauge types.

Property Description
Colour Source Selects the channel that drives the gauge colour. Without a Colour Map, its value is interpreted as an RGB colour. The gauge’s fixed fill setting(s) are used until a colour source value has been received.
Colour Map Maps the colour source value through a colour gradient, allowing an ordinary numeric channel to control the colour. Available when a Colour Source is assigned.
Colour Preview Supplies a design-time colour source value to preview the resulting colour. Available when a Colour Source is assigned.

Warning Levels

The shared colour controller provides Warning 1 through Warning 4. Each level compares its own source channel against a threshold and applies a warning colour when the comparison is true. Higher-numbered warnings take priority over lower-numbered warnings: Warning 1 has the lowest priority and Warning 4 the highest.

Assign a Source to configure a warning level. Its comparison, colour, flash and preview controls are available once a source is assigned.

Property Description
Source The channel whose value is compared with the warning threshold.
Priority Read-only information identifying Warning 1 as the lowest-priority level and Warning 4 as the highest-priority level.
Comparator The comparison operator used to test the source value against the threshold.
Threshold The value against which the warning source is compared.
Tolerance Allows for small floating-point inaccuracies when comparing values.
Colour The gauge colour used while this warning is active.
Flash Rate [ms] A positive value makes the warning colour flash at the specified rate in milliseconds. Zero disables flashing.
Preview A design-time warning source value used to preview the warning’s effect.