Dashboards - Developer Documentation
Skip to content

Dashboards

"Dashboards" provide you with a customized visualization of your data by using a set of widgets. Widgets can display maps, images, graphs, tables and other graphic representations of data.

IoT Extension comes with a number of preset widgets, see Widgets Collection for details. You can also develop your own widgets and add them to your IoT Extension account.

Creating a dashboard

Select the "Group" option from the left navigator and choose a displayed group from the display area.

Click the "Plus" button in the top bar and from the context menu select "New dashboard".

Create dashboard

In the "Dashboard" info section of the dashboard editor, provide the following information:

  • A menu label to be used as the name of the dashboard
  • The location of the dashboard in the navigator, with "10000" being ordered first and "-10000" last
  • An icon which is shown next to the dashboard name in the navigator

In the "Dashboard" layout section you can select a theme for the dashboard (one of "Light", "Dark", "Transparent" or "Branded") and a default header style for the widgets (one of "Regular", "Border", "Overlay", or "Hidden"). Moreover, you can change the default widget margin (default value is 15 px).

A preview of the selected layout settings is immediately displayed in the "Preview" section at the right to visualize your selections.

Click "Save" to create and open the dashboard.

dashboard

Once you add a dashboard, you will be able to view the "Dashboard" option in the working UI.

simulator

Adding a widget to a dashboard

If there will be no widgets on the dashboard, you will see an "Add Widget" button instead.

Add a widget

To add a widget to a dashboard, click "Add widget" in the top menu bar.

Add widget

In the upcoming dialog, select a widget type from the dropdown list. Depending on the widget type selected, additional fields and checkboxes will be displayed to be filled in or selected. For details on all widgets refer to Widgets Collection.

Click "Customize widget style" to customize the content and header style for the widget individually, similar to specifying the general layout in the dashboard editor.

Click "Save" to add the widget to the dashboard.

Modifying widgets on a dashboard

Widgets may be rearranged on the dashboard. By dragging and dropping you can move the widget to another position.

By dragging the arrows on the bottom right corner of a widget, you can resize it.

To edit the properties of a widget on a dashboard, click the cogwheel icon at the top right corner of the widget and from the context menu select "Edit".

To delete a widget from a dashboard, click the cogwheel icon at the top right corner of the widget and from the context menu select "Remove".

Widgets can only be modified, if the dashboard is unlocked. To lock/unlock a dashboard, use the slider with the lock icon on the top menu bar.

Modify widget

Note

On touch devices like smartphones or tablets some functions may not be supported.

Sharing dashboards

You can create one dashboard and share it with all devices of a specific type. To do so, select the option "Apply dashboard to all devices of type [TYPE]" ([TYPE] is replaced with the type of the device that is currently selected).

Changes made to this dashboard are automatically applied to all dashboard instances.

Note

You can only add widgets and data to the dashboard for the device itself. It is not possible to add data from child devices because the structure of these devices might be different from device to device.

Editing dashboard properties

To edit a dashboard, click "Edit" in the top menu bar. The dashboard editor will open up.

Copying dashboards

To copy a dashboard from one object to another, click "More..." in the top menu bar and from the context menu select "Copy dashboard".

Next, navigate to the object you want to copy the dashboard to and from the context menu select "Paste dashboard [NAME]" to insert the dashboard.

An alternative way to copy a dashboard is to use the "dashboard per type" approach. With the "dashboard per type" approach you share the dashboard from one object with all objects of the same type.

Removing dashboards

To delete a dashboard from an object, click "More..." in the top menu bar and from the context menu select "Remove dashboard".


Last update: June 15, 2023