Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin


scrollbar


Table of Contents

General

The dashboard display - available since Delft-FEWS 2019.02 - is used to view several displays side-by-side. The functionality is limited to time series plots (selected via the data viewer), display groups, grid (or spatial) displays, and buttons panel displays. For example, it can be used to view both a precipitation and a temperature grid plot side-by-side, synchronizing the time sliders. Or, as another example, it could be used to see display groups together with a spatial display.

When a time series plot is added to a dashboard, the settings of the visibility dialog is also preserved. Thus, if for example a time series is made invisible on the time series display, it will remain invisible on the dashboard panel as well.

All users can create and modify their own dashboards, which will be stored in the user settings. Alternatively, a configurator can configure "predefined" dashboards which will be the same for all users. An example of a dashboard display is shown below.



Image Added

Creating and modifying a Dashboard Display

...

After entering a title and confirming, a new (empty) dashboard panel will be opened and it will be added to the dashboards menu.

Adding

...

Spatial Display Frames

To add a new Spatial Display frame to a dashboard, navigate to a Spatial Display and use the "Add to Dashboard" button found in the toolbar. Clicking this button will add a copy of the spatial display as a frame to the current open user-defined dashboard. If several user-defined dashboards are open, you will be prompted to choose a dashboard to which it will be added. If no user-defined dashboards are open, you will be asked to open a dashboard first. New frames can only be added to user-defined dashboards.

...

While it is possible to later modify the contents of the frame, for example, to select a different grid plot or change the accumulation, it is advisable to set these as you want them to be before adding a copy of the spatial display to the dashboard.

Adding Time Series Dialog Frames

It is possible to add frames from the Time Series Dialog to a dashboard, the graphs can be either based on Display Groups (since 2020.02) or the Data Viewer selection (since 2021.02).

In order to do this the "Add to dashboard button" on the top left of the Time Series Dialog can be clicked.

For this to work a dashboard already needs to be created and opened.

Image Added

Modifying Frame Contents

Spatial Display frames will only show the map and plot. To gain access to the plot tree, accumulation slider and legend, a frame must be maximized. This can be done by clicking the maximize button on the frame, or double-clicking its title.

...

Arranging the Frames

Dashboard frames can be resized as by dragging the border as you usually woulddragged and resized using the header and borders in fixed steps ('shift + space' toggles fixed step and free dragging and resizing). The drop-down menu of the the  dashboard button also offers three options to aid in arranging the dashboard frames:

...

When dashboards are hidden, the dashboard-button in the grid-display disappears as well.


Dashboard Management Panel

Since Delft-FEWS 2020.02, Dashboard management panel is added to the Dashboards menu. Through the dashboard management panel, it is possible to manage public and private dashboards. On the left panel, all public dashboards of other users as well as the public dashboards of the current user are visible. The Refresh button could be used to update the list of public dashboards. If the current user wishes to copy a public dashboard of another user to a private dashboard of his/her own, or if the current user wishes to turn one of his/her own public dashboards to a private one, the button with the right arrow (in the figure below) could be used.

In addition, all user defined dashboards are private by default, and stored in user_settings.ini. However, the user can choose to set the private dashboards to public, using the button with the left arrow (in the figure below). This way, users can share dashboards with each other. To identify the visibility of the dashboards, a flag called "public" is used in the dashboard sections of the user_settings.ini.

Dashboard management panel also enables the current user to rename or delete a private dashboard. Especial characters such as "[( : , )]" are not allowed when renaming a dashboard.

Before the Dashboard management panel is opened, and after the OK button is pressed, the current state of user_settings.ini is stored in the data store for the purpose of synchronizing the dashboard states.


Dashboard Management PanelImage Added

Using a Dashboard Display

...

Time Slider Synchronization

The  synchronize synchronize button in the bottom toolbar controls whether the times of the frames should be synchronized. When this button is on, changing the selected time on the time slider, or starting the animation through the play button, will also update the times of the other frames. This allows the user to quickly compare the same time steps in different plots. When this button is on, pressing the Apply button in set time dialog Image Added makes all other dashboard frames to have the same period.  (In a given frame, using the scroll wheel, the user can zoom in and out, and thereby change the period of a given frame, which can be applied to the other frames using the sync button and set time dialog.)

User-defined vs. Predefined Dashboard Displays

While it is possible for users to create and customize their own dashboards, it can also be advisable to provide several predefined dashboards through the configuration so users don't have to construct common dashboards themselves. While user-defined dashboards are stored in the user settings, predefined dashboards are configured through a dashboards.ini file, which is a root config file. To share the preconfigured dashboards with other operator clients (OCs), dashboards.ini needs to be included in the otherRootConfigFiles element of the clientConfig file. An example is provided below. For further information, please refer to the clientConfig Wiki page.

        <otherRootConfigFiles>
...

               <name>dashboards.ini</name>
        </otherRootConfigFiles>


Predefined dashboards will be shown in a separate section of the dashboards menu than user-defined dashboards. In the example below there is one predefined dashboard present in the system "BE Creation", and one user-defined dashboard called "My Custom Dashboard".

...

There are several differences in between user-defined dashboards and predefined dashboards:


user-definedpredefined
sharinguser specific,
can't be shared between users
shared through userSettingsshared between all users and the same for all users
creatorcreated by a usercreated / configured by a configurator
customizationcan be customized by the user, i.e., frames can be added / removed, frame titles can be changed, frames can be deletedcan not be customized, i.e., no new frames can be added, if a frame is closed the change won't persist when reopening the dashboard, frame titles can't be changed
storagestored in the user_settings.ini filestored in the dashboards.ini file

Configuring a Predefined Dashboard

...