Simple Gauge

This component displays a simple gauge with one or more pointers and scales.

This is what a simple gauge component looks like:

Common Properties

Width, Height, Bindings, Enabled, Visible, Border, Cursor, Popup Menu

Custom Properties

Data Values

(Default Property)

A list of data values that will be indicated by the gauge. This is an indexed property.

Property name: datasets

Property type: Data Table

Background

Gauge background (may be a solid color, linear/radial gradient or texture).

Fields of gauge background:

Field	Type	Description
Visible	Boolean	Flag that determines whether or not the background is drawn.
Paint	Data Table	Paint used to fill the background.

Property name: gaugeBackground

Property type: Data Table

Frame

Properties of Circle-type frame.

Fields of gauge frame:

Field	Type	Description
Visible	Boolean	Flag that determines whether or not the frame is drawn.
Background Paint	Data Table	Paint used to fill the space between the double lines around the outer edge of the frame circle.
Foreground Paint	Data Table	Paint used to draw the double lines around the outside of the gauge.
Radius	Float	Radius, expressed as a percentage relative to the framing rectangle.
Stroke	Data Table	Stroke used to draw the frame outline.

Property name: frame

Property type: Data Table

View

The dimensions of the dial plot are calculated relative to a framing rectangle, but in some cases it is required only a subset of the dial to be presented in the plot area. The View parameter allows it by setting the viewing rectangle relative to the plot’s framing rectangle.

Fields of view:

Field	Type	Description
X	Float	The relative position of the viewing rectangle’s x-coordinate with reference to the framing rectangle. The value can be in the range 0.0 to 1.0.
Y	Float	The relative position of the viewing rectangle’s y-coordinate with reference to the framing rectangle. The value can be in the range 0.0 to 1.0.
Width	Float	The relative width of the viewing rectangle with reference to the framing rectangle. The value can be in the range 0.0 to 1.0.
Height	Float	The relative height of the viewing rectangle with reference to the framing rectangle. The value can be in the range 0.0 to 1.0.

Property name: view

Property type: Data Table

Cap

Gauge cap. This is the circle in the middle of the gauge (to which the needles connect).

Fields of gauge cap:

Field	Type	Description
Visible	Boolean	Flag that determines whether or not the cap is drawn.
Fill Paint	Data Table	Paint used to fill the cap.
Outline Paint	Data Table	Paint used to draw the cap outline.
Outline Stroke	Data Table	Stroke used to draw the cap’s outline.
Radius	Float	Radius for the cap, as a percentage of the size of the gauge’s framing rectangle.

Property name: cap

Property type: Data Table

Scales

A table of gauge scales and their associations with Data Values. Every record has a Data Value Index field that defines which data value will be indicated on the scale.

The scale can display major and minor tick marks at user-specified intervals, and numerical labels for the major tick marks. To control the arc through which the scale is drawn on the gauge, you can specify the starting angle and the extent (in degrees).

Fields of the scales table:

Field	Type	Description
Data Value Index	Integer	Index of the data value indicated on the scale.
Scale	Data Table	Scale properties.

Fields of gauge scale:

Field	Description
Visible	Flag that determines whether or not the scale is drawn.
Lower Bound	Lower bound for the scale.
Upper Bound	Upper bound for the scale.
Start Angle	Angle (in degrees) for the starting point of the scale.
Extent	Extent (in degrees) for the scale.
Tick Radius	The tick radius determines how far out on the gauge the tick marks are drawn (typically they will appear near the outer edge of the gauge, but for a gauge that shows more than one scale you might want to show a scale closer to the center). The tick radius defines the reference point for the major and minor tick marks, as well as the labels for the major tick marks. It is specified as a percentage of the gauge’s framing rectangle.
Major Tick Increment	Interval between major tick marks.
Major Tick Length	Length of the major tick marks, expressed as an amount to be subtracted from the tick radius.
Major Tick Paint	Paint used to draw the major tick marks.
Major Tick Stroke	Stroke used to draw the major tick marks.
Minor Tick Count	Number of minor tick marks to display between each pair of major tick marks.
Minor Tick Length	Length of minor tick marks, as a radius specified as a percentage of the gauge’s framing rectangle.
Minor Tick Paint	Paint used to draw the minor tick marks.
Minor Tick Stroke	Stroke used to draw the minor tick marks.
Tick Label Font	Font used to display the tick labels.
Tick Label Formatter	Number formatter used to convert the tick label values to strings.
Tick Label Offset	The anchor point for each label is determined using the tick radius adjusted by an offset value. Once the anchor point is determined, the value label is centered on the anchor point.
Tick Label Paint	Paint used to display the tick labels.
Tick Labels Visible	Flag that controls whether or not the tick labels are visible.
First Tick Label Visible	Flag that controls whether or not the first tick label is visible.

Property name: scales

Property type: Data Table

Ranges

Gauge ranges. Every range is painted as a color arc. It is used to highlight a range of values, e.g. “normal”, “high” and “extreme”. The range is primarily defined by its lower and upper bounds. The range highlights are drawn at a specified radius within the gauge.

Fields of gauge range:

Field	Type	Description
Visible	Boolean	Flag that determines whether or not the range is drawn.
Scale Index	Integer	Range is measured relatively to a scale with specific index.
Lower Bound	Float	Lower bound for the range, in data units.
Upper Bound	Float	Upper bound for the range, in data units.
Inner Radius	Float	Radius for the inner highlight of the range, as a percentage of the size of the gauge’s framing rectangle.
Outer Radius	Float	Radius for the outer highlight of the range, as a percentage of the size of the gauge’s framing rectangle.
Paint	Data Table	Paint used to highlight the range.

Property name: ranges

Property type: Data Table

Normal Pointers

A list of normal pointers, drawn as long triangular shapes. Pointers are used for indicating the current value on the gauge.

Fields of normal pointer:

Field	Type	Description
Data Value Index	Integer	Index of data value indicated by the pointer.
Visible	Boolean	Flag that determines whether or not the pointer is drawn.
Fill Paint	Data Table	Paint used to fill the pointer.
Outline Paint	Data Table	Paint used to draw the outline of the pointer.
Radius	Float	Length of the pointer, as a percentage of the size of the gauge’s framing rectangle.
Width Radius	Float	The width of the base of the pointer is specified as a radius, in percentage terms relative to the size of the gauge’s framing rectangle.

Property name: normalPointers

Property type: Data Table

Pin Pointers

A list of pin pointers. A pin pointer that is drawn as a thin straight line. Pointers are used for indicating the current value on the gauge.

Fields of pin pointer:

Field	Type	Description
Data Value Index	Integer	Index of data value indicated by the pointer.
Visible	Boolean	Flag that determines whether or not the pointer is drawn.
Paint	Data Table	Paint used to draw the pointer.
Radius	Float	Length of the pointer, as a percentage of the size of the gauge’s framing rectangle.
Stroke	Data Table	Stroke used to draw the pointer.

Property name: pinPointers

Property type: Data Table

Value Indicators

A list of value indicators showing current data values.

Fields of value indicator:

Field	Type	Description
Data Value Index	Integer	Index of data value shown by the indicator.
Visible	Boolean	Flag that determines whether or not the indicator is drawn.
Angle	Float	The anchor point for positioning the indicator is specified in terms of an angle and a radius. This property is the angle, in degrees, for calculating the anchor point.
Radius	Float	Radius, relative to the gauge’s framing rectangle.
Font	Data Table	Font used to display the indicator value.
Frame Anchor	String	The value indicator is displayed as a text item in a frame. The frame anchor specifies the point on this frame that will be aligned to the anchor point (which is calculated from the angle and radius).
Insets	Data Table	Insets (top, left, bottom, right) which determine the white-space around the indicator value.
Number Format	String	Number formatter used to format the value.
Outline Paint	Data Table	Paint used to draw the outline around the indicator.
Outline Stroke	Data Table	Stroke used to draw the outline around the indicator.
Paint	Data Table	Paint used to display the indicator value.
Background Paint	Data Table	Paint used to fill the background of the indicator.
Template Value	Float	To ensure that the value indicator has a fixed width regardless of the current value in the dataset, a template value is used to calculate the dimensions of the indicator. This template value will be formatted using the current number formatter, then the dimensions of the string will be used to determine the dimensions of the value indicator.
Value Anchor	String	The value anchor determines the point to which the value text will be aligned.
Text Anchor	String	Point on the text that is aligned to the value anchor.

Property name: indicators

Property type: Data Table

Text Annotations

A list of text annotations. Text annotation is a text string displayed at an arbitrary location on a gauge.

Fields of text annotation:

Field	Type	Description
Label	String	Text displayed by the annotation.
Visible	Boolean	Flag that determines whether or not the annotation is drawn.
Angle	Float	The anchor point for the text label is defined by an angle and a radius. This property is the angle (in degrees) that determines the text anchor point.
Radius	Float	Radius used to determine text anchor point, as a percentage relative to the gauge’s framing rectangle.
Anchor	String	Anchor specifies how text is aligned to its anchor point.
Paint	Data Table	Paint used to display the label.
Font	Data Table	Font used to display the label.

Property name: annotations

Property type: Data Table

Common Events

Hidden, Shown, Moved, Resized, Mouse Clicked, Mouse Pressed, Mouse Released, Mouse Entered, Mouse Exited, Mouse Moved, Mouse Wheel Moved, Key Typed, Key Pressed, Key Released, Focus Gained, Focus Lost

DPF_EXPORT_V5.8.8 / TIME_1743710541 / 2025-04-03 20:02:21 / STRLEN_29395 / STRLEN_HTML_27133

{VERSION}

Was this page helpful?