Dashboard Features

Owned by Karen Hogan (Unlicensed)
Last updated: Aug 30, 2023 by Adam Voakes
4 min read

The buttons in the top right of the screen allow further control of the dashboard. 

Manage layout  – This icon will only be visible when a change has been made to the active category and is linked to user permissions. If you can’t see this icon, even after making a change to a category it means that your System Administrator has not given you the permission.

Reset to the default view of the category  - resets all category filters to the default values.

Category Objects - this icon may not be visible on all categories. It will only be there if your System Administrator has enabled this. This icon will allow you to filter all charts on the same category using the same values.

Refresh Category  – refreshes all elements on the page.

More Options  - opens dashboard tools, shown below. The options that you can see in this list are linked to your user account.

Send the dashboard

The ‘Send this dashboard’ option sends a URL, which allows someone (providing they have access) to directly access the filtered category we are viewing.

This will copy the full URL from your web browser and open it in your email software (assuming you’re logged in to an email application). If the recipient has access to the Dashboard in general, and this category specifically, then they will be able to see the charts exactly as you have filtered them.

This option can be disabled and hidden from all users by unticking the ENABLE_OPENING_DASHBOARD_AS_TAB variable, which can be found in Dashboard Configuration>Settings>Global Variables.

This will cycle the interface through the different categories, and you can set the interval between cycles. This is used when the dashboard is viewed on a TV or large monitor to provide a communal view.

You can decide on the interval (how often the dashboard refreshes) and to either:

Play dashboard (Cycle through all categories available to this user) OR Play this category (Refresh only the visible category).

If you use Carousel, you'll see an extra icon at the top-right of the dashboard. This acts like a timer, the circle will slowly rotate and complete based on the time setting you’re using. For example, if you set the Carousel at 10 seconds, the icon will have completed the circle in 10 seconds.

You can stop the Carousel at any time by clicking ‘More Options’ at the top-right of the dashboard and selecting ‘Stop Carousel’.

 

Setting the minimum interval

Introduced in our August 23 release, the lowest value permitted in the interval field of the carousel is dictated by the value of the Global Variable CAROUSEL_MINIMUM_INTERVAL. This setting, which is 1 by default, can be changed globally in the Global Variables tab of the Configuration Panel and overridden on a per-user basis by creating a User Variable of the same name. Whilst a value lower than this is in the interval field the ‘Play’ button will be disabled.

Username?

Here, we can see who we are logged into the dashboard as.

Clicking on this name will provide information about your privileges.

The left-hand side of the screen will show the role that has been assigned to you and the last time you logged into the system. The User Privileges section shows what you have access to.

You may also be able to change your password from this screen and some of your user account details such as the Theme and Email address (if you have the correct privileges).

 About

Clicking on this item will open a screen which tells you what version of the dashboard is currently installed.

Help

Help (if enabled) provides a link, by default, to pi Documentation for all new, clean installs of the dashboard.

Logout

Logout will log you out of the pi interface.