Caution

This is the documentation for the current development branch of the CometVisu. It is possible that some of the described features are not yet available in the current release.

Also there might be lots of errors in this documentation as some parts of the content have been translated by an online translation service.

The NavBar widget

Author: Christian Mayer
Available since: 2012

Description

With the widget navbar, you can add a navigation menu to the entire visu. The menu can be displayed on a page (top, bottom, left, right).

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: Basics.

The behaviour and appearance of the NavBar 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 be omitted.

The dynamic attribute allows to dynamically show and hide the navbar. The show and hide is only implemented for the left navbar and requires a touch capable device. To show you must swipe from the left end of the screen horizontal to the middle, to hide you must swipe to the left.

dynamic

Mobile device

Big screen

empty

Navbar can be shown and hidden. After start it is hidden.

Navbar is always shown.

true

Navbar can be shown and hidden. After start it is hidden.

Navbar can be shown and hidden. After start it is shown.

false

Navbar is always shown.

Navbar is always shown.

Allowed attributes in the NavBar-element

Element

Attribute

Name

Content

Description

navbar

name

string

Name/title of the navigation bar

position

top, left, right or bottom

Position of the navigation bar on the page

dynamic

true or false

Set dynamic behaviour, use automatic when not set

width

string

scope

decimal

Allowed child-elements and their attributes

All widgets are allowed in the page widget.

Examples

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

Caution

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