Platform Documentation

A dashboard is a grid of widgets that shows device data and provides selected device controls. Widgets update automatically, and users with the right permissions can move, resize, edit, pin, or delete them. This page explains the dashboard grid, the settings shared by all widgets, and the options for each widget type.

Where Dashboards Live

Dashboards can be account-wide or belong to an application. An application dashboard uses that application’s devices, attributes, maps, and alerts. The Dashboards page opens dashboards in tabs so you can switch between them without leaving the page.

Create, rename, and delete

• 1
  Create a dashboard and enter a Dashboard Title. Add a description if the dashboard’s purpose is not clear from the title.
• 2
  Use the dashboard menu to edit its title or description. You can also double-click the tab name to rename it, or double-click a visible dashboard description to edit it in place.
• 3
  Use Duplicate to copy the dashboard and its widgets. Use Delete to remove the dashboard and its widgets after confirmation. Dashboard deletion cannot be undone. The widget deletion toast restores only an individual widget.

Tabs: keep several dashboards open at once

• Use the + button to open a dashboard that is not on the tab bar, or to create a new dashboard.
• Use the pin button, or drag a tab across the pinned divider, to pin or unpin it. Pinned tabs stay at the start of the bar; unpinned tabs follow recent use.
• Close a tab to hide it from the bar. Closing a tab does not delete the dashboard.
• Tabs that do not fit move into More dashboards. Select one there to open it.

The Grid: Adding, Arranging, and Saving

Dashboards use a responsive grid. On a desktop, widgets use a 12-column layout. On a phone, they stack in one column.

Layout behavior

Saving, autosave, and history

• Layout changes save automatically. The status beside the toolbar shows when a save is in progress, succeeds, or fails.
• Refresh Dashboard requests current data for every data-backed widget.
• Undo and Redo cover widget moves, resizes, additions, deletions, spacer changes, and Auto Align. History holds the latest 20 actions for the active dashboard and resets when you switch dashboards.
• Keyboard shortcuts also work: Ctrl or Command + Z for undo, and Ctrl or Command + Shift + Z or Ctrl + Y for redo. They do not override typing inside a field.
• Full screen is useful for wall displays. If several dashboard tabs are open, use the previous and next controls to move between them.

Widget Controls: Hover to Reveal

On devices with a pointer, widget controls appear when you hover over the widget. On touch screens, tap the More button to show them.

The expanded view

• Charts and XY-Charts add a date-range picker, Max points, and CSV download. Max points accepts 1 to 1,440. These changes affect the expanded view, not the saved widget configuration. The CSV contains the data shown in the expanded chart.
• An XY-Chart downloads one CSV per X and Y pair. Each file has Timestamp, X Value, and Y Value columns.
• XY-Charts also support scroll-wheel zoom inside the plot.
• Gauge and Label widgets let you resize the value with the scroll wheel.
• Image Map, Data Push, Device List, and Alert List widgets do not have an expanded view.

Live Data

Data widgets request their current values when they load and continue to refresh while the dashboard is open. If the live connection is interrupted, the dashboard reconnects and requests the data again.

• Charts request readings for their configured time range.
• Single Status and Multi Status widgets request the latest value for each attribute.
• Device List updates connection changes as they arrive and periodically refreshes other device details.
• Alert List updates when alert definitions or event counts change.
• Data Push sends commands and does not subscribe to device readings.

PDF Reports

Export as PDF creates a report from supported data widgets on the active dashboard. Data Push, Device List, and Alert List widgets are not offered for PDF export.

• Orientation: Portrait or Landscape.
• Detail level: Summary only, or Include displayed rows. Row export includes at most 200 rows per widget and reports how many older rows were omitted.
• Widgets to include: select at least one supported widget before exporting.

The report cover identifies the dashboard, application when applicable, account, author, generation time, and timezone. Each widget section can include its visual, displayed range, aggregation interval, and relevant statistics such as current value, minimum, maximum, mean, count, and last updated time. Gauge sections also list the style, range, and zones.

Building a Widget: What Every Widget Shares

The widget editor places settings on the left and a preview on the right. Start with the common fields below, then use the Widget Catalog for type-specific options.

• 1
  Confirm the Dashboard, enter a required Widget Title, and add an optional description.
• 2
  Choose the widget type and, where available, a style. Device List and Alert List have no style selector.
• 3
  Set the type-specific options and select the required attributes, devices, alerts, or Data Push destination.
• 4
  Check the preview, then save the widget.

Dashboard

The Dashboard field shows where the widget will be saved. Select the pencil beside the field to unlock it and choose another dashboard. Some creation flows fix the destination and hide this field.

Widget Title, with tags

A widget title is required. Select Insert a tag to add a token such as {{tag.room}}. The dashboard replaces the token with the tag’s current value.

• Resolves to previews the completed title.
• A warning appears if a referenced tag cannot be found.
• Insertable tag keys use letters, numbers, hyphens, and underscores. Other keys are disabled in the picker.

Description

The optional description can contain up to 250 characters. It appears below the widget title and is shortened when space is limited. Point to it to see the full text.

Preview, with sample data

Before the widget has enough real configuration, the preview uses sample data or a simple placeholder. After you select the required source, the preview uses its available data. Preview controls for Data Push never send a real command.

Attributes and their options

Charts and status widgets use one or more attribute rows. Data Push, Device List, and Alert List use their own selectors instead.

Calculations

Calculation-capable widgets can show a computed value instead of a raw attribute. Use the simple calculation control to add, subtract, multiply, or divide two attributes. Use Advanced calculation for formulas, scaling, and unit conversions. A warning on the widget indicates a calculation problem. See the Widget Calculations page for the formula language.

The Widget Catalog

The editor offers seven widget types. Available styles and options depend on the dashboard scope, permissions, and enabled map services.

Chart: Line, Bar, Area, Scatter

These charts plot one or more numeric attributes over time. Use them to show trends or compare devices.

Chart: Fan (Forecast)

A Fan chart extends one numeric attribute’s recent history with a forecast line and shaded confidence bands. Use it to see the likely direction of a changing value, while treating the forecast as an estimate rather than a measurement.

Chart: Distribution

Distribution charts compare the spread of values rather than their order over time. Box plot mode shows quartiles, median, whiskers, and optional outliers. Violin-like mode shows a smoothed summary of the same distribution.

Chart: Tracking Map

A Tracking Map plots reported locations on Google Maps and can draw a trail for each selected device. It can show current position, time, speed, heading, and coordinates. This style appears only when Google Maps is available and supports up to eight location series.

XY-Chart: Line, Scatter

An XY-Chart plots one measurement against another. Scatter shows separate paired points; Line connects them in time order. Use it to compare values such as temperature and humidity or power and occupancy.

Single Status: Gauge

A Gauge compares one numeric attribute’s latest value with a minimum and maximum. Choose from Classic, Progress arc, Numbered, Semicircle, Speedometer, Segmented, Linear, and Tank styles.

Zones add named, colored ranges such as Safe, Warning, and Danger to the gauge face.

• Each zone needs a name of 1 to 60 characters, a minimum, a maximum, and a color.
• Zone ranges must remain inside the gauge range.
• The preset creates Idle, Safe, Optimal, and Danger zones that you can edit.
• PDF reports include configured gauge zones.

Advanced (element size & position)

Gauge, Fan, and Distribution widgets include an advanced geometry section. Available controls depend on the selected style. They can adjust gauge radius and thickness, tick count, linear or tank dimensions, chart margins, legend position, forecast line width, box width, and outlier size. Each field enforces a safe range, and Reset to defaults removes the custom geometry settings.

Single Status: Label

A Label shows the latest value and unit as text. It works with numeric, text, and boolean attributes. For numeric values, choose rounding and decimal places; use the attribute color to style the value.

Multi Status: Table

A Table arranges the latest values in a labeled grid. Use it to place related metrics by room, device, or category.

Multi Status: Map

A Map places device pins on an uploaded floor plan or site image. It can also mirror an application Map or use a System’s placed members and child Systems.

Multi Status: Progress

Progress widgets show each attribute moving through a time or numeric range. Use them for progress toward a target, capacity, or scheduled interval.

• Time Scale uses start and end times and can use a fixed 24-hour axis.
• Numeric Scale uses start and end numbers.
• Each attribute can have its own task name, target value, and range.

Multi Status: Pie and Doughnut

Pie and Doughnut widgets compare the latest values as parts of a total. Each attribute becomes one slice.

• Text color styles slice labels.
• Sort by value orders slices from largest to smallest.
• Show labels outside moves labels beyond the chart edge.
• Each attribute has its own color and optional data label.

Data Push: Form, Button

Data Push sends a command or setting to a device endpoint from the dashboard. It does not show device readings.

Device List

Device List shows device names and connection status in a card or table. Select all devices in the current scope or choose up to 100 devices.

• Connection changes update as they arrive; other device details refresh periodically.
• Select a device name to open that device in a new tab.

Alert List

Alert List shows alert names, status, severity, and event counts. It is available only on application dashboards and requires alert view permission. Select all alerts or choose up to 20. A single alert uses a card; several alerts use a list.

• Event counts update when alert events change.
• Disabled alerts are marked in the list.
• If a selected alert was deleted, the editor marks it as Deleted and blocks saving until you remove it.
• A viewer without alert view permission sees a permission message instead of alert data.

Plan Limits

Billing shows the dashboard allowance for your plan. The editor also enforces these structural limits: