Skip to main content

Widget Configuration*

*We're still working on it!

Overview​

With widgets you can display any data you want in the dashboard. The widget library let you choose a widget type, each widget has its own behavior.

Basic Widget Structure​

To configure a widget, there's two main section: Resources and Design.

Resources​

At resources, you can configure queries to fetch data. Choose the resource you want and create a query. The query result in a list of items.

widget-edition-example-data-found

Note

Widgets expectes a list resulted from configurable queries. If the data is in the correct format expected by the widget, it will display the value. If not, you will need to refine the data queried. You can find under the second section Design.

Design​

At design, you can refine the result from the resource queries and customize the widget appearance.

Refine Data​

query-path

Appearance Customization​

Widgets share a base structure, everything presented in Header, Body and Footer can be customized. The specific sections though are specific for the widget type chosen.

All widgets types can display resources such as:

  • Data Points
  • Objects
  • Devices & Entities
  • Users

widget-edit-mode

Specific Widget Structures​

Display​

  • Type: Single value
  • Expected input: Data Point, Object, Text or Number (e.g. [{"variable": "bat","value": "20", "time": "2025-03-25T21:03:07.550Z"}] ["100"] or [100]).
  • Supported input types: Text or Number

Card​

  • Type: Single value
  • Expected input: Data Point, Object, Text or Number (e.g. [{"variable": "bat","value": "20", "time": "2025-03-25T21:03:07.550Z"}] ["100"] or [100]).
  • Supported input types: Text or Number

Dial​

  • Type: Single value
  • Expected input: Data Point, Object, or Number (e.g. [{"variable": "bat","value": 20, "time": "2025-03-25T21:03:07.550Z"}] ["100"] or [100]).
  • Supported input types: Number

Chart​

  • Type: Multiple values
  • Expected input: Data Point (e.g. [{"variable": "bat","value": 20, "time": "2025-03-25T21:03:07.550Z"},{"variable": "bat","value": 21, "time": "2025-03-25T21:03:07.550Z"}...]).
  • Supported input types: Number

Table​

  • Type: Multiple values
  • Expected input: Data Point, Object, String or Number (e.g. [{"variable": "bat","value": 20, "time": "2025-03-25T21:03:07.550Z"},{"variable": "bat","value": 21, "time": "2025-03-25T21:03:07.550Z"}...] or [100]).
  • Supported input types: Text or Number

Forms​

Note

Only one value (single value widget expects only one to be display. if a list of mutiple values is resulted, it will display the last item.)

Examples​