Trend
Graphs
Trend graphs (class
name: obj_trendgraph02) are generally used for tracing two types of data
in one trend graph: real-time, or live data, and archived data.
Displaying these two types of traces in conjunction is useful for comparing data
trends. The
trend graph supports up to ten traces, set the traceCount
to control the number of traces.
Trace Properties
Specify how traces are displayed
in your trend graph.
Property
Name |
Description |
traceCount |
Specify the number of traces
in your graph. The maximum is ten. Enterprise RTView automatically creates
a set of properties for each trace in the Object Properties window. |
traceFillStyle |
Set traceFillStyle
to Solid, Transparent, Gradient, or Transparent
Gradient to fill the area under the trace. Set to None to disable
this feature. None is the default. |
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 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, and
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 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.
To display both historical and current data in a single trace, attach your
current data to trace*Value.
You then have two
options for your historical data. You can either enable the trace*ValueHistoryFlag
so that initial data is loaded from the
Historian database.
Or you can disable
the trace*ValueHistoryFlag property and use your own historical
data by attaching it to the trace*ValueTable property.
NOTE:
The trace*ValueHistoryFlag
property and the trace*ValueTable
property cannot be used together.
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. |
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. |
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*ValueAlarmStatus |
Use if your trace is being
driven by trace*Value. To apply an alarm status to a trace, enter
an alarm status index which will be applied to any new points plotted.
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. |
trace*ValueAlarmStatusTable |
Use if your trace is being
driven by trace*ValueTable. Attach an alarm table containing status
indexes to trace*ValueAlarmStatusTable to enable rule based alarm
statuses for trace markers. This table must have a time column (formatted
like the time value in the trace*ValueTable) and a value column
where the value column contains alarm status values 0-4. The table must
also have the same number of rows as the corresponding trace*ValueTable.
For each data element in trace*ValueTable, the status index at the
corresponding position in trace*valueAlarmStatusTable will be 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 trace*ValueAlarmStatusTable, then the
alarm status for a trace marker is determined by comparing the marker's
value to the enabled thresholds. |
trace*VisFlag |
Select to control trace
visibility. Click and press a trace's entry in the legend to temporarily
hide all other traces in the graph. |
trace*YAxisGridVisFlag |
Select to display a grid
line for each major division along the y-axis if yAxisMultiRangeMode
is set to Multiple Axis or Strip Chart.
If yAxisMultiRangeMode
is set to Off or Classic, grid visibility is
set by selecting the yAxisGridVisFlag. |
trace*YAxisMinLabelWidth |
Specify the minimum width in pixels for the
y-axis labels if yAxisMultiRangeMode is set to
Multiple
Axis or Strip Chart.
If yAxisMultiRangeMode is set to Off
or Classic, set minimum width with yAxisMinLabelWidth. |
trace*YAxisValueLabels |
Set to display a text label or tick mark on the
y-axis in place of a numerical value if yAxisMultiRangeMode is set to
Multiple Axis or Strip Chart. Include a value
with no label to display a tick mark without a label. Use this format:
value1=label1,value2,value3=label2
(e.g., 0=Off,1,2=On)
If
yAxisMultiRangeMode
is set to Off or Classic, set y-axis labels
with the yAxisValueLabels property. |
trace*YAxisAutoScaleMode
trace*YAxisValueMin
trace*YAxisValueMax |
These properties only apply if
yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
When trace*YAxisAutoScaleMode is set to
Off, the trace*YAxisValueMin and trace*YAxisValueMax
properties control the range of the y-axis for this trace. Select On to
calculate the range of the y-axis according to data values being plotted. To
calculate the y-axis range including trace*YAxisValueMin and
trace*YAxisValueMax, select
On
- Include Min/Max.
If yAxisMultiRangeMode
is set to Off or Classic, then use the yAxisAutoScaleMode,
yAxisValueMin
and yAxisValueMax properties to control the range of the y-axis. |
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. To calculate
the the y-axis range including yValueMin and yValueMax, select
On
- Include Min/Max.
If yAxisMultiRangeMode
is set to Multiple Axis or Strip Chart, then use the trace*YAxisAutoScaleMode,
trace*YAxisValueMin
and trace*YAxisValueMax properties to control the range of the y-axis. |
Data Format Properties
Specify data format in your
graph.
Property
Name |
Description |
yValueFormat |
Select or enter the numeric
format of values displayed in the legend and popup legend. To enter a format,
use syntax from the Java DecimalFormat class. |
Interaction Properties
Specify how you interact
with the data in your 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. |
legendPopupFlag |
Select to display the legend
along the cursor. (Only enabled if the cursorFlag is selected.) |
scrollbarMode |
Select Never, As Needed,
or Always from the scrollbarMode property to set the behavior
of the scroll bar in the graph. 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
more data loaded into the graph than you are displaying in the time range.
For example, if timeRangeOfHistory
is greater than timeRange, setting scrollbarMode to As
Needed will enable a scroll bar to view all historical data loaded
into the graph. |
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.
NOTE: The graph is paused
after a zoom is performed and returns to updating with live data when the
graph is zoomed back out to 100%. |
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. |
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. |
Plot Area Properties
Specify the way the plot
area is displayed in your trend graph.
Property
Name |
Description |
traceBgGradientFlag |
Select to display
a gradient in the plot background. Set the color of the plot background
with the traceBgColor property. |
traceBgColor |
Select the
button and choose a color from the palette to set the background color
of your graph. |
traceBgImage |
Select an image
to display in the plot background of your graph. If necessary, the image
will be stretched to fit the plot area. |
Background Properties
Specify how the background
is displayed in your trend 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 trend 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. |
legendBgGradientFlag |
Select the legendBgGradientFlag
to display a gradient in the legend background. |
legendTimeFormat |
Set the format for the time
displayed in the legend using syntax from the Java SimpleDateFormat class.
For example, MMMM dd,
yyyy hh:mm:ss a would result in the form August 30, 2003 05:32:12
PM. If no format is given, the timeFormat
will be used. |
legendValueMinSpace |
Specify the minimum distance
between values and labels in the legend. |
legendVisFlag |
Select to display the legend. |
legendWidthPercent |
Set the percent of the total
width of the object used for 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 |
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
valueHighWarningMarkColorand
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. |
X-Axis Properties
Specify the way the x axis
is displayed in your trend graph.
Property
Name |
Description |
timeFormat |
Set the format
for the time displayed in the x-axis using syntax from the Java SimpleDateFormat
class.
For example, MMMM dd,
yyyy hh: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: timeRange is ignored
if both timeRangeBegin and timeRangeEnd are set. |
timeRangeBegin |
Set the start time value
of the data to be plotted on the graph.
Supported formats 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. NOTE: If only the time is specified, then today's date will
be used. |
timeRangeEnd |
Set the end time value of
the data to be plotted on the graph.
Supported formats 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. NOTE: If only the time is specified, then today's date will
be used. |
timeRangeOfHistory |
Specify how much historical
data is loaded into the graph, in seconds. If timeRangeOfHistory
is set to zero or less (default is -1), or if it is less than the value
of timeRange, then the timeRange property determines the
amount of historical data to be loaded into the graph. |
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. |
xAxisGridVisFlag |
Select to display a grid
line for each major division along the x-axis. |
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. |
Y-Axis Properties
Specify the way the y axis
is displayed in your trend graph.
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. To calculate
the the y-axis range including yValueMin and yValueMax, select
On
- Include Min/Max.
If yAxisMultiRangeMode
is set to Multiple Axis or Strip Chart, then use the trace*YAxisAutoScaleMode,
trace*YAxisValueMin
and trace*YAxisValueMax properties to control the range of the y-axis. |
yAxisAutoScaleVisTracesOnlyFlag |
Select to include only visible
traces when calculating the y-axis range. By default all traces in the
traceCount are used in the auto-scale calculation, including those that are
invisible or unattached to data. |
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. |
yAxisGridVisFlag |
Select to display a grid
line for each major division along the y-axis if yAxisMultiRangeMode
is set to Off or Classic.
If yAxisMultiRangeMode
is set to Multiple Axis or Strip Chart, grid visibility is
set by selecting the trace*YAxisGridVisFlag. |
yAxisLabelTextHeight |
Specify the height in pixels
of the y-axis labels. |
yAxisMajorDivisions |
Specify the number of major
divisions on the y-axis. This is ignored if yAxisValueLabels is
set. |
yAxisMinLabelWidth |
Specify the minimum
width in pixels for the y-axis labels. If yAxisMultiRangeMode is
set to Multiple Axis or Strip Chart, minimum width is set
by trace*YAxisMinLabelWidth. |
yAxisMinorDivisions |
Specify the number of minor
divisions on the y-axis. This is ignored if yAxisValueLabels is
set. |
yAxisMultiRangeMode |
Select one of
the following modes:
Off - All traces are
plotted against a single y-axis.
Classic - One axis
per trace, with each trace having its own range. The 1st trace is drawn
on the outer left of the graph. The remaining traces are drawn on the inner
left of the trace area.
Multiple Axis - One
axis per trace, with each trace having its own range. Use the trace*YAxisAutoScaleMode,
trace*YAxisValueMin
and trace*YAxisValueMax properties to control the range of the y-axis.
Strip Chart - The
trace area is divided into strips, one for each trace. Each trace has its
own y-axis but all traces share the same x-axis. Use the trace*YAxisAutoScaleMode,
trace*YAxisValueMin
and trace*YAxisValueMax properties to control the range of the y-axis. |
yAxisPosition |
Select one of
the following to set the position of the y-axis on the graph. NOTE: The
yAxisPosition
setting is ignored if yAxisMultiRangeMode is set to Classic.
Outer Left - Draw
axis to the left of the trace area.
Outer Right - Draw
axis to the right of the trace area.
Outer Mixed - Draw
axis to the left of the trace area for odd numbered traces and to the right
for even numbered traces.
Inner Left - Draw
axis on the inside left of the trace area.
Inner Right - Draw
axis on the inside right of the trace area.
Inner Mixed - Draw
axis on the inside left of the trace area for odd numbered traces and on
the inside right of the trace area for even numbered traces. |
yAxisValueLabels |
Set to display
a text label or tick mark on the y-axis in place of a numerical value.
Include a value with no label to display a tick mark without a label. Use
this format:
value1=label1,value2,value3=label2
(e.g., 0=Off,1,2=On)
If
yAxisMultiRangeMode
is set to Multiple Axis or Strip Chart mode, the y-axis labels
are set using the trace*YAxisValueLabels property. |
|