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.
Trace Properties
Specify how traces are displayed
in your fx trend 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
Attach your data to
trace*Value
or trace*ValueTable, where * is the trace number. For
example, if the traceCount property equals three (3), this means there
are three traces in your graph: trace01, trace02 and trace03. Enterprise RTView
automatically creates a set of trace* properties for each trace. 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 YAxis 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 YAxis will be
rounded to the nearest 15 seconds.
All trace values are divided by
the number entered into the trace*ValueDivisor.
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*LineThickness |
Select the thickness of
the line used to display the trace from the drop down menu: Thin, Medium
or Thick.
|
trace*Value |
To display current data, attach to
trace*Value
where * is the trace number. |
trace*ValueDivisor |
Enter a number. All traces will be divided by
this value. |
trace*ValueTable |
To
display historical data, attach to
trace*ValueTable where * is the trace number. NOTE:
Include two columns in your attachment. |
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. |
yValueMin
yValueMax |
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 |
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 |
Specify a drill
down display. Any display (.rtv) file can be targeted as a drill
down.Once a drill down target has been set, double-click on the graph 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. |
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. |
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. |
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. |
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 color
chooser dialog has 4 tabs. The "RTView Colors" tab shows the
traditional palette of 252 indexed colors; the "Swatches" tab shows a
standard Java color palette; the "HSB" tab allows color selection by
hue, saturation, and brightness; and the RGB tab allows 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 Trend and Fx Bar are stored as a 24 bit integer RGB
value in the range of zero (black) to 16,777,215 (white). So if a color property
on an Fx Trend or Fx Bar 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.
|