Moving Analog Indicator

The moving analog indicator is a component that displays an analog value in context with other information about that value. The current value is shown as an arrow pointing at a bar with segments showing the desired operating range, low and high alarm ranges, and interlock ranges.

This component allows for extremely fast information delivery: at a glance it is obvious to an operator whether or not the value is where it should be, or if it needs attention. If the value is in one of its alarm ranges, then that range changes color to get attention.

To switch this component between a horizontal vs vertical orientation, simply change the size so that it is either wide or tall, respectively. Typical setup of this component involves setting the ranges, and binding the Process Value property to a tag's value. Some properties may be cleared out (null value) in order to disable them. For example, you may indicate where the current setpoint is by setting the Setpoint Value property. If you don't want to display the setpoint, simply clear this value out.

Appearance

Show Value

Show the current value above or beneath the value indicator.

Scripting name	showValue
Data type	boolean

Value Format

The string format for the value, if it is shown.

Scripting name	valueFormat
Data type	String

Value Font

The font for the value label.

Scripting name	font
Data type	Font

Value Color

The color of the value label.

Scripting name	valueColor
Data type	Color

Range Fill

The background color of the range strip.

Scripting name	rangeFill
Data type	Color

Range Stroke

The stroke color for the range strip.

Scripting name	rangeStroke
Data type	Color

Desired Range Color

The color of the desired range.

Scripting name	desiredRangeColor
Data type	Color

Inactive Alarm Color

The color of inactive alarm range.

Scripting name	inactiveAlarmColor
Data type	Color

Level 2 Alarm Color

The color of an active level 2 alarm (Hi or Lo).

Scripting name	level2AlarmColor
Data type	Color

Level 1 Alarm Color

The color of an active level 1 alarm (Hi-Hi or Lo-Lo).

Scripting name	level1AlarmColor
Data type	Color

Interlock Color

The color of the interlock range.

Scripting name	interlockColor
Data type	Color

Value Indicator Fill

The fill color of the value indicator.

Scripting name	valueFill
Data type	Color

Value Indicator Stroke

The stroke color of the value indicator.

Scripting name	valueStroke
Data type	Color

Setpoint Fill

The fill color of the setpoint indicator.

Scripting name	setpointFill
Data type	Color

Setpoint Stroke

The stroke color of the setpoint indicator.

Scripting name	setpointStroke
Data type	Color

Stroke Width

The stroke width for lines drawn.

Scripting name	strokeWidth
Data type	float
Flags	expert

Reverse Indicator

Put the indicator triangle on the other side of the track.

Scripting name	reverseIndicatorLocation
Data type	boolean
Flags	expert

Antialias

Draw with antialias on? Makes text smoother.

Scripting name	antialias
Data type	boolean
Flags	expert

Styles

Contains the component's styles.

Scripting name	styles
Data type	Dataset
Flags	bindable \| expert

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Visible

If disabled, the component will be hidden.

Scripting name	visible
Data type	boolean
Flags	bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name	border
Data type	Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name	toolTipText
Data type	String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0	Default
1	Crosshair
2	Text
3	Wait
12	Hand
13	Move
4	SW Resize
5	SE Resize
6	NW Resize
7	NE Resize
8	N Resize
9	S Resize
10	W Resize
11	E Resize

Data

Range High

The overall high value for the display.

Scripting name	rangeHi
Data type	double
Flags	bindable

Range Low

The overall low value for the display.

Scripting name	rangeLo
Data type	double
Flags	bindable

Process Value

The current value of the process.

Scripting name	processValue
Data type	Double
Flags	bindable

Setpoint Value

The current value of the setpoint.

Scripting name	setpointValue
Data type	Double

High Interlock

The value above which an interlock will be activated

Scripting name	hiInterlock
Data type	Double
Flags	bindable

High High Alarm

The value above which is a high-high alarm.

Scripting name	hihiAlarm
Data type	Double
Flags	bindable

High Alarm

The value above which is a high alarm.

Scripting name	hiAlarm
Data type	Double
Flags	bindable

Desired High

The upper value of the desired operating range.

Scripting name	desiredHi
Data type	Double
Flags	bindable

Desired Low

The lower value of the desired operating range.

Scripting name	desiredLo
Data type	Double
Flags	bindable

Low Alarm

The value below which is a low alarm.

Scripting name	loAlarm
Data type	Double
Flags	bindable

Low Low Alarm

The value below which is a low-low alarm.

Scripting name	loloAlarm
Data type	Double
Flags	bindable

Low Interlock

The value below which an interlock will be activated.

Scripting name	loInterlock
Data type	Double
Flags	bindable

Hi Alarm Active

True when the process value is greater than the hi alarm threshold.

Scripting name	hiAlarmActive
Data type	boolean
Flags	bindable \| read-only

Hi-Hi Alarm Active

True when the process value is greater than the hi-hi alarm threshold.

Scripting name	hihiAlarmActive
Data type	boolean
Flags	bindable \| read-only

Hi Interlock Active

True when the process value is greater than the hi interlock threshold.

Scripting name	hiInterlockActive
Data type	boolean
Flags	bindable \| read-only

Lo Alarm Active

True when the process value is less than the lo alarm threshold.

Scripting name	loAlarmActive
Data type	boolean
Flags	bindable \| read-only

Lo-Lo Alarm Active

True when the process value is less than the lo-lo alarm threshold.

Scripting name	loloAlarmActive
Data type	boolean
Flags	bindable \| read-only

Lo Interlock Active

True when the process value is less than the lo interlock threshold.

Scripting name	loInterlockActive
Data type	boolean
Flags	bindable \| read-only

Data Quality

The data quality code for any tag bindings on this component.

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

The following event sets are fired by this component. See Component Event Handlers to learn more.