The NotificationCenterBadge widget

Available since version: 0.11.0
Author: Tobias Bräutigam

Description

Shows the current number of messages in {@link cv.ui.NotificationCenter} and opens it on click.

Settings

For a general understanding of how the configuration files are structured and what elements and attributes are it is recommended to read this section first: Pages and structure of CometVisu.

The behaviour and appearance of the NotificationCenterBadge widget can be influenced by using certain attributes and elements. The following tables show the allowed attributes and elements and their possible values. The screenshots show, how both can be edited in the editor.

Attributes underlined by ..... are mandatory, all the others are optional and can be omitted.

Allowed attributes in the NotificationCenterBadge-element

Element Attribute
  Name Content Description
notificationcenterbadge align left, right or center  
flavour string Selection of a display variant. See also Flavour.
class string Add this value to the CSS class so that it can be formated by a user provided style sheet.
hide-when-empty true or false Hide this widget when the NotificationCenter is empty.
../../../_images/en_config_widgets_notificationcenterbadge_index_editor_attributes.png

Attributes in the editor (simple view) [1]

Allowed child-elements und their attributes

Element Attribute
Structure Name Content Description
notificationcenterbadge
  • layout
colspan decimal Amount of coloumns this widget sould be wide.
colspan-m decimal Overrules the amount of coloumns on a medium screen.
colspan-s decimal Overrules the amount of coloumns on a small screen.
rowspan decimal Amount of rows this widget should be high.
x string Horizontal position of the widget for 2D pages.
x-s string Horizontal position of the widget for 2D pages on a small screen.
x-m string Horizontal position of the widget for 2D pages on a medium screen.
y string Vertical position of the widget for 2D pages.
y-s string Vertical position of the widget for 2D pages on a small screen.
y-m string Vertical position of the widget for 2D pages on a medium screen.
z string Reserved for future use.
width string Width for the widget for 2D pages.
width-s string Width for the widget for 2D pages on a small screen.
width-m string Width for the widget for 2D pages on a medium screen.
scale true or false Enable/Disable scaling layout values relative to backdrop on 2d pages (default: true).
scale-s true or false Enable/Disable scaling layout values relative to backdrop on 2d pages on a small screen (default: true).
scale-m true or false Enable/Disable scaling layout values relative to backdrop on 2d pages on a medium screen (default: true).
Element Attribute
Structure Name Content Description
notificationcenterbadge
  • label
  • icon
name string  
type string  
flavour string Selection of a display variant. See also Flavour.
color string  
styling string Change the color of the dispayed value depending on its value. See also Styling
class string Add this value to the CSS class so that it can be formated by a user provided style sheet.
notificationcenterbadge
  • label
    • #text
  string Text to display a label for the widget.
../../../_images/en_config_widgets_notificationcenterbadge_index_editor_elements.png

Elements in the editor

Examples

It is possible to manually edit the visu_config.xml and add an entry for the NotificationCenterBadge widget.

Caution

Make sure that you only use UTF-8 encoded characters by settings the encoding in your XML-editor to UTF-8 mode!

<notificationcenterbadge>
 <layout colspan="0"/>
</notificationcenterbadge>

Footnotes

[1]The simple view might not show everything. To see all elements/attributes use the expert view.