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.
Data and Data Label Properties
Attach your data to the valueTable
property. Your data attachment must contain numeric data for both the x
and y axes. If you include a text column in your data attachment for valueTable,
it can be used to label the legend if the rowSeriesFlag is selected.
The
rowSeriesFlag controls how x and y 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 your data attachment has a label
column and the rowLabelVisFlag is selected, data from this column
will be used for legend labels. If your data attachment does not have a
label column, select the rowNameVisFlag checkbox to use row names
in the legend. By default, the label column is the first non-numeric text
column in your data. Specify a column name in the labelColumnName
property to set the label column to a specific column. |
|
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. Column names will appear in the legend. |
The x values are divided
by the value entered into the xValueDivisor. The y values are divided
by the value entered into the yValueDivisor.
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. |
yValueMin
yValueMax |
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. |
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 Format Properties
Specify how markers are
displayed in your XY graph.
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/yValueFormat |
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. |
Trace Properties
Specify how traces are displayed
in your XY graph.
Property
Name |
Description |
traceFillStyle |
Set traceFillStyle
to Solid, Transparent, Gradient, or Transparent Gradient
to fill the area under the trace. The default traceFillStyle is
None. To disable this feature, reset to None. |
traceProperties |
Specify the line color,
line style, line width, marker color, marker style and fill style of all
traces. |
Marker Properties
Specify how markers are
displayed in your XY graph.
Property
Name |
Description |
markDefaultSize |
Set markDefaultSize
to specify the size of the markers in pixels. |
markScaleMode |
Set markScaleMode
to
scale markers according to the order of the data in your data attachment,
e.g., the marker for the first data in the attachment is the smallest and
the marker for the last data is the largest. Select one of the following
from the drop down menu to set the scale mode: No Scale, Scale
by Trace, Scale Within Trace. |
Background Properties
Specify how the background
is displayed in your XY graph.
Property
Name |
Description |
bg3dFlag |
Select to display a 3D edge on the
background rectangle. |
bgColor |
Select the
button and choose a color from the palette to set the background color. |
bgEdgeWidth |
Set the width of the 3D
edge on the background rectangle. This property is only used if the bg3dFlag
is selected. |
bgGradientFlag |
Select to display a gradient
in the background rectangle. |
bgVisFlag |
Select to display the background
rectangle. |
Legend Properties
Specify the way the legend
is displayed in your XY graph.
Property
Name |
Description |
legendBgColor |
Select the
button and choose a color from the palette to set the background color
of the legend. |
legendBgGradientFlag |
Select the legendBgGradientFlag
to display a gradient in the legend background. |
legendPopupFlag |
Select to display the legend
along the cursor. (Only enabled if cursorFlag is selected.) |
legendWidthPercent |
Set the percent of the total
width of the object used for the legend. |
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. |
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. |
Interaction Properties
Specify how you interact
with the data in your XY graph.
To specify a drill
down display, double click on the drillDownTarget Property
Name. 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 XY graph.
Property
Name |
Description |
cursorColor |
Select the
button and choose a color from the palette to set the color of the cursor. |
cursorFlag |
Select to enable the cursor.
When the cursor is enabled, select the graph and 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. |
mouseOverFlag |
Select to enable tooltips
for your graph. To display a tooltip, select the graph and point to a trace
marker with your mouse. The tooltip will contain information from your
data attachment about that trace marker. |
scrollbarMode |
Select Never, As Needed,
or Always from the scrollbarMode property to set the behavior
of the scroll bar in the table. Never is the default setting. Select
Always
to display a scroll bar at all times or As Needed to display 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 the height of the
horizontal scroll bar and the width of the vertical scroll bar, in pixels.
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 rectangle is drawn to show
the zoom area. The rectangle's default color is yellow (this can be changed
in the cursorColor property). After the zoom is performed, the graph
stores up to four zoom operations in queue. To zoom out, press the shift
key and click in the graph's trace area. |
Plot Area Properties
Property
Name |
Description |
gridBgGradientFlag |
Select to display a gradient
in the plot background. Set the color of the plot background with the gridBgColor
property. |
gridBgImage |
Select an image to display
in the plot background of your XY graph. If necessary the image will be
stretched to fit the plot area. |
X-Axis Properties
Specify how the x axis is
displayed on your XY graph.
Property
Name |
Description |
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. |
xAxisAutoScaleRoundFlag
xAxisAutoScaleMode
xValueMin
xValueMax |
Select the xAxisAutoScaleRoundFlag
to round values on the x-axis.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. |
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 |
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. |
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. |
|