Apama 10.15.0 | Building and Using Apama Dashboards | Dashboard Property Reference for Graphs, Tables and Trends | Trend Objects | Trend graphs | Trend graph: TraceN group
 
Trend graph: TraceN group
The properties in this group control the visibility and appearance of the price trace, as well as the data to which it is attached (unless multiTraceTableFlag is enabled). They also control y-axis visibility, scaling, and labeling. In addition, there are properties to which you can attach a data table that indicates the alarm status of plotted data; see Trend graph: Alert group.
TraceN group properties
The group includes the following properties:
* traceNLabel
* traceNLineColor
* traceNLineStyle
* traceNLineThickness
* traceNMarkColor
* traceNMarkStyle
* traceNType
* traceNValue
* traceNValueAlarmStatus
* traceNValueAlarmStatusTable
* traceNValueDivisor
* traceNValueHistoryFlag
* traceNValueTable
* traceNVisFlag
* traceNYAxisAutoScaleMode
* traceNYAxisFlag
* traceNYAxisGridVisFlag
* traceNYAxisMinLabelWidth
* traceNYAxisValueLabels
* traceNYAxisValueMax
* traceNYAxisValueMin
traceNLabel
Enter a label for the trace line. This label appears in the chart's legend.
This property is in the TraceN property group.
traceNLineColor
Sets the trace line color. Select the ... button and choose a color from the palette. Close the Color Chooser window when you are done.
This property is in the TraceN property group.
traceNLineStyle
Select one of the following line styles for the trace line from the drop down menu:
*No Line
*Solid
*Dotted
*Dashed
*Dot Dashed
This property is in the TraceN property group.
traceNLineThickness
Select one of the following thickness specifications for the price trace line from the drop down menu:
*Thin
*Medium
*Thick
This property is in the TraceN property group.
traceNMarkColor
Select the ... button and choose a color from the palette to set the trace marker color. Close the Color Chooser window when you are done.
This property is in the TraceN property group.
traceNMarkStyle
Sets the style of the marker used on the trace. Select one of the following items from the drop down menu:
*No Marker
*Dot
*+
**
*o
*x
*Filled Circle
*Filled Diamond
*Filled Triangle
*Filled Square
*Filled Star
This property is in the TraceN property group.
traceNType
Sets the trace type. The valid values are Line (the default), Bar, and Event.
A Bar type trace draws a vertical bar for each data point, from zero to the point's Y value. The bar is just a vertical line whose width is determined by traceNLineThickness. The traceNLineColor and traceNLineStyle also control the appearance of the bar. If the point exceeds an alarm limit specified on the graph, the alarm color is used for the bar color. If traceNMarkStyle is set to any value other than None, the mark is drawn at the end of the bar.
For an Event type trace, no line is drawn. Instead, a small rectangle containing a single text character is drawn for each data point. The character is the first character of the corresponding data label if any, otherwise it is the first character of the trace label. The traceNColor property determines the color of edges of the box and the text character, unless the point exceeds an alarm limit specified on the graph, in which case the corresponding alarm color is used. The box's fill color is set to traceNMarkColor or the appropriate alarm mark color, if any. However, if the mark color is the same as the color used for the box edge and text, traceBgColor is used as the box fill color instead.
Each event box is positioned vertically according to the Y data value for the corresponding data point. However, if traceN is attached to a data table that provides data labels but no Y data values, an Event trace is plotted regardless of the traceNType setting. The event boxes are all drawn near the bottom of the trace area.
This property is in the TraceN property group.
traceNValue
To display current data, attach to this property. When you attach data to this 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, two columns of data, or three columns of data. If it contains a single point of data, the dashboard 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.
Following are supported formats for the time value column:
*mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
*yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
*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.
If the attachment contains three columns of data, the third column must be a string column, which is used as the data label for the corresponding data point. The data label for a point is shown in the fixed legend and in the popup legend, between the trace value and the trace label, and is enclosed in parentheses. If the cursorFlag property is checked, the data label shown in the legend is for the data point that is directly under or to the left of the cursor.
This property is in the TraceN property group.
traceNValueAlarmStatus
To apply an alarm status to traceN, enter an alarm status index, which indicates how to determine the marker color and style for each new plotted point derived from traceNValue. Enter one of the following integers:
0: Normal marker color and style. See traceNMarkColor and traceNMarkStyle.
1: Low alarm marker color and style: See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
2: Low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
3: High warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
4: High alarm marker color and style. See valueHighAlarmMarkColor and valueHighAlarmMarkStyle.
-1: Determine marker color and style by comparing the value to the enabled alarm thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.
The default is -1.
This property is in the TraceN property group.
traceNValueAlarmStatusTable
Attach an alarm table containing status indexes to tracenValueAlarmStatusTable to enable rule based alarm statuses for trace markers. This table must have a time column (formatted like the time value in the traceNValueTable) 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 tracenValueTable. For each data element in traceNValueTable, the status index at the corresponding position in tracenvalueAlarmStatusTable is used to set the alarm status of the marker.
Valid indexes are:
0: Normal marker color and style. See traceNMarkColor and traceNMarkStyle.
1: Low alarm marker color and style. See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
2: Low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
3: High warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
4: High alarm marker color and style. See valueHighAlarmMarkColor and valueHighAlarmMarkStyle.
-1: Determine marker color and style by comparing the value to the enabled alarm thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.
If no data is attached to tracenValueAlarmStatusTable, then the alarm status for a trace marker is determined by comparing the marker's value to the enabled thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.
This property is in the TraceN property group.
traceNValueDivisor
All trace values are divided by the number entered into the tracenValueDivisor.
This property is in the TraceN property group.
traceNValueHistoryFlag
Do not use this property.
This property is in the TraceN property group.
traceNValueTable
To display historical data, attach to tracenValueTable, where n 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. Following are supported formats for the time value column:
*mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
*yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
*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.
This property is in the TraceN property group.
traceNVisFlag
Select to control trace visibility. Mouse over a trace's entry in the legend and hold down the left mouse button in order to temporarily hide all other traces in the graph.
This property is in the TraceN property group.
traceNYAxisAutoScaleMode
Controls how the y-axis range is calculated for this trace, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart. Select one of the following from the drop down menu:
*Off: The traceNYAxisValueMin and traceNYAxisValueMax properties determine the range of the y-axis.
*On: The dashboard calculates the y-axis range according to data values being plotted.
*On - Include Min/Max: The dashboard calculates the smallest range (with rounding) that includes traceNYAxisValueMin and traceNYAxisValueMax as well as all plotted points.
This property is in the TraceN property group.
traceNYAxisFlag
Controls the visibility of the labels and ticks for traceN, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
This property is in the TraceN property group.
traceNYAxisGridVisFlag
Set to display a horizontal line for each major y-axis division for traceN, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
This property is in the TraceN property group.
traceNYAxisMinLabelWidth
Specifies the minimum width of the y-axis labels in pixels, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
This property is in the TraceN property group.
traceNYAxisValueLabels
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
Here is an example:
0=Off,1,2=On
This property is in the TraceN property group.
traceNYAxisValueMax
Controls the range of y-axis if the traceNYAxisAutoScaleMode is set to Off. Select On for the traceNYAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes traceNYAxisValueMin and traceNYAxisValueMax, select On - Include Min/Max.
This property is used only if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
This property is in the TraceN property group.
traceNYAxisValueMin
Controls the range of y-axis if the traceNYAxisAutoScaleMode is set to Off. Select On for the traceNYAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes traceNYAxisValueMin and traceNYAxisValueMax, select On - Include Min/Max.
This property is used only if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.
This property is in the TraceN property group.