Moving Analog Indicator
Component Palette Icon:
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.
|
Name |
Description |
Property Type |
Scripting |
Category |
|
Antialias |
Draw with antialias on? Makes text smoother |
boolean |
.antialias |
Appearance |
|
Border |
The border surrounding this component. NOTE that the border is unaffected by rotation. |
Border |
.border |
Common |
|
Cursor |
The mouse cursor to use when hovering over this component. |
int |
.cursorCode |
Common |
|
Data Quality |
The data quality code for any tag bindings on this component. |
int |
.dataQuality |
Data |
|
Desired High |
The upper value of the desired operating range. |
Double |
.desiredHi |
Data |
|
Desired Low |
The lower value of the desired operating range. |
Double |
.desiredLo |
Data |
|
Desired Range Color |
The color of the desired range. |
Color |
.desiredRangeColor |
Appearance |
|
Hi Alarm Active |
True when the process value is greater than the hi alarm threshold |
boolean |
.hiAlarmActive |
Data |
|
Hi Interlock Active |
True when the process value is greater than the hi interlock threshold |
boolean |
.hiInterlockActive |
Data |
|
Hi-Hi Alarm Active |
True when the process value is greater than the hi-hi alarm threshold |
boolean |
.hihiAlarmActive |
Data |
|
High Alarm |
The value above which is a high alarm. |
Double |
.hiAlarm |
Data |
|
High High Alarm |
The value above which is a high-high alarm. |
Double |
.hihiAlarm |
Data |
|
High Interlock |
The value above which an interlock will be activated |
Double |
.hiInterlock |
Data |
|
Inactive Alarm Color |
The color of inactive alarm range. |
Color |
.inactiveAlarmColor |
Appearance |
|
Interlock Color |
The color of the interlock range. |
Color |
.interlockColor |
Appearance |
|
Level 1 Alarm Color |
The color of an active level 1 alarm (Hi-Hi or Lo-Lo) |
Color |
.level1AlarmColor |
Appearance |
|
Level 2 Alarm Color |
The color of an active level 2 alarm (Hi or Lo). |
Color |
.level2AlarmColor |
Appearance |
|
Lo Alarm Active |
True when the process value is less than the lo alarm threshold |
boolean |
.loAlarmActive |
Data |
|
Lo Interlock Active |
True when the process value is less than the lo interlock threshold |
boolean |
.loInterlockActive |
Data |
|
Lo-Lo Alarm Active |
True when the process value is less than the lo-lo alarm threshold |
boolean |
.loloAlarmActive |
Data |
|
Low Alarm |
The value below which is a low alarm. |
Double |
.loAlarm |
Data |
|
Low Interlock |
The value below which an interlock will be activated. |
Double |
.loInterlock |
Data |
|
Low Low Alarm |
The value below which is a low-low alarm. |
Double |
.loloAlarm |
Data |
|
Mouseover Text |
The text that is displayed in the tooltip which pops up on mouseover of this component. |
String |
.toolTipText |
Common |
|
Name |
The name of this component. |
String |
.name |
Common |
|
Process Value |
The current value of the process. |
Double |
.processValue |
Data |
|
Range Fill |
The background color of the range strip. |
Color |
.rangeFill |
Appearance |
|
Range High |
The overall high value for the display. |
double |
.rangeHi |
Data |
|
Range Low |
The overall low value for the display. |
double |
.rangeLo |
Data |
|
Range Stroke |
The stroke color for the range strip. |
Color |
.rangeStroke |
Appearance |
|
Reverse Indicator |
Put the indicator triangle on the other side of the track. |
boolean |
.reverseIndicatorLocation |
Appearance |
|
Setpoint Fill |
The fill color of the setpoint indicator. |
Color |
.setpointFill |
Appearance |
|
Setpoint Stroke |
The stroke color of the setpoint indicator. |
Color |
.setpointStroke |
Appearance |
|
Setpoint Value |
The current value of the setpoint. |
Double |
.setpointValue |
Data |
|
Show Value |
Show the current value above or beneath the value indicator. |
boolean |
.showValue |
Appearance |
|
Stroke Width |
The stroke width for lines drawn. |
float |
.strokeWidth |
Appearance |
|
Styles |
Contains the component's styles |
Dataset |
.styles |
Appearance |
|
Value Font |
The font for the value label. |
Font |
.font |
Appearance |
|
Value Format |
The string format for the value, if it is shown. |
String |
.valueFormat |
Appearance |
|
Value Indicator Fill |
The fill color of the value indicator. |
Color |
.valueFill |
Appearance |
|
Value Indicator Stroke |
The stroke color of the value indicator. |
Color |
.valueStroke |
Appearance |
|
Visible |
If disabled, the component will be hidden. |
boolean |
.visible |
Common |
This component does not have scripting functions associated with it.
This component does not have extension functions associated with it.
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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns 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. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (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.
|
.source |
The component that fired this event |
|
.newValue |
The new value that this property changed to. |
|
.oldValue |
The value that this property was before it changed. Note that not all components include an accurate oldValue in their events. |
|
.propertyName |
The 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. |
|
Property Name |
Value |
|
None |
n/a |
|
Property Name |
Value |
|
Show Value |
True |
|
Reverse Indicator |
True |
|
Stroke Width |
0.0 |