Widget "AlarmLine" provides the necessary interface for displaying and interacting with an alarm. This widget is used in combination with mapp AlarmX. mapp AlarmX collects and manages all alarms.
An alarm in the form of a banner can be displayed using widget "AlarmLine". For information about which alarm should be displayed, see section Concept filtering of alarms.
This widget contains all important functions of an alarm system.
To use this widget, library MpServer must be present on the target system. "MpServer" is used for internal communication. For more information, see here.
The following properties cannot be used in compound widget "Mapping":
zIndex, left, top, height, width, imageHeight, imageWidth
Appearance
|
|
Editor |
Web browser |
Properties
Type |
Description |
Bindable |
Necessary |
Default value |
|
Defines the usability of the widget. A disabled widget (enable=false) does not react to user interaction and does not trigger events. The "enable" behavior is inherited from the container widgets to the child widgets. |
|
|
true |
||
left |
Absolute position measured from the left border of the surrounded element (e.g. container widget or content). |
|
|
|
|
top |
Absolute position measured from the top border of the surrounded element (e.g. container widget or content). |
|
|
|
|
permissionOperate |
Defines the roles that are permitted to use the widget. For roles without sufficient rights, the widget does not react to user interaction and does not trigger events. |
|
|
|
|
permissionView |
Defines the roles that are permitted to see the widget. For roles without sufficient rights, the widget is hidden. |
|
|
|
|
Reference to a customizable widget style. |
|
|
default |
||
Defines the visibility of the widget. The widget can be hidden with visible=false. (visible = true, hidden = false). The "visible" behavior is inherited from the container widget to the child widgets. |
|
|
true |
||
width |
Defines the total width of the widget in pixels. A value in % refers to the width of the surrounding element. |
|
|
600 |
|
height |
Defines the total height of the widget in pixels. A value in % refers to the height of the surrounding element. |
|
|
80 |
|
zIndex determines the z-order of the widget. With overlapping widgets, the zIndex determines which widget is on the top and which one is on the bottom. The widget with the larger zIndex is on top, and the one with the smaller zIndex is on the bottom. The zIndex must be unique within a piece of content or a container widget. The zIndex is automatically assigned by the visual editor and can therefore be changed via the toolbar. |
|
|
|
||
Defines the format used to display the date and/or time. It is possible to specify a format string (e.g. "HH:mm:ss") or predefined pattern (e.g. "F"). |
|
|
F |
||
imageActive |
Relative path to an image that is used for state "Active"/"Unacknowledged". If no image is defined, a predefined image is used. For more information, see here. |
|
|
|
|
imageActiveAcknowledged |
Relative path to an image that is displayed on the widget for state "Active and acknowledged". If no image is defined, a predefined image is used. For more information, see here. |
|
|
|
|
imageInactive |
Relative path to an image that is displayed on the widget for state "Active and acknowledged". If no image is defined, a predefined image is used. For more information, see here. |
|
|
|
|
imagePrefix |
Relative path to images displayed on the widget for the category. For more information, see here. |
|
|
|
|
imageSuffix |
Defines the file extension of the images located in the path of property "imagePrefix". |
|
|
.png |
|
Connection to the mapp component. The important thing here is that the binding mode is "Read/Write". For further information, see Concept. |
|
|
|
||
sortOrder |
Defines how entries should be sorted. They can be sorted by the last or first triggered alarm. It is also possible to sort by severity (taking into account the priority status – active, active acknowledged and inactive – severity level and timestamp). descending: Sorts according to the last triggered alarm ascending: Sorts according to the first triggered alarm descendingBySeverity: Sorts alarms by the highest priority status, then by the highest severity and then the last one that was triggered. ascendingBySeverity: Sorts alarms by the highest priority status, then by the highest severity and then the one that was triggered first. |
|
|
descending |
|
Defines the filter settings. Can only be modified using the configuration dialog box. A variable that receives the correct settings from the configuration dialog box must be bound. For more information, see here. |
|
|
|
||
Defines the style settings. Can only be adjusted via the configuration dialog box. A variable must be bound that receives the correct settings of the configuration dialog box. For additional information, see here. |
|
|
|
||
tooltip |
Defines the text that should appear as information when the tooltip indicator is pressed. A static text or a text from the text system can be used. For more information, see here. Mode "Tooltip" must be enabled for this. There are two different options for this: •Using action "ShowTooltip" •Using action "Client system" ShowTooltips. |
|
|
|
|
imageHeight |
Defines the height of the image in the widget. |
|
|
0 |
|
imageWidth |
Defines the width of the image in the widget. |
|
|
0 |
|
wordWrap |
Defines whether a break will be added to the text after a word if necessary. |
|
|
true |
|
multiLine |
Defines whether the text can be displayed on multiple lines. If wordWrap has value true, the text is wrapped after a word, if necessary. For additional information, see |
|
|
true |
|
ellipsis |
Defines whether a text that is too long should be indicated by an ellipsis, e.g. "This text is..." instead of "This text is too long". For more information, see here. |
|
|
false |
|
tabIndex |
Property tabIndex is used to manage the tab order during keyboard operation. For additional information, see Keyboard operation. ENTER triggers event Click if tabIndex ≥0. |
|
|
-1 |
Styleable properties
Type |
Description |
Default value |
|
backColor |
Defines the background color of the widget. |
Transparent |
|
backGroundGradient |
Defines the background color of the widget as a color gradient. |
|
|
borderStyle |
Defines the style of the border around the widget. Borders can be unbroken, dashed or dotted. |
solid |
|
borderWidth |
Defines the width of the border around the widget. |
1px |
|
borderColor |
Defines the color of the border around the widget. |
#8b0000 |
|
cellBorderStyle |
Defines the style of the header's border. |
none |
|
cellBorderWidth |
Defines the width of the header's border. |
0px |
|
cellBorderColor |
Defines the color of the border around the cell. |
#FFFFFF |
|
cellCornerRadius |
Defines the rounding of the corners around the cells. |
0px |
|
cellPadding |
Defines the spacing between the outer boundary of the table entry and its content. For more information, see here. |
0px 12px |
|
padding |
Defines the spacing between the outer boundary of the widget and its content. For more information, see here. |
0px |
|
margin |
Defines the offset of the external boundary of the widget to the widget's actual set position. For more information, see here. |
0px |
|
fontName |
Defines the font used for the text shown. |
Arial |
|
textColor |
Defines the color used to display the text. |
#333333 |
|
fontSize |
Defines the size of the font used to display the text. |
16px |
|
bold |
Defines whether the text is shown in bold. |
false |
|
italic |
Defines whether the text is shown in italics. |
false |
|
shadow |
Defines the shadow of the widget. |
none |
|
cornerRadius |
Defines the corner style of the widget. |
0px |
|
textAlign |
Defines the orientation of the text. |
center |
|
opacity |
Defines the transparency of the widget. The lower the value, the more transparent the widget. |
1 |