XY
Graphs
XY graphs (obj_xygraph)
are useful for comparing pairs of values from a tabular data element returned
by your data attachment. XY graphs plot quantitative data on both axes.
Using Data and Data Label Properties
To attach data to your graph, right-click in
the Property Value field of the valueTable
property and select Attach to Data.
Your data attachment must contain numeric data for both the x and y axes. If you
include a label column in your data attachment, this can be used to label the
legend depending on whether the
rowSeriesFlag
checkbox is selected or deselected.
The
rowSeriesFlag controls how data populate the graph:
|
If the
rowSeriesFlag checkbox is selected, your first row of data is used for
the x-axis. The remainder will be plotted on the y-axis, with one trace per row
of data containing one point for each column.
If you included a label column in your
data attachment, select rowLabelVisFlag and values from that column will
be used as legend labels. By default, the label column is the first non-numeric
text column in your data. To set the label column to a specific column, specify
a column name using the
labelColumnName
property.
If your data attachment does not have a
label column, select the rowNameVisFlag checkbox to use row names in the
legend. |
|
If the
rowSeriesFlag checkbox is not selected, your first column of data
is used for the x-axis. The remainder will be plotted on the y-axis, with one
trace per column of data containing one point per row.
If you included a label column in your data
attachment, select rowLabelVisFlag and values from that column will be
used as x-axis labels. Column names will appear in the legend. |
Using Interaction Properties
Commands
To assign a command to your graph, 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 (.rtv) file can be targeted as a drill down. Based on
your data attachment, substitutions are
created that will be passed into drill down displays. To customize which
substitutions will be passed into drill down displays, double-click
on drillDownColumnSubs in the
Object Properties window to open the Drill Down Column Substitutions dialog.
Once a drill down target has been set, double-click on the trace
marker to activate the drill down. Drill down displays can
be activated in the same window that contains the graph or open in a separate
window. This allows you to build a customizable hierarchy of displays.
Use drillDownSelectMode to control
how a drill down display is activated. Set to Anywhere to activate
a drill down display by double-clicking anywhere on the graph. Set to Element
Only to enable a drill down display only when you double-click on a
marker in the graph.
Tool Tips
Select the mouseOverFlag
to enable tool tips for your XY graph. To display a tool tip, point to a trace marker with your mouse. The tool tip will contain
information from your data attachment about that trace marker.
Alert Properties
To set trace marker colors
and styles based on a threshold value, select the corresponding value alarm
or value warning flags.
Property
Name |
Description |
valueAlarmStatusTable |
Attach an alarm table containing
status indexes to valueAlarmStatusTable to enable rule based alarm
statuses for trace markers. The table attached to valueAlarmStatusTable
must have the same number of rows and columns as valueTable.
For each data element in valueTable, the status index at
the corresponding position in valueAlarmStatusTable is used to set
the alarm status of the marker.
Valid indexes are: 0 = use
normal marker color and style, 1 = use low alarm marker color and style,
2 = use low warning marker color and style, 3 = use high warning marker
color and style, 4 = use high alarm marker color and style, -1 = determine
marker color and style by comparing the value to the enabled alarm thresholds.
If no data is attached to
valueAlarmStatusTable,
the alarm status for a trace marker is determined by comparing the marker's
value to the enabled thresholds. |
valueHighAlarmEnabledFlag |
Select to enable the high
alarm threshold. |
valueHighAlarmLineVisFlag |
Select to display a dotted
line at the high alarm threshold. The color of the line is set to the valueHighAlarmMarkColor. |
valueHighAlarmMarkColor/
valueHighAlarmMarkStyle |
When a trace marker's value
is greater than or equal to the valueHighAlarm property, the marker
will change to the valueHighAlarmMarkColor and valueHighAlarmMarkStyle. |
valueHighAlarmTraceColor/
valueHighAlarmTraceStyle |
When
the value of any segment of a trace line is greater than or equal to the
valueHighAlarm
property, that segment of the trace line will change to the valueHighAlarmTraceColor
and
valueHighAlarmTraceStyle.
NOTE: If valueHighAlarmTraceStyle
is set to No Line, then valueHighAlarmTraceColor
will
not change. |
valueHighWarningEnabledFlag |
Select to enable the high
warning threshold. |
valueHighWarningLineVisFlag |
Select to display a dotted
line at the high warning threshold. The color of the line is set to the
valueHighWarningMarkColor. |
valueHighWarningMarkColor/
valueHighWarningMarkStyle |
When a trace marker's value
is greater than or equal to the valueHighWarning property but less
than the valueHighAlarm property, the marker will change to the
valueHighWarningMarkColor
and valueHighWarningMarkStyle. |
valueHighWarningTraceColor/
valueHighWarningTraceStyle |
When
the value of any segment of a trace line is greater than or equal to the
valueHighWarning
property but less than the valueHighAlarm property, that segment
of the trace line will change to the valueHighWarningTraceColor
and valueHighWarningTraceStyle. |
valueLowAlarmEnabledFlag |
Select to enable the low
alarm threshold. |
valueLowAlarmLineVisFlag |
Select to display a dotted
line at the low alarm threshold. The color of the line is set to the valueLowAlarmMarkColor. |
valueLowAlarmMarkColor/
valueLowAlarmMarkStyle |
When the trace marker's
value is less than or equal to the valueLowAlarm property, the marker
will change to the valueLowAlarmMarkColor and valueLowAlarmMarkStyle. |
valueLowAlarmTraceColor/
valueLowAlarmTraceStyle |
When
the value of any segment of a trace line is less than or equal to the valueLowAlarm
property, that segment of the trace line will change to the valueLowAlarmTraceColor
and
valueLowAlarmTraceStyle. |
valueLowWarningEnabledFlag |
Select to enable the low
warning threshold. |
valueLowWarningLineVisFlag |
Select to display a dotted
line at the low warning threshold. The color of the line is set to the
valueLowWarningMarkColor. |
valueLowWarningMarkColor/
valueLowWarningMarkStyle |
When the trace marker's
value is less than or equal to the valueLowWarning property, but
greater than the valueLowAlarm property, the marker will change
to the valueLowWarningMarkColor and valueLowWarningMarkStyle. |
valueLowWarningTraceColor/
valueLowWarningTraceStyle |
When
the value of any segment of a trace line is less than or equal to the valueLowWarning
property, but greater than the
valueLowAlarm property, that segment
of the trace line will change to the valueLowWarningTraceColor and
valueLowWarningTraceStyle. |
Background Properties
Specify how the background
is displayed in your XY graph.
Column Properties
Specify which columns are
displayed in your XY graph.
Property
Name |
Description |
columnsToHide |
Specify columns from the
data attachment to exclude from being used for plotted data or labels.
Data from the labelColumnName column will be used for labels even
if that column name is also specified in the columnsToHide property.
Columns specified in the columnsToHide property can still be used
in the drillDownColumnSubs property. |
Data Properties
Property
Name |
Description |
rowSeriesFlag |
Controls how data populate the graph:
If the
rowSeriesFlag checkbox is selected, your first row of data is used for
the x-axis. The remainder will be plotted on the y-axis, with one trace per row
of data containing one point for each column.
If you included a label column in your data
attachment, select rowLabelVisFlag and values from that column will be
used as legend labels. By default, the label column is the first non-numeric
text column in your data. To set the label column to a specific column, specify
a column name using the
labelColumnName
property.
If your data attachment does not have a label
column, select the rowNameVisFlag checkbox to use row names in the
legend. |
If the
rowSeriesFlag checkbox is not selected, your first column of data
is used for the x-axis. The remainder will be plotted on the y-axis, with one
trace per column of data containing one point per row.
If you included a label column in your data
attachment, select rowLabelVisFlag and values from that column will be
used as x-axis labels. Column names will appear in the legend. |
|
valueTable |
Attach your tabular data.
Your data attachment must contain numeric
data for both the x and y axes. If you include a label column in your data
attachment, this can be used to label the legend depending on whether
rowSeriesFlag
is selected or deselected. |
xValueDivisor |
The x-axis values are divided
by the value entered. |
xValueMin |
The xValueMin and
xValueMax properties control the range of x-axis if the xAxisAutoScaleMode
is set to Off. Select On for the xAxisAutoScaleMode
to
calculate x-axis range according to data values being plotted. To calculate
the x-axis range including xValueMin and xValueMax, select
On
- Include Min/Max. |
xValueMax |
yValueDivisor |
The y-axis values are divided by the value
entered. |
yValueMin |
The yValueMin and
yValueMax
properties control the range of y-axis if the yAxisAutoScaleMode
is set to Off. Select On for the yAxisAutoScaleMode
to
calculate y-axis range according to data values being plotted. To calculate
the y-axis range including yValueMin and yValueMax, select
On
- Include Min/Max. |
yValueMax |
Data Format Properties
Property
Name |
Description |
labelColumnFormat |
Select or enter the format
of numeric or date labels displayed in the legend and popup legend.
To enter a format, use syntax
from the Java DecimalFormat class
for numeric labels and syntax from
the Java SimpleDateFormat class for date
labels. |
xValueFormat |
Select or enter the numeric
format of trace values displayed in the legend and popup legend.
To enter a format, use syntax
from the Java DecimalFormat class. |
yValueFormat |
Data Label Properties
Property
Name |
Description |
columnDisplayNames |
Set alternate display names
for column names in your XY graph's data. Column names are displayed either
along the x-axis or in the legend, depending on whether or not the rowSeriesFlag
is selected. |
labelColumnName |
Specify a column in your data attachment to be
the label column. If left blank, the first non-numeric text column in your data
will be used. NOTE: If you include a
label column in your data attachment, this can be used to label the x-axis or
the legend depending on whether rowSeriesFlag
is selected or deselected. |
Historian Properties
Property
Name |
Description |
historyTableName |
Specify
name of table in your history database in which to store tabular data.
See
Configuring the Historian for information. |
historyTableRowNameFlag |
If
selected, data from the row name field will be stored in the first column of the
table specified in historyTableName. |
Interaction Properties
Property
Name |
Description |
command |
Assign a command to
your graph. 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 individually. 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. |
cursorColor |
Select the
button and choose a color from the palette. The
default is yellow. NOTE: This property is only
available if cursorFlag
is selected, |
cursorFlag |
Select to enable the cursor.
When the cursor is enabled, point to a location on
a trace to see a cursor line at that location and display the time and
values of all traces at the cursor line on the legend. Hold down the Control key
to snap the cursor to the closest data point.
Select the legendPopupFlag
to display the legend along the cursor. |
drillDownColumnSubs |
Select the
button to open the Drill Down
Column Substitutions dialog to customize which substitutions will be passed into
drill down displays. |
drillDownSelectMode |
Control how a drill
down display is activated. Select one of the following options:
Anywhere - Activate a drill down
display by double-clicking anywhere on the graph.
Element
Only - Enable a drill down display only when you double-click on a
trace marker in the graph.
|
drillDownTarget |
Name of display (.rtv)
file targeted as a drill down. See Building
Displays>Drill Down Displays for information. |
legendPopupFlag |
Select to display the legend along the cursor.
NOTE: This property is only
available if
cursorFlag is selected, |
mouseOverFlag |
Select to enable tool tips
for your graph. To display a tool tip, point to a trace
marker with your mouse. The tool tip will contain information from your
data attachment about that trace marker. |
outlineColor |
Select the
button and choose a color from the palette to set the color of the
one-pixel outline around the legend area, around
each color swatch within the legend, and around the plot area. The default value
is black (color 7). |
scrollbarMode |
Set whether and when the scroll bar
appears in the graph. There are three options:
Never - This is the default.
Always - Displays a scroll
bar at all times.
As Needed - Displays the scroll
bar when necessitated by zooming in the trace area, or when you have x or y
values that are outside of the the min/max range. |
scrollbarSize |
Specify (in pixels) the height of the
horizontal scroll bar and the width of the vertical scroll bar. The default value is -1, which sets the size to the system default. |
zoomEnabledFlag |
Select to enable zooming
within the graph. Click in the graph's trace area and drag the cursor until
a desired range is selected. While dragging, a yellow rectangle is drawn to show
the zoom area. After the zoom is performed, the graph stores up to four zoom
operations in queue. To zoom out, hold the Shift key and click in the graph's
trace area. |
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. |
labelMinTabWidth |
Specify minimum width of the label tab.
This property is only applies if labelTextAlignY is
set to TabTop. |
labelTextAlignX |
Select x-axis position of label text from the
drop down menu. |
labelTextAlignY |
Select y-axis position of label text from the
drop down menu.
Outside Top
|
Position label well above the background rectangle. |
Top
|
Position label just above the background rectangle. |
Title Top |
Position label along the top line of the background rectangle. |
Tab Top |
Position label tab just above the background rectangle. Height and width of
the tab is dependent on the height and width of the text. Use the
labelMinTabWidth property to specify a minimum tab width. |
Inside Top |
Position label inside the top of the background rectangle. |
|
labelTextColor |
Select the
button and choose a color from the palette to set the label text color. |
labelTextFont |
Select font style of label text from the drop
down menu. |
labelTextHeight |
Set the height of the label text in pixels. |
Legend Properties
Property
Name |
Description |
legendBgColor |
Select the
button and choose a color from the palette to set the background color
of the legend. |
legendBgGradientColor2 |
Select the
button and choose a color for the second
color in the gradient. Default is white. NOTE: The legendBgColor property sets
the first color in the gradient. |
legendBgGradientMode |
Display a gradient
in the legend background. 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. |
|
legendValueMinSpace |
Specify the minimum distance
between values and labels in the legend. |
legendVisFlag |
Select to display the legend. |
legendValueVisFlag |
Select to display the numerical
values of your data in the legend. |
legendWidthPercent |
Set the percent of the total
width of the object used for the legend. |
Marker Properties
Property
Name |
Description |
markDefaultSize |
Specify (in pixels) the size of the
markers. |
markScaleMode |
Scale markers according to the order of the data in your data attachment
(i.e. The marker for the first data in the attachment is the smallest and
the marker for the last data is the largest.)
Select from the following options: No Scale, Scale
by Trace, Scale Within Trace. |
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 |
Plot x-axis position of object. |
objY |
Plot y-axis position of 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. |
Plot Area Properties
Property
Name |
Description |
gridBgColor |
Select the
button and choose a color from the palette to set the color of the grid
background. |
gridBgGradientColor2 |
Select the
button and choose a color for the second
color in the gradient. Default is white. NOTE: The gridBgColor property sets
the first color in the gradient. |
gridBgGradientMode |
Display a gradient
in the grid background. 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. |
|
gridBgImage |
Select an image to display
in the grid background of your graph. NOTE: If necessary, the image will
be stretched to fit the grid. |
gridColor |
Select the
button and choose from the palette to set the color of the grid lines.
Default is white. |
Trace Properties
Property
Name |
Description |
traceFillStyle |
Specify the style to
fill the area under the trace. Select from the following options: Solid, Transparent, Gradient, or Transparent Gradient
to Default is
None. |
traceProperties |
Specify the line color,
line style, line width, marker color, marker style and fill style of all
traces. |
X-Axis Properties
Specify how the x axis is
displayed on your XY graph.
Property
Name |
Description |
xAxisAutoScaleMode |
The xValueMin and
xValueMax
properties control the range of x-axis if the xAxisAutoScaleMode
is set to Off. Select On for the xAxisAutoScaleMode
to calculate x-axis range according to data values being plotted. To calculate
the x-axis range including xValueMin and xValueMax, select
On
- Include Min/Max. |
xAxisAutoScaleRoundFlag |
Select the xAxisAutoScaleRoundFlag
to round values on the x-axis. |
xAxisFlag |
Select to display the x-axis. |
xAxisFormat |
Select
or enter the numeric format of values displayed on the x-axis. To enter
a format, use syntax from the Java DecimalFormat class. |
xAxisLabel |
Specify the x-axis label. |
xAxisLabelTextHeight |
Specify the height in pixels
of the x-axis labels. |
xAxisMajorDivisions |
Specify the number of major
divisions on the x-axis. |
xAxisMinorDivisions |
Specify the number of minor
divisions on the x- axis. |
xAxisReverseFlag |
Select to reverse the order of the
x-axis values and plot values decreasing from left to right. |
xValueSortFlag |
Select to sort data from
lowest to highest x values. |
Y-Axis Properties
Specify how the y axis is
displayed on your XY graph.
Property
Name |
Description |
yAxisAutoScaleMode |
The yValueMin and
yValueMax
properties control the range of y-axis if the yAxisAutoScaleMode
is set to Off. Select On for the yAxisAutoScaleMode
to
calculate y-axis range according to data values being plotted. To calculate
the y-axis range including yValueMin and yValueMax, select
On
- Include Min/Max. |
yAxisFlag |
Select to display the y-axis. |
yAxisFormat |
Select
or enter the numeric format of values displayed on the y-axis. To enter
a format, use syntax from the Java DecimalFormat class. |
yAxisLabel |
Specify the y-axis label. |
yAxisLabelTextHeight |
Specify the height in pixels
of the y-axis labels. |
yAxisMajorDivisions |
Specify the number of major
divisions on the y-axis. |
yAxisMinLabelWidth |
Specify the minimum width
in pixels for the y-axis labels. |
yAxisMinorDivisions |
Specify the number of minor
divisions on the y-axis. |
yAxisMultiRangeFlag |
Select to enable one axis
per trace with each trace having its own range. |
|