Apama 10.15.0 | Building and Using Apama Dashboards | Dashboard Property Reference for Graphs, Tables and Trends | Graph Objects | XY graph | XY graph: Alert group
 
XY graph: Alert group
Properties in this group allow you to specify changes in the appearance of trace lines and markers that signal changes in the status of specified data elements. You can specify threshold values (see valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning) or attach a data table to valueAlarmStatusTable that indicates the status of each element of the table that is attached to valueTable.
Alert group propeties
This group includes the following properties:
* valueAlarmStatusTable
* valueHighAlarm
* valueHighAlarmEnabledFlag
* valueHighAlarmLineVisFlag
* valueHighAlarmMarkColor
* valueHighAlarmMarkStyle
* valueHighAlarmTraceColor
* valueHighAlarmTraceStyle
* valueHighWarning
* valueHighWarningEnabledFlag
* valueHighWarningLineVisFlag
* valueHighWarningMarkColor
* valueHighWarningMarkStyle
* valueHighWarningTraceColor
* valueHighWarningTraceStyle
* valueLowAlarm
* valueLowAlarmEnabledFlag
* valueLowAlarmLineVisFlag
* valueLowAlarmMarkColor
* valueLowAlarmMarkStyle
* valueLowAlarmTraceColor
* valueLowAlarmTraceStyle
* valueLowWarning
* valueLowWarningEnabledFlag
* valueLowWarningLineVisFlag
* valueLowWarningMarkColor
* valueLowWarningMarkStyle
* valueLowWarningTraceColor
* valueLowWarningTraceStyle
valueAlarmStatusTable
Attach an alarm table containing status indexes to this property in order to enable rule based alarm statuses for trace markers. The table attached to valueAlarmStatusTable must have the same number of rows and columns as valueTable. For each data element in valueTable, the status index at the corresponding position in valueAlarmStatusTable is used to set the alarm status of the marker that represents the data element.
Following are the valid indexes are:
*0: Use normal marker color and style. See traceProperties.
*1: Use low alarm marker color and style valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
*2: Use low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
*3: Use high warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
*4: Use 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 valueAlarmStatusTable, 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 Alert property group.
valueHighAlarm
Specifies the threshold value used by valueHighAlarmLineVisFlag, valueHighAlarmMarkColor, valueHighAlarmMarkStyle, valueHighAlarmTraceColor, and valueHighAlarmTraceStyle.
This property is in the Alert property group.
valueHighAlarmEnabledFlag
Select to enable the high alarm threshold. See valueHighAlarm.
This property is in the Alert property group.
valueHighAlarmLineVisFlag
Select to display a dotted line at the high alarm threshold. The color of the line is set to valueHighAlarmMarkColor. This line is displayed only if valueHighAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueHighAlarmMarkColor
When a trace marker's value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker's corresponding element in the attached alarm status table is 4.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueHighAlarmMarkStyle
When a trace marker's value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker's corresponding element in the attached alarm status table is 4.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueHighAlarmTraceColor
When the value of any segment of a trace line is greater than or equal to valueHighAlarm, that segment of the trace line changes to valueHighAlarmTraceColor and valueHighAlarmTraceStyle, provided valueHighAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueHighAlarmTraceStyle
When the value of any segment of a trace line is greater than or equal to valueHighAlarm, that segment of the trace line changes to valueHighAlarmTraceColor and valueHighAlarmTraceStyle, provided valueHighAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueHighWarning
Specifies the threshold value used by valueHighWarningLineVisFlag, valueHighWarningMarkColor, valueHighWarningMarkStyle, valueHighWarningTraceColor, and valueHighWarningTraceStyle.
This property is in the Alert property group.
valueHighWarningEnabledFlag
Select to enable the high warning threshold. See valueHighWarning.
This property is in the Alert property group.
valueHighWarningLineVisFlag
Select to display a dotted line at the high warning threshold. The color of the line is set to valueHighWarningMarkColor. This line is displayed only if valueHighWarningEnabledFlag is selected.
This property is in the Alert property group.
valueHighWarningMarkColor
When a trace marker's value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker's corresponding element in the attached alarm status table is 3.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueHighWarningMarkStyle
When a trace marker's value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker's corresponding element in the attached alarm status table is 3.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueHighWarningTraceColor
When the value of any segment of a trace line is greater than or equal to valueHighWarning property but less than valueHighAlarm, that segment of the trace line changes to valueHighWarningTraceColor and valueHighWarningTraceStyle, provided valueHighWarningEnabledFlag is selected.
This property is in the Alert property group.
valueHighWarningTraceStyle
When the value of any segment of a trace line is greater than or equal to valueHighWarning property but less than valueHighAlarm, that segment of the trace line changes to valueHighWarningTraceColor and valueHighWarningTraceStyle, provided valueHighWarningEnabledFlag is selected.
This property is in the Alert property group.
valueLowAlarm
Specifies the threshold value used by valueLowAlarmLineVisFlag, valueLowAlarmMarkColor, valueLowAlarmMarkStyle, valueLowAlarmTraceColor, and valueLowAlarmTraceStyle.
This property is in the Alert property group.
valueLowAlarmEnabledFlag
Select to enable the low alarm threshold. See valueLowAlarm.
This property is in the Alert property group.
valueLowAlarmLineVisFlag
Select to display a dotted line at the low alarm threshold. The color of the line is set to valueLowAlarmMarkColor. This line is displayed only if valueLowAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueLowAlarmMarkColor
When a trace marker's value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker's corresponding element in the attached alarm status table is 1.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueLowAlarmMarkStyle
When a trace marker's value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker's corresponding element in the attached alarm status table is 1.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueLowAlarmTraceColor
When the value of any segment of a trace line is less than or equal to valueLowAlarm, that segment of the trace line changes to valueLowAlarmTraceColor and valueLowAlarmTraceStyle, provided valueLowAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueLowAlarmTraceStyle
When the value of any segment of a trace line is less than or equal to valueLowAlarm, that segment of the trace line changes to valueLowAlarmTraceColor and valueLowAlarmTraceStyle, provided valueLowAlarmEnabledFlag is selected.
This property is in the Alert property group.
valueLowWarning
Specifies the threshold value used by valueLowWarningLineVisFlag, valueLowAlarmMarkColor, valueLowWarningMarkStyle, valueLowWarningTraceColor, and valueLowWarningTraceStyle.
This property is in the Alert property group.
valueLowWarningEnabledFlag
Select to enable the low warning threshold. See valueLowWarning.
This property is in the Alert property group.
valueLowWarningLineVisFlag
Select to display a dotted line at the low warning threshold. The color of the line is set to valueLowWarningMarkColor. This line is displayed only if valueLowWarningEnabledFlag is selected.
This property is in the Alert property group.
valueLowWarningMarkColor
When a trace marker's value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker's corresponding element in the attached alarm status table is 2.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueLowWarningMarkStyle
When a trace marker's value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.
If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker's corresponding element in the attached alarm status table is 2.
If data is attached to valueAlarmStatusTable, and the marker's corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.
This property is in the Alert property group.
valueLowWarningTraceColor
When the value of any segment of a trace line is less than or equal to valueLowWarning but greater than valueLowAlarm, that segment of the trace line changes to valueLowWarningTraceColor and valueLowWarningTraceStyle, provided valueLowWarningEnabledFlag is selected.
This property is in the Alert property group.
valueLowWarningTraceStyle
When the value of any segment of a trace line is less than or equal to valueLowWarning property but greater than valueLowAlarm, that segment of the trace line changes to valueLowWarningTraceColor and valueLowWarningTraceStyle, provided valueLowWarningEnabledFlag is selected.
This property is in the Alert property group.