Indicator
Objects - Discrete
| The Object Palette features three types of
discrete indicators: |
 |
|
|
obj_ind_discrete |
This is an indicator
that allows you to set up to three comparison values ( valueLowAlert,
valueMediumAlert and valueHighAlert). When the value
equals one of the enabled comparisons, the color of the background and the
background image will change to the color and image specified for that
comparison. |
|
|
2 Alert State
Indicator |
This is
obj_ind_discrete configured to indicate two discrete alert states: valueHighAlert = 2 and
valueLowAlert = 1. The valueQualityEnabledFlag is selected with
valueQualityNoData = 1
and valueQualityLostData = 2. This object uses the image
property instead of background colors. The label is positioned to the
right of the indicator. |
|
|
Boolean Indicator |
This is
obj_ind_discrete configured to show one discrete alert state:
valueHighAlert = 0. The valueQualityEnabledFlag is selected with
valueQualityNoData = 1 and valueQualityLostData = 2. This object
uses the image property instead of background colors. The label
is shown to the right of the indicator. |
Using Interaction Properties
Commands
To assign a command to your indicator, right-click in the Property
Value field of the command property and select Define Command.
Commands can be set up to
execute when you click on an object or
automatically execute the command when the value of an object reaches a
specified threshold.
See Building
Displays>Define/Execute Command for information on how to set up
commands. Drill Down Displays
To specify a drill
down display, double click on the drillDownTarget property. Any display (.rt
v)
file can be targeted as a drill down. Once a drill down target has been set, double-click on the
indicator to activate the drill down. Drill down displays can
be activated in the same window that contains the indicator or open in a separate
window. This allows you to build a customizable hierarchy of displays.
Tool Tips
Select the mouseOverFlag
to enable tool tips for your indicator. To display a tool tip, point to the
indicator with
your mouse. The tool tip will contain information from your data attachment.
NOTE: The property iconVisFlag must be
selected in order to display tool tips.
Alert Properties
|
Property Name |
Description |
|
valueHighAlertEnabledFlag |
Select to enable
the valueHighAlert properties.
|
valueHighAlert |
Enter the value
that the value property must equal for the valueHighAlert
properties to be applied. This may be a number or text. |
|
valueHighAlertColor |
Select the 
button and choose a color from the palette to use for the background if value equals
valueHighAlert. |
|
valueHighAlertGradientColor2 |
Select the
button and choose a color from the palette to use for the second gradient
color of the background if value equals valueHighAlert. |
|
valueHighAlertImage |
Select the image
to display if value equals valueHighAlert. |
|
|
valueLowAlertEnabledFlag |
Select to enable
the valueLowAlert properties.
|
valueLowAlert |
Enter the value
that the value property must equal for the valueLowAlert properties
to be applied. This may be a number or text. |
|
valueLowAlertColor |
Select the
button and choose a color from the palette to use for the background if value equals
valueLowAlert. |
|
valueLowAlertGradientColor2 |
Select the
button and choose a color from the palette to use for the second gradient
color of the background if value equals valueLowAlert. |
|
valueLowAlertImage |
Select the image
to display if value equals valueLowAlert. |
|
|
valueMediumAlertEnabledFlag |
Select to enable
the valueMediumAlert properties.
|
valueMediumAlert |
Enter the value
that the value property must equal for the valueMediumAlert
properties to be applied. This may be a number or text. |
|
valueMediumAlertColor |
Select the
button and choose a color from the palette to use for the background if
value equals valueMediumAlert. |
|
valueMediumAlertGradientColor2 |
Select the
button and choose a color from the palette to use for the second gradient
color of the background if value equals valueMediumAlert. |
|
valueMediumAlertImage |
Select the image
to display if value equals valueMediumAlert. |
|
Background
Properties
|
Property Name |
Description |
|
bgBorderColor |
Select the
button and choose from the palette to set the color of the edge on the
background. This property is only applicable if bgBorderFlag is
selected. |
|
bgBorderFlag |
If selected, a
border is drawn around the background rectangle, |
|
bgColor |
Select the
button and choose from the palette to set the background color. |
|
bgEdgeWidth |
Set the width of
the 3D edge on the background rectangle. This property is only available if
the bgStyle selected is 3D Rectangle. |
|
bgGradientColor2 |
Select the
button and choose from the palette to set the second color in the gradient.
The bgColor property sets the first color in the gradient. NOTE: This
property will be ignored if bgGradientMode is set to None. |
|
bgGradientMode |
Display a gradient
in the background rectangle. Select from the following options:
|
|
None |
No
gradient |
|
|
Diagonal Edge |
Gradient is drawn at a 45 degree angle from the top left to the bottom
right corner of the object. |
|
|
Diagonal Center |
Gradient is drawn at a 45 degree angle from the center to the top left
and the bottom right corners of the object. |
|
|
Horizontal Edge |
Gradient is drawn horizontally from the top to the bottom of the object. |
|
|
Horizontal Center |
Gradient is drawn horizontally from the center to the top and bottom of
the object. |
|
|
Vertical Edge |
Gradient is drawn vertically from the left to the right of the object. |
|
|
Vertical Center |
Gradient is drawn vertically from the center to the left and right of
the object. |
|
|
bgRaisedFlag |
Re verses the
direction of the gradient, as well as that of the 3D edge if the bgStyle
selected is 3D Rectangle. |
|
bgRoundness
|
Set the arc length
of the rounded corners. This property is only available if the bgStyle
selected is Round Rectangle.
NOTE: The value of
bgRoundness cannot exceed half the value of the objWidth or the
objHeight. If bgRoundness does exceed that value, then half (of
the smaller of the two values) of objWidth or objHeight will
be used instead. For example if objWidth is 100 and objHeight
is 50, then the value of bgRoundness cannot exceed 25. If it does,
then half the value of objHeight (25) will be used instead. |
|
bgShadowFlag |
Select to display
a drop shadow on the background rectangle. |
|
bgStyle |
Choose one of the
following three options from the drop down menu:
|
Rectangle |
Select to display a background rectangle. |
|
3D Rectangle |
Select to display a 3D edge on the background rectangle. If selected,
use bgEdgeWidth to set the width of the 3D edge. |
|
Round Rectangle |
Select to display a background rectangle with rounded edges. If
selected, use bgRoundness to set the arc length of the rounded
corners. |
|
Circle |
Select to display a background circle. |
|
Diamond |
Select to display a background diamond. |
|
|
bgVisFlag |
Select to display
the background. |
Data Properties
|
Property Name |
Description |
|
value |
Attach your data.
This value is compared to the enabled alert comparisons. This can be a
number or a string. |
|
valueDivisor |
If specified and
the value is a number, this divisor is applied to the value. |
Data Format Properties
|
Property Name |
Description |
|
valueFormat |
Select or enter
the numeric format of value displayed in the value label. To enter a format,
use syntax from the Java DecimalFormat class. This is only used if value
is a number. |
|
valueTextColor |
Select the
button and choose from the palette to set the color of the value label. |
|
valueTextFont |
Select the font to
use for the value label. |
|
valueTextHeight |
Specify the height
for the value label. |
|
valueTextPosX |
Set x-axis
position of value label. Select from the following options:
-
Left
- Position outside the left side of the background.
-
Inside Left
- Position inside the left side of the background.
-
Center
- Position in the center of the background.
-
Inside Right
- Position inside the right side of the background.
-
Right
- Position outside the right side of the background.
|
|
valueTextPosY |
Set y-axis
position of value label. Select from the following options:
-
Outside Top -
Position well above the background.
-
Top -
Position just above the background.
-
Inside Top
- Position inside the top of the background.
-
Center
- Position in the center of the background.
-
Inside Bottom
- Position inside the bottom of the background.
-
Bottom
- Position just below the background.
-
Outside Bottom
- Position well below the background.
|
|
valueVisFlag |
Control visibility
of the value label and related properties. |
Image Properties
|
Property Name |
Description |
|
image |
Specify an image
to use in the background. This image will be used unless a comparison with
an image is active. In that case, the comparison's image will be used
instead. |
|
imageScaleFlag |
If selected, scale
the image to the size of the background. Otherwise, the image is drawn at
its original size. |
Interaction Properties
|
Property Name |
Description |
|
command |
Assign a command
to your indicator. See
Building
Displays>Define/Execute Command
for information. |
|
commandCloseWindowOnSuccess |
If selected, the
window that initiates a system command will automatically close when the
system command is executed successfully. This property only applies to
system commands.
With data source
commands, the window is closed whether or not the command is executed
successfully.
For multiple commands,
this property is applied to each command indi vidually. Therefore if the
first command in the multiple command sequence succeeds, the window will
close before the rest of the commands are executed.
NOTE: The
commandCloseWindowOnSuccess property is not supported in the Display
Server. |
|
commandConfirm |
If selected, the
command confirmation dialog is enabled. Use the commandConfirmText
property to write your own text for the confirmation dialog, otherwise text
from the command property will be used.
For multiple commands,
if you Confirm the execution then all individual commands will be executed
in sequence with no further confirmation. If the you Cancel the execution,
none of the commands in the sequence will executed.
|
|
commandConfirmText |
Enter command
confirmation text directly in the Property Value field or select the
button to open the Edit commandConfirmText dialog. If
commandConfirmText is not specified, then text from the command property
will be used. |
|
drillDownTarget |
Name of display (.rt
v)
file targeted as a drill down. See
Building Displays>Drill Down Displays for information.
NOTE: When
drillDownSelectMode is set to Anywhere double-clicking anywhere
on the scale will activate the specified drillDownTarget, however you
must double-click on a trace in the scale to set the substitutions listed
above. |
|
mouseOverText |
Enter a tool tip
for this indicator. To display the tool tip, move your mouse over the
object. To enter a multi-line tool tip, use \n to delimit the lines
(e.g. my\nscale). NOTE: The object must be visible (i.e. visFlag
property is selected), in order for the tool tip to be visible. |
Label Properties
|
Property Name |
Description |
|
label |
Edit label text
directly in the Property Value field or select the
button to open the Edit Label dialog. |
|
labelTextColor |
Select the
button and choose from the palette to set the color of the label text. |
|
labelTextFont |
Select the font
style of the label text from drop down menu. |
|
labelTextHeight |
Set the height (in
pixels) of the label text. |
|
labelTextPosX |
Set x-axis
position of label text. Select from the following options:
-
Left
- Position outside the left side of the background rectangle.
-
Inside Left
- Position inside the left side of the background rectangle.
-
Center
- Position in the center of the background rectangle.
-
Inside Right
- Position inside the right side of the background rectangle.
-
Right
- Position outside the right side of the background rectangle.
|
|
labelTextPosY |
Set y-axis
position of label text. Select from the following options:
-
Outside Top -
Position well above the background rectangle.
-
Top -
Position just above the background rectangle.
-
Inside Top
- Position inside the top of the background rectangle.
-
Center
- Position in the center of the background rectangle.
-
Inside Bottom
- Position inside the bottom of the background rectangle.
-
Bottom
- Position just below the background rectangle.
-
Outside Bottom
- Position well below the background rectangle.
|
|
labelVisFlag |
Control visibility
of the label and related properties. |
Object Properties
|
Property Name |
Description |
|
anchor |
Specify where to
anchor an object in the display. NOTE: If an object has the dock
property set, the anchor property will be ignored.
The anchor
property is only applied when the dimensions of the display are modified,
either by editing
Background Properties or resizing the window in
Layout mode
Select None, or
one or more the following options:
|
None |
Object not anchored. This is the default. |
|
Top |
Anchor top of object at top of display. |
|
Left |
Anchor left side of object at left of display. |
|
Bottom |
Anchor bottom of object at bottom of display. |
|
Right |
Anchor right side of object at right of display. |
When a display is
resized, the number of pixels between an anchored object and the specified
location remain constant. If an object is anchored on opposite sides (i.e.
Top and Bottom or Left and Right), the object
will be stretched to fill the available space. |
|
dock |
Specify the
docking location of an object in the display.
Select from the
following options:
|
None |
Object is not docked. This is the default. |
|
Top |
Dock
object at top of display. |
|
Left |
Dock
object at left of display. |
|
Bottom |
Dock
object at bottom of display. |
|
Right |
Dock
object at right of display. |
|
Fill |
Dock
object in available space remaining in the display after all docked
objects are positioned. |
If the dimensions of the
display are modified, either by editing
Background Properties or resizing the window in
Layout mode, the properties (objX, objY, objWidth
and objHeight) of docked objects will automatically adapt to match
the new size of the display.
When multiple objects
are docked to the same side of the display, the first object is docked
against the side of the display, the next object is docked against the edge
of the first object, and so on.
When objects are docked
to multiple sides of the display, the order in which objects were added to
the display controls docking position. For example, let's say the first
object added to the display is docked at the Top and the second
object is docked at the Left. Consequently, the first object will
fill the entire width of the display and the second object will fill the
left side of the display from the bottom of the first object to the bottom
of the display.
Objects in a display
have the dock property set to Fill, are laid out across a grid in the
available space remaining after all docked objects are positioned. By
default, the grid has one row and as many columns as there are objects in
the display. You can modify the grid in the
Background Properties dialog.
Once an object is
docked, there are some limitations on how that object can be modified.
-
Docked objects cannot
be dragged or repositioned using objX and objY properties.
-
Docked objects cannot
be resized using the objWidth or objHeight properties. To
resize you must drag on the resize handle.
-
Docked objects can
only be resized toward the center of the display (e.g. If an object is
docked at the Top, only its height can be increased by dragging
down toward the center of the display).
-
Docked objects set to
Fill cannot be resized at all.
-
Docked objects cannot
be moved using Align. Non-docked objects can be aligned against a
docked object, but a docked object will not move to align against another
object.
-
Docked objects are
ignored by Distribute.
|
|
objHeight |
Set height of the
object in pixels. |
|
objName |
Name given to
facilitate object management via the Object List dialog. Select
Tools>Object List. |
|
objWidth |
Set width of the
object in pixels. |
|
objX |
Set the x position
of the object. |
|
objY |
Set the y position
of the object. |
|
styleClass |
Enter the style class name for this object
as defined in your style sheet.
If not specified, the object class name is used. NOTE: The value entered
must not contain spaces and cannot start with rtv-. |
|
transparencyPercent |
Set transparency
of the object. Enter a value between 0 and 100. A value of 0, the default,
sets the object to be completely opaque. A value of 100 will render the
object completely transparent. |
|
visFlag |
Control visibility
of the object. |
Value Quality Properties
|
Property Name |
Description |
|
valueQualityEnabledFlag |
Select to enable
the valueQuality properties:
|
valueQuality |
Attach this value
to data that indicates the quality of the data attached to value.
This value must be a number. |
|
valueQualityLostData |
Enter a number
that valueQuality will equal if the data has been lost. |
|
valueQualityLostDataColor |
Select the
button and choose a color from the palette to use for the background if valueQuality equals
valueQualityLostData. |
|
valueQualityLostDataGradientColor2 |
Select the
button and choose a color from the palette to use for the second color of
the background gradient if valueQuality equals valueQualityLostData. |
|
valueQualityLostDataImage |
Select the image
to display if valueQuality equals valueQualityLostData. |
|
valueQualityNoData |
Enter a number
that valueQuality will equal if no data is available. |
|
valueQualityNoDataColor |
Select the
button and choose a color from the palette to use for the background if valueQuality equals
valueQualityLostData. |
|
valueQualityNoDataGradientColor2 |
Select the
button and choose a color from the palette to use for the second color of
the background gradient if valueQuality equals valueQualityNoData. |
|
valueQualityNoDataImage |
Select the image
to display if valueQuality equals valueQualityLostData. |
|
|
