Apama 10.15.0 | Building and Using Apama Dashboards | Dashboard Property Reference for Graphs, Tables and Trends | Graph Objects | Bar graphs | Bar graph: Alert group
 
Bar graph: Alert group
Properties in this group allow you to specify changes in the appearance of bars, trace lines, and trace markers in response to changes in the status of plotted data elements. You can either specify threshold values (see valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning) or attach a data table to traceValueAlarmStatusTable that indicates the status of each element of the table that is attached to traceValueTable.
Alert group properties
This group includes the following properties:
* traceValueAlarmStatusTable
* valueHighAlarm
* valueHighAlarmColor
* valueHighAlarmEnabledFlag
* valueHighAlarmLineVisFlag
* valueHighAlarmMarkColor
* valueHighAlarmMarkStyle
* valueHighWarning
* valueHighWarningColor
* valueHighWarningEnabledFlag
* valueHighWarningLineVisFlag
* valueHighWarningMarkColor
* valueHighWarningMarkStyle
* valueLowAlarm
* valueLowAlarmColor
* valueLowAlarmEnabledFlag
* valueLowAlarmLineVisFlag
* valueLowAlarmMarkColor
* valueLowAlarmMarkStyle
* valueLowWarning
* valueLowWarningColor
* valueLowWarningEnabledFlag
* valueLowWarningLineVisFlag
* valueLowWarningMarkColor
* valueLowWarningMarkStyle
traceValueAlarmStatusTable
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 traceValueAlarmStatusTable must have the same number of rows and columns as traceValueTable. For each data element in traceValueTable, the status index at the corresponding position in traceValueAlarmStatusTable 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. See 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
If no data is attached to traceValueAlarmStatusTable, 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, and valueHighAlarmColor.
This property is in the Alert property group.
valueHighAlarmColor
When the value of a bar or trace segment is greater than or equal to valueHighAlarm, its color changes to the valueHighAlarmColor, provided valueHighAlarmEnabledFlag is selected.
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 dashed 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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
This property is in the Alert property group.
valueHighWarning
Specifies the threshold value used by valueHighWarningLineVisFlag, valueHighWarningMarkColor, valueHighWarningMarkStyle, and valueHighWarningColor.
This property is in the Alert property group.
valueHighWarningColor
When the value of a bar or trace segment is greater than or equal to valueHighWarning but less than valueHighAlarm, its color changes to valueHighWarningColor, provided valueHighWarningEnabledFlag is selected.
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 dashed 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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
This property is in the Alert property group.
valueLowAlarm
Specifies the threshold value used by valueLowAlarmLineVisFlag, valueLowAlarmMarkColor, valueLowAlarmMarkStyle, and valueLowAlarmColor.
This property is in the Alert property group.
valueLowAlarmColor
When the value of a bar or trace segment is less than or equal to valueLowAlarm, it's color changes to valueLowAlarmColor, provided valueLowAlarmEnabledFlag is selected.
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 dashed 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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
This property is in the Alert property group.
valueLowWarning
Specifies the threshold value used by valueLowWarningLineVisFlag, valueLowWarningMarkColor, valueLowWarningMarkStyle, and valueLowWarningColor.
This property is in the Alert property group.
valueLowWarningColor
When the value of a bar or trace segment is less than or equal to valueLowWarning but greater than valueLowAlarm, it changes to valueLowWarningColor, provided valueLowWarningEnabledFlag is selected.
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 dashed 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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
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 traceValueAlarmStatusTable.
If data is attached to traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable, 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 traceValueAlarmStatusTable.
This property is in the Alert property group.