Fx Trend
Graph
The Fx
trend graph (obj_Fxtrend) is generally used for tracing two types of data
in one graph: real-time, or live data, and archived data.
Displaying these two types of traces in conjunction is useful for comparing data
trends. The
Fx trend graph supports up to eight traces, set the traceCount
to control the number of traces.
Using Trace* Properties
The Display Builder automatically creates a
set of trace* properties
according to the number you specify using the
traceCount object property.
Attach your data to
trace*Value
or trace*ValueTable, where * is the trace number. For
example if you set the traceCount to three (3), you will have three traces in your graph
(Trace01, Trace02 and Trace03) and a corresponding trace*Value
(trace1Value, trace2Value and trace3Value) for each.
Historical vs. Current Data
All traces in the Fx trend graph have the option
to display historical and/or current data. To
display historical data, attach to
trace*ValueTable where * is the trace number. Include two columns in your attachment. (See the Attach to Data section
specific to your data source for details on how to use the Select Columns
dialog.) The first column must be the time value and the second column the value
to plot. Supported formats for the time value column are: mm/dd/yyyy hh:mm:ss
(e.g., 01/16/2004 12:30:03), yyyy-mm-dd hh:mm:ss (e.g., 2004-01-16
12:30:03), and the number of milliseconds since midnight, January 1, 1970 UTC. In order to view all available data, you must set the properties
timeRange to -1 and timeShift to a
negative value. This negative value will be used to round the start and end times for the
y-axis. For
example, if you specify -15 for the timeShift property, the start and end times for the
y-axis will be
rounded to the nearest 15 seconds.
To display current data, attach to trace*Value
where * is the trace number. When you attach data to the trace*Value property,
the time displayed on the Fx trend graph is automatically updated each time data is
received. The table in your data attachment can contain either a single point of
data or two columns of data. If it contains a single point of data, Enterprise
RTView assigns the time stamp when the graph receives the data. If it contains
two columns of data, the first column must be the time value and the second
column the value to plot. Supported formats for the time value column are: mm/dd/yyyy
hh:mm:ss (e.g., 01/16/2004 12:30:03), yyyy-mm-dd hh:mm:ss (e.g.,
2004-01-16 12:30:03), and the number of milliseconds since midnight, January 1,
1970 UTC. In order to view all available data, you must set the properties timeRange to
-1 and
timeShift to a
negative value. This negative value will be used to round the start and end times for the
y-axis. For
example, if you specify -15 for the timeShift property, the start and end times for the
y-axis will be
rounded to the nearest 15 seconds.
All trace values are divided by
the number entered into the trace*ValueDivisor.
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 |
| valueHighAlarmEnabledFlag |
Select to enable the high
alarm threshold and the following related properties:
| valueHighAlarm |
Set the value of 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. If set to
Default, the corresponding AlarmTraceColor and AlarmTraceStyle will be used. |
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.
If set to Default, the corresponding trace*LineColor and trace*LineStyle will be used. |
|
| valueHighWarningEnabledFlag |
Select to enable
the high warning threshold and the following related properties:
| valueHighWarning |
Set the value of 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. If set to Default, the corresponding
WarningTraceColor and WarningTraceStyle will be used. |
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. If set
to Default, the corresponding trace*LineColor and trace*LineStyle will be used. |
|
| valueLowAlarmEnabledFlag |
Select to enable the low
alarm threshold and the following related properties:
| valueLowAlarm |
Set the value of 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. If set to
Default, the corresponding AlarmTraceColor and AlarmTraceStyle will be used. |
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.
If set to Default, the corresponding trace*LineColor and trace*LineStyle will be used. |
|
| valueLowWarningEnabledFlag |
Select to enable
the low warning threshold and the following related properties:
| valueLowWarning |
Set the value of 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 or valueLowWarningMarkStyle. If set to Default, the
corresponding WarningTraceColor or WarningTraceStyle will be used. |
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. If set to
Default, the corresponding trace*LineColor and trace*LineStyle will be used. |
|
Background Properties
Specify how the background
is displayed in your 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. The
Default color is grey. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. |
| bgGradientFlag |
Select to display a gradient
in the background rectangle. |
Data Properties
Specify how data is displayed
in your graph.
| Property
Name |
Description |
| maxPointsPerTrace |
The default is set to 1000.
The maximum value for this property is 30000. |
yValueMax
yValueMin |
The yValueMin and
yValueMax
properties control the range of the y-axis for this trace if the yAxisAutoScaleMode
is set to Off. Select On for the yAxisAutoScaleMode
to
calculate y-axis range according to data values being plotted. |
Interaction Properties
Specify how you interact
with the data in your graph. See the
Additional Interactivity section for more information on how to interact with this graph
at runtime.
| Property
Name |
Description |
| command |
Assign a command to
your trend 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 to set the color of the cursor. The
Default color is black. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. |
| 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. |
| drillDownTarget |
Name of display (.rtv)
file targeted as a drill down. See Building
Displays>Drill Down Displays for information. |
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. |
| labelTextAlignX |
Select x-axis position of label text from the
drop down menu. |
| labelTextColor |
Select the
button and choose a color from the palette to set the label text color. NOTE: Color properties
are treated differently on Fx graphs than on other objects, see the Fx
Graph Colors section for more information. |
| labelTextFont |
Select font style of label text from the drop
down menu. |
| labelTextSize |
Set the size of the label text in pixels. |
Legend Properties
Specify the way the legend
is displayed in your graph. Click and press a trace's entry in the
legend to temporarily hide all other traces in the graph.
| Property
Name |
Description |
| legendBgColor |
Select the
button and choose a color from the palette to set the background color
of the legend. The Default color is grey. Color
properties are treated differently on Fx trend graph than on other objects,
see the Fx Graph Colors section below
for more information. |
| legendBgGradientFlag |
Select the legendBgGradientFlag
to display a gradient in the legend background. |
| legendPosition |
Select Top, Bottom, Left or Right to position
the legend relative to the plot area. |
| legendTextFont |
Set the font to use for the legend text. NOTE:
Bold fonts are not supported. |
| legendTextSize |
Set the font size for the legend text. |
| legendVisFlag |
Select to display the legend. |
| legendWidthPercent |
Set the percent of the total
width of the object used for the legend. NOTE: If the legend is positioned
at the top or bottom, this will be a percentage of the height instead. |
Marker Properties
Specify the way markers
are displayed in your trend graph.
| Property
Name |
Description |
| markDefaultSize |
Set markDefaultSize
to specify the size of the markers in pixels. |
Object Properties
| Property
Name |
Description |
| 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. |
| visFlag |
Control visibility of the object. |
Plot Area Properties
Specify the way the plot
area is displayed in your graph.
| Property
Name |
Description |
| traceBgColor |
Select the
button and choose a color from the palette to set the background color
of your graph. The Default color is grey. Color
properties are treated differently on Fx trend graph than on other objects,
see the Fx Graph Colors section below
for more information. |
| traceBgGradientFlag |
Select to display
a gradient in the plot background. Set the color of the plot background
with the traceBgColor property. |
Trace Properties
Specify how traces are displayed
in your graph.
| Property
Name |
Description |
| traceCount |
Specify the number of traces
in your graph. The maximum is eight. Enterprise RTView automatically creates
a set of properties for each trace in the Object Properties window. |
Trace* Properties
The Display Builder automatically creates a
set of trace* properties
(where * is the trace number) according to the number
of traces specified in the
traceCount property.
Attach your data to
trace*Value
or trace*ValueTable.
| Property
Name |
Description |
| trace*Label |
Set a label for your trace. |
| trace*LineColor |
Select the
button and choose a color from the palette to set the trace line color. The
Default color is yellow. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. |
| trace*LineShadowFlag |
Select to show a shadow for this trace. |
| trace*LineStyle |
Select the style of the
line used to display the trace from the drop down menu:
No Line, Solid, Dotted,
Dashed or Dot
Dashed. |
| trace*LineThickness |
Select the thickness of
the line used to display the trace from the drop down menu: Thin, Medium
or Thick.
|
| trace*MarkColor |
Select the
button and choose a color from the palette to set the trace marker color. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. |
| trace*MarkStyle |
Select the style
of the marker used on the trace from the drop down menu:
No Marker, Dot, +,
*, o, x, Filled Circle, Filled Diamond,
Filled Triangle, Filled Square or Filled Star. |
| trace*Value |
To display current data, attach to
trace*Value. |
| trace*ValueDivisor |
Enter a number. All traces will be divided by
this value. |
|
trace*ValueTable |
To
display historical data, attach to
trace*ValueTable. NOTE:
Include two columns in your attachment. |
X-Axis Properties
Specify the way the x-axis
is displayed in your graph. The whole time range included in your data will be
plotted on the graph. Set the timeRange property to control the visible
plot area. If the time range in the data in greater than the specified timeRange,
a horizontal scrollbar will appear.
| Property
Name |
Description |
| timeFormat |
Set the format
for the time displayed in the x-axis using the following format characters:
y (year),
M (month),
d (day of month),
E (weekday),
a (am/pm marker),
H (hour 0-23 in day),
K (hour 0-11 in am/pm),
m (minute),
s (second).
NOTE: These format characters are not
supported by Fx trend graph: G, w, W, D, S, z, Z.
For example, MMMM dd,
yyyy KK:mm:ss a would result in the form August 30, 2003 05:32:12
PM. If no format is given, the date and time will not be displayed
on the x-axis. Include a new line character ('\n')
to display multiple line text in the time axis labels.
For example, MM\dd'\n'hh:mm:ss would
result in the form 08\30 05:32:12. |
| timeRange |
Control the total amount
of time, in seconds, plotted on the graph. If you attach data to trace*ValueTable,
set timeRange to
-1so the time range of the graph is driven
by the time range in the data attachment. NOTE: If the data exceeds the visible
time range, a scrollbar will appear. |
| timeShift |
Control the amount of time, in seconds, the graph will shift to the left when the trace has filled the graph and controls the rounding of the start and end times. For example, if the
timeShift is 15, the start and end times on the graph will be rounded to the nearest 15 second interval. By default, the end of the plot area corresponds with the current time. To only shift the graph when new data is received, set
timeShift to a negative value and the end of the graph will display the most current data plotted. If you attach data to
trace*ValueTable, you must set timeShift to a negative value. NOTE:
The timeShift property is ignored if either timeRangeBegin or timeRangeEnd is set. |
| xAxisFlag |
Select to display the x-axis. |
| xAxisMajorDivisions |
Specify the number of major
divisions on the x-axis. |
Y-Axis Properties
Specify the way the y axis
is displayed in your graph. Unlike the standard trend graph, the Fx trend graph
does not support properties for yAxisMin, yAxisMax, yAxisAutoScaleMode,
timeRangeBegin, or timeRangeEnd. Only a single, auto-scaled y-axis is supported.
| Property
Name |
Description |
| yAxisAutoScaleMode |
The yValueMin and
yValueMax
properties control the range of the y-axis for this trace if the yAxisAutoScaleMode
is set to Off. Select On for the yAxisAutoScaleMode
to
calculate y-axis range according to data values being plotted. NOTE: yAxisAutoScaleMode
is ignored if the yAxisLogFlag is selected. |
| yAxisFlag |
Select to display the y-axis. |
| yAxisLabel |
Set a label for the y-axis. |
| yAxisLogFlag |
Select to enable the logarithmic (base 10)
y-axis. NOTE: Negative data points will not be plotted. |
| yAxisMajorDivisions |
Specify the number of major divisions on the
y-axis. |
| yAxisMinorDivisions |
Specify the number of minor divisions on the
y-axis. |
Fx Graph Colors
Color properties are treated differently
on Fx graphs than on other objects. In the Display Builder, the Fx graphs color
chooser dialog has five tabs:
| |
Standard Colors |
Traditional palette of 252 indexed colors |
| |
Custom Colors |
To define custom colors, select
Tools>Options and click on the Custom Colors tab. |
| |
Swatches |
Standard Java color palette |
| |
HSB |
Color selection by hue, saturation, and
brightness |
| |
RGB |
Color selection by red, green, and blue
intensity |
The color chooser also has a button for selecting a
properties Default color, which is described separately for each color property
above.
Internally, all color properties on Fx graphs are stored as a 24-bit integer RGB
value in the range of zero (black) to 16,777,215 (white). Therefore if a color
property on an Fx graph is attached to data, you must provide an integer value in that
range (not a color index between 0 and 252 as with other objects). A value of -1
indicates the default property color.
Note that the Default color and colors selected from the
Swatches, HSB, and RGB
tabs are only supported on Fx graphs. If a color is selected from one of those
tabs and then copied and pasted to a color property on any other object, white
will be used instead.
Thin Client Deployment - Additional
Interactivity
The
following additional interactivity
is supported in a Thin Client deployment:
Zoom
- Zoom-in by dragging in trace area, zoom-out
by Shift+Click. NOTE: Zooming out is not enabled in the main window of the
Display Builder.
Scrolling
- Live scrolling through time range
Cursor
- Slide horizontally to see interpolated data
values in legend
Data Tips
- Text boxes with data info popup when the
mouse is over a data point.
Legend
- Position above, below,
right, or left of trace area
- Resize interactively
- Click on trace entry in the legend to toggle the visibility of
that trace in the display.
|
