Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:


 


IULocgo


Moving Analog Indicator


 

Description

The Moving Analog Indicator is another component that fits well with the High Performance HMI techniques and practices. This component displays an analog value in context with other information about that value so that you can visually quickly see if the value is in the normal range or not. 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.


The Moving Analog Indicator 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 the Moving Analog Indicator 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.

Properties
NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
CursorThe mouse cursor to use when hovering over this component.int.cursorCodeCommon
Data QualityThe data quality code for any tag bindings on this component.int.dataQualityData
Desired HighThe upper value of the desired operating range.Double.desiredHiData
Desired LowThe lower value of the desired operating range.Double.desiredLoData
Desired Range ColorThe color of the desired range.Color.desiredRangeColorAppearance
Hi Alarm ActiveTrue when the process value is greater than the hi alarm threshold.boolean.hiAlarmActiveData
Hi Interlock ActiveTrue when the process value is greater than the hi interlock threshold.boolean.hiInterlockActiveData
Hi-Hi Alarm ActiveTrue when the process value is greater than the hi-hi alarm threshold.boolean.hihiAlarmActiveData
High AlarmThe value above which is a high alarm.Double.hiAlarmData
High High AlarmThe value above which is a high-high alarm.Double.hihiAlarmData
High InterlockThe value above which an interlock will be activated.Double.hiInterlockData
Inactive Alarm ColorThe color of inactive alarm range.Color.inactiveAlarmColorAppearance
Interlock ColorThe color of the interlock range.Color.interlockColorAppearance
Level 1 Alarm ColorThe color of an active level 1 alarm (Hi-Hi or Lo-Lo)Color.level1AlarmColorAppearance
Level 2 Alarm ColorThe color of an active level 2 alarm (Hi or Lo).Color.level2AlarmColorAppearance
Lo Alarm ActiveTrue when the process value is less than the lo alarm threshold.boolean.loAlarmActiveData
Lo Interlock ActiveTrue when the process value is less than the lo interlock threshold.boolean.loInterlockActiveData
Lo-Lo Alarm ActiveTrue when the process value is less than the lo-lo alarm threshold.boolean.loloAlarmActiveData
Low AlarmThe value below which is a low alarm.Double.loAlarmData
Low InterlockThe value below which an interlock will be activated.Double.loInterlockData
Low Low AlarmThe value below which is a low-low alarm.Double.loloAlarmData
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Process ValueThe current value of the process.Double.processValueData
Range FillThe background color of the range strip.Color.rangeFillAppearance
Range HighThe overall high value for the display.double.rangeHiData
Range LowThe overall low value for the display.double.rangeLoData
Range StrokeThe stroke color for the range strip.Color.rangeStrokeAppearance
Reverse IndicatorPut the indicator triangle on the other side of the track.boolean.reverseIndicatorLocationAppearance
Setpoint FillThe fill color of the setpoint indicator.Color.setpointFillAppearance
Setpoint StrokeThe stroke color of the setpoint indicator.Color.setpointStrokeAppearance
Setpoint ValueThe current value of the setpoint.Double.setpointValueData
Show ValueShow the current value above or beneath the value indicator.boolean.showValueAppearance
Stroke WidthThe stroke width for lines drawn.float.strokeWidthAppearance
StylesContains the component's stylesDataset.stylesAppearance
Value FontThe font for the value label.Font.fontAppearance
Value FormatThe string format for the value, if it is shown.String.valueFormatAppearance
Value Indicator FillThe fill color of the value indicator.Color.valueFillAppearance
Value Indicator StrokeThe stroke color of the value indicator.Color.valueStrokeAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers
 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseEntered

This event fires when the mouse enters the space over the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseExited

This event fires when the mouse leaves the space over the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mousePressed

This event fires when a mouse button is pressed down on the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.
Examples
Moving Analog Indicator Expanded Horizontally

Property NameValue
Nonen/a
Stylized Moving Analog Indicator

Property NameValue
Show ValueTrue
Reverse IndicatorTrue
Stroke Width0.0

 

 

  • No labels