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.
All traces in the Fx trend graph have the option
to display historical or current data:
|
Historical Data |
|
Current Data |
| To
display historical data, attach to
trace*ValueTable, where *
is the trace number, and include two columns in your attachment. The first column must be the time value and the second column the value
to plot.
Optionally, include a third
(string) column in your attachment if you want to display a data label for
each corresponding data value. See the Attach to Data section
specific to your data source for details on how to use the Select Columns
dialog.
|
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. Your data attachment can contain either a single
point of data or two columns of data.
See the Attach to Data
section specific to your data source for details on how to use the Select
Columns dialog. If your attachment contains a single point of data, Enterprise
RTView assigns a time stamp when the graph receives the data.
If your attachment contains two columns of
data, the first column must be the
time value and the second
column the value to plot. Optionally, include
a third (string) column in your attachment if you want to display a data
label for each corresponding data value. |
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.
Data labels will be displayed
(enclosed in parentheses) in the fixed legend and in the popup legend, between
the trace value and the trace label. If the cursorFlag property is
selected, then the data label in the popup legend is for the data value that is
directly under or to the left of the cursor.
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 |
| alarmGlowFlag |
If selected, the border of the trend graph will
glow if a trace point exceeds an alarm or warning threshold. NOTE: The
visibility of the border glow is based on trace points that are currently
visible. The color of the border glow is
the specified value*TraceColor.
If multiple trace points have exceeded an alarm
and/or warning threshold, whether they are on the same trace or multiple traces,
the value*TraceColor
of the border glow will be chosen in the following
order: HighAlarm, LowAlarm, HighWarning, LowWarning. NOTE: The color of the
border glow is based on trace points that are currently visible.
If the yAxisMultiRangeMode selected is
Strip Chart, then each chart will display its own border glow. |
| 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 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 if the yAxisAutoScaleMode
property is 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. |
Data Format Properties
| Property
Name |
Description |
| yValuePrecision |
Specify the number of digits displayed for
y-axis values in the legend and data tips. |
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 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.
When you double-click on a trace in the graph,
the following predefined substitutions will be set on the specified
drillDownTarget:
- $traceNumber - number of the trace (1 to 8)
that contains the selected point
- $traceLabel - label of selected trace
- $pointValue - data value of point
- $pointTimestamp - timestamp of point
- $pointLabel - data label (if any) of point
- $pointIndex - position of point in trace data
(0 to maxPointsPerTrace)
|
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 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 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 |
| 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. |
| visFlag |
Control visibility of the object. |
Plot Area Properties
Specify the way the plot
area is displayed in your graph.
| Property
Name |
Description |
| gridColor |
Select the
button and choose from the palette to set the color of the grid. Color properties are treated differently on Fx trend graph than on other objects,
see the Fx Graph Colors section below
for more information. |
| traceBgColor |
Select the
button and choose 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 Groups
Specify trace groups displayed
in your trend graph. The Display Builder automatically creates a
set of traceGroup* properties
(where * is the trace
group number) according to the number
of trace groups specified in the
traceGroupCount property. A trace group
is a collection of two or more traces. Trace groups are useful for identifying
multiple traces sharing the same vertical axis (when
yAxisMultiRangeMode is set to
Strip Chart or Multi-Axis) or for
identifying three traces combined as a banded trace.
| Property
Name |
Description |
| traceGroupCount |
Specify the number of traces
in your trace group. The maximum is 5. |
| traceGroup*TraceNumbers |
According to the number of traces
specified in the
traceCount property, enter a
comma-separated list of the traces to include in this group (i.e. 1,3,5,6).
NOTE: If
traceGroup*BandedFlag is selected, then
the number of traces listed should be 3. If
the yAxisMultiRangeMode selected
is Strip Chart or Multi-Axis:
- All the traces in the group will share the same
strip/axis, and
- If yAxisShowTraceLabelsFlag is selected
only the trace*Label of the first trace in the group will be displayed.
If the yAxisMultiRangeMode
selected
is Multi-Axis, the color of the axis for a trace group is determined by the
specified trace*LineColor of the first visible trace in the group. NOTE:
In Multi-Axis mode it is recommended that you assign the same
trace*LineColor/trace*LineStyle
and trace*MarkColor/trace*MarkStyle
to all traces included within a group.
Once a trace is included in a group, the following properties are no longer
available: trace*YAxisAutoScaleMode, trace*YAxisValueMax,
trace*YAxisValueMin. To scale the y-axis range of your trace group, use the
yAxisAutoScaleMode, yValueMax, and yValueMin properties.
NOTE: All traces included in a group must have the trace*YAxisVisFlag,
traceVisFlag and trace*YAxisGridVisFlag properties selected,
otherwise the y-axis and/or the y-axis grid will not be visible. |
| traceGroup*BandedFlag |
If selected, the plot area beneath the first
trace (the low band trace) and the area above the third trace (the high band
trace) will be filled. The second trace (the value trace) will not be filled. |
Trace Properties
Specify how traces are displayed
in your graph.
| Property
Name |
Description |
| multiTraceTableFlag |
Select to plot multiple traces from a single data
table.
| multiTraceCurrentValueTable |
Attach your current data. The first
column in the attachment must
contain a time value.
The remaining columns can either contain numeric or string data. The first
numeric value is used as the data point, the first string value is used as the
first data point's data label. Within the attachment, columns can be arranged in
any order (e.g.: numeric1, numeric2, string1, string2, numeric3, string3,
string4, numeric4). Unless
a trace*Label is already specified, the attached trace* column
names will be used as trace labels.
NOTE: If multiTraceHistoryValueTable is
also attached to data, it must contain the same number and type of columns as
the specified multiTraceCurrentValueTable. |
|
multiTraceHistoryValueTable |
Attach your historical data. The first column in
the attachment must contain a time value.
The remaining columns can either contain numeric or string data. The first
numeric value is used as the data point, the first string value is used as the
first data point's data label. Within the attachment, columns can be arranged in
any order (e.g.: numeric1, numeric2, string1, string2, numeric3, string3,
string4, numeric4). Unless
a trace*Label is already specified, the attached trace* column
names will be used as trace labels.
Typically, the attached data table contains initial
data points to be plotted (i.e. from a SQL attachment with Update Mode
set to On Demand, or from a Cache attachment with Update Once
selected.)
NOTE: If multiTraceCurrentValueTable is
also attached to data, it must contain the same number and type of columns as
the specified multiTraceHistoryValueTable. |
NOTE: Once multiTraceTableFlag is selected,
all trace data is expected to be provided via multiTraceCurrentValueTable
or multiTraceHistoryValueTable. Therefore, the trace*Value
and trace*ValueTable properties will no longer be available. |
| traceCount |
Specify the number of traces
in your graph. The maximum is 8. Enterprise RTView automatically creates
a set of properties (see Trace* Properties) for each trace. |
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, see
the Using Trace* Properties
section for details.
| Property
Name |
Description |
| trace*Label |
Set a label for your trace. |
| trace*LineColor |
Select the
button and choose from the palette to set the trace 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 trace from the drop down menu:
No Line, Solid, Dotted,
Dashed or Dot
Dashed. |
| trace*LineThickness |
Select the thickness of the trace from the drop down menu: Thin, Medium
or Thick.
|
| trace*MarkColor |
Select the
button and choose 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*Type |
Select the type of trace from the drop down
menu: Line, Bar or Event.
| Line
|
Line
connecting each data point. |
| Bar
|
Vertical bar for each data
point, from zero to the data point's value. Use the trace*LineThickness
property to control the width of the bar. NOTE: If trace*MarkStyle is set to any value other than No Marker, the mark will be drawn
at the end of the Bar trace. |
| Event
|
Small rectangle
containing the first character of the corresponding data label for each data
point. If no data label exists, then the first character of the specified
trace*Label is used. Each Event trace is positioned vertically according to
the data value for the corresponding data point.
The trace*LineColor property sets the
color of rectangle's edges and the enclosed text character. The
trace*MarkColor property sets the fill color of the rectangle. If
trace*LineColor and trace*MarkColor are set to the same color,
then traceBgColor is used to set the fill color of the rectangle.
NOTE: If the attached data contains
data labels but no data values, then an Event trace will be plotted regardless
of the specified trace*Type setting and Event trace rectangles will be
drawn near the bottom of the trace area. |
|
| trace*Value |
Attach your current data, either containing a
single point of data or two columns of data.
If your attachment contains a single point of
data, Enterprise RTView will assign a time stamp when the graph receives the
data.
If your attachment contains two columns of data,
the first column must be the
time value and the second column the value to
plot.
Optionally, include
a third (string) column in your attachment to display a data label for each
corresponding data value. The data label will be displayed (enclosed in
parentheses) in the fixed legend and in the popup legend, between the trace
value and the trace label. If the cursorFlag property is selected, then
the data label in the popup legend is for the data value that is directly under
or to the left of the cursor. |
| trace*ValueDivisor |
Enter a number. All traces will be divided by
this value. |
|
trace*ValueTable |
Attach your historical data containing two
columns: the first column
must be the time value and the second column
the value to plot.
Optionally, include
a third (string) column in your attachment to display a data label for each
corresponding data value. The data label will be displayed (enclosed in
parentheses) in the fixed legend and in the popup legend, between the trace
value and the trace label. If the cursorFlag property is selected, then
the data label in the popup legend is for the data value that is directly under
or to the left of the cursor. |
| trace*VisFlag |
Select to control trace
visibility. Click and hold on a trace's entry in the legend to temporarily
hide all other traces in the graph. |
X-Axis Properties
Specify the way the x-axis
is displayed in your graph.
| 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
-1 so 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. |
| 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. |
| xAxisColor |
Select the
button and choose from the palette to set the x-axis color. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. |
| xAxisFlag |
Select to display the x-axis. |
| xAxisGridVisFlag |
Select to display a grid
line for each major division along the x-axis. |
| xAxisLabelTextSize |
Specify the size in pixels
of the x-axis label. |
| xAxisMajorDivisions |
Specify the number of major
divisions on the x-axis. |
| xAxisThickness |
Specify (in pixels) the thickness of the x-axis.
Default is 8. |
Y-Axis Properties
Specify the way the y axis
is displayed in your graph.
| Property
Name |
Description |
| yAxisAutoScaleMode |
The yValueMin and
yValueMax properties control the range of the y-axis for 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.
NOTE: yAxisAutoScaleMode
is ignored if the yAxisLogFlag is selected. |
| 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. |
| yAxisColor |
Select the
button and choose from the palette to set the y-axis color. Color properties
are treated differently on Fx trend graph than on other objects, see the Fx
Graph Colors section below for more information. NOTE: The
yAxisColor property will be ignored when the yAxisMultiRangeFlag
property is selected. |
| yAxisFlag |
Select to display the y-axis. |
| yAxisGridVisFlag |
Select to display a grid
line for each major division along the y-axis. |
| yAxisLabel |
Set a label for the y-axis. |
| yAxisLabelTextSize |
Specify the size in pixels
of the y-axis labels. |
| 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. |
| yAxisMultiRangeMode |
Select one of the following modes:
| Off
|
All traces are plotted against a single y-axis. |
| Classic or 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. NOTE:
Some labels on the vertical axes may be dropped if the strips are not tall
enough to display the labels without overlapping. To avoid this, decrease
the value of the yAxisMajorDivisions property. |
|
Stacked
|
The
y-axis values for multiple traces displayed are "stacked". That is, the
value of each successive data point is accumulated and the sum from lower
numbered traces are plotted in the highest numbered trace.
NOTE: Actual (unstacked)
values for each individual trace are shown in the legend.
Values for lower numbered traces are not included
in the sum if a trace is invisible, has no data, all of its data
points are older or newer than the x-axis value, or the y-axis value at the
x-axis value is not a number (NaN).
If a
lower numbered trace has no y-axis value at a particular x-axis data point, but has
x-axis values before and after that data point, the y-axis value for the sum in that trace will be interpolated. |
In Classic, Multiple Axis and Strip Chart
modes, a separate vertical axis is drawn for each trace using the color
assigned in the trace*LineColor property. If the
yAxisShowTraceLabelsFlag property is selected, each axis will display the
label assigned in the trace*Label property.
When a yAxisMultiRangeMode is selected,
the yAxisThickness property is ignored and the width of each axis is
set to 2 pixels.
For better performance when scrolling in a
graph with many points, deselect yAxisShowTraceLabelsFlag and
trace*LineShadowFlag. |
| yAxisPosition |
Select one of
the following to set the position of the y-axis on the graph. NOTE: If yAxisMultiRangeMode is
deselected, then the
yAxisPosition
setting will be ignored
Outer Left - Draw
axis to the left of the trace area with tick marks extending out from the axis.
Outer Right - Draw
axis to the right of the trace area with tick marks extending out from the axis.
Outer Mixed - Draw
axis to the left of the trace area for odd numbered traces and to the right
for even numbered traces with tick marks extending out from the axis.
Inner Left - Draw
axis to the left of trace area with tick marks inside the axis line. Inner Right
- Draw axis to the right of trace area with tick marks inside the axis line.
Inner Mixed
- Draw axis to the left of the trace for odd numbered traces and to the right for even numbered traces
with tick marks inside the axis line. |
| yAxisShowTraceLabelsFlag |
If selected, multiple axes will display the
specified trace*Label of the trace associated with each axis. |
| yAxisThickness |
Specify (in pixels) the thickness of the y-axis.
Default is 8. NOTE: The yAxisThickness
property will be ignored when the yAxisMultiRangeMode property is
selected. |
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.
|
