Skip to content

Platform

Widgets

Every dashboard widget with all its options, from charts and gauges to maps, device controls and the Source Switcher.

Reference17 min read

Every widget of a dashboard, with what it shows, when to use it and each option of its settings. Where the data comes from (device resources, Data Buckets, properties, timeframes, aggregation and transformations) is in Widget data sources.

Add or edit a widget ​

Turn on the edit mode in the dashboard toolbar and click Add Widget. The Widget Settings dialog has three tabs:

TabWhat it sets
WidgetThe common settings and the widget Type.
The widget name (for example Time Series Chart)The data source, or the device resource or property the widget controls.
Display OptionsThe options of that widget type, listed on this page.

In edit mode each widget shows Clone, Edit and Remove buttons; double-click a widget to edit it. Drag a widget to move it and drag its corner to resize it.

Widget tab of the Widget Settings dialog with the Title, Subtitle, Link To, Show Update, Show Offline, Show Fullscreen, Background and Type settings of a Time Series Chart
Widget tab of Widget Settings

Common settings ​

The Widget tab is the same for every widget type.

SettingDefaultWhat it does
TitleemptyText at the top of the widget. Optional.
SubtitleemptySmaller text below the title. Optional.
Link TononeAnother dashboard. The widget shows a button that opens it, to go from a summary to a detailed dashboard.
Show UpdateoffShows the time of the last value the widget received, next to the title.
Show OfflineNoneWith Timespan, the widget is shown muted and marked offline when it receives no data for that time. With None, a widget fed by a device resource is marked offline while its device is disconnected.
Show FullscreenoffShows a button that opens the widget full screen.
Background#ffffffBackground color of the widget. Click + to add colors by value.
TypeThe widget type, grouped in Display, Device Control and Dashboard Control.

Background colors by value ​

Click + next to Background to add a range with a Min, a Max and a color. When the widget receives a number between the minimum and the maximum of a range (both included), the background takes that color; the first matching range wins. Outside every range, the widget uses the Background color.

Use it to make a value stand out: a Tachometer of pressure that turns red above a safe limit, or a Text/Value of battery level that turns orange when it is low. The text of the widget switches between dark and light to stay readable on the color.

Tachometer of boiler pressure at 132 psi on a red background, the color of the Background range that contains the value
Background color by value

Display widgets ​

Time Series Chart ​

A line chart of one or more values over time. Use it to follow how a measure changes: the temperature of the last 24 hours, or the power of several devices side by side.

Each line is a source, with one field. To draw several fields of the same bucket, add a source for each one: Clone Source copies the selected source, so you only change the field. Add sources with Add Source and delete the selected one with Remove Source. Each source has:

FieldWhat it does
NameName of the series, shown in the legend and the tooltip. Must be unique in the widget.
ColorThe color of the series, next to the name. Each new source gets a different color.
Data SourceWhere the values come from: From Data Bucket, From Device Bucket, From Device Resource, From Device Property or Manual, and the field to draw. See Data sources.
TimeframeFor bucket sources: which time range to show. See Timeframe.
Time PeriodFor device resources and properties: how much live data to keep in the chart. See Time Period.
Aggregate and TransformFor buckets that support them: group the data in intervals and transform it. See Aggregate and Transform.
ProcessingA dashboard function applied to the values. See Processing.

Display Options:

OptionDefaultWhat it does
AxisonShows the X and Y axes.
LegendoffShows the legend with the name of each series.
Fill SplinesoffFills the area under each line.
Multiple AxesoffGives each series its own Y axis, for values with different scales (temperature and pressure).
X AxisautomaticNumber of ticks of the X axis (1 to 1000). Shown when Axis is on.
Y AxisautomaticMinimum, maximum and number of ticks (1 to 1000) of the Y axis. Leave them empty to fit the data. Shown when Axis is on.
Time Series Chart of the last 24 hours with two series, temperature and humidity of greenhouse_01, and the legend on
Time Series Chart with two series

Apex Charts ​

A chart drawn with ApexCharts: lines, areas, columns, scatter, heatmap, pie, donut, radial, radar or polar. Use it when the Time Series Chart is not enough: stacked columns of energy per day, or a pie with the share of each device.

Its sources work as in the Time Series Chart. In time charts (line, area, column, scatter, heatmap) each source is a series. In pie, donut, radial and polar charts each source is a slice with its latest value: the slice takes the name and the color of the source.

Display Options:

OptionDefaultWhat it does
Real Time UpdateonUpdates the chart as new data arrives. Off, the chart keeps the data it loaded first.
Align Time SeriesoffAligns the series on the same timestamps, adding empty points where a series has no value. It needs extra processing: turn it on only when a chart type needs it, such as stacked columns. Available with two or more sources and not in pie, donut, radial or polar charts.
Chart TemplateLineThe starting chart. Choosing a template replaces the chart options.
Show code / Preview chartSwitches between the chart preview and the code of its options.

The 17 templates are Line, Line with Labels, Line with Markers, Step Line, Area, Spline Area, Stacked Area, Column, Column Stacked, Column Stacked 100%, Scatter, Heatmap, Pie Chart, Donut, Radial, Radar and Polar.

Show code opens the options of the chart as JavaScript that assigns an ApexCharts options object to options. Edit it to change anything ApexCharts supports: colors, curves, markers, axes, annotations. The data series come from the sources, so the code does not set them. The Templates link opens the ApexCharts demos for more examples. For instance, this code draws columns with rounded corners and data labels:

js
var options = {
    chart: {
        type: 'bar'
    },
    plotOptions: {
        bar: {
            borderRadius: 4
        }
    },
    dataLabels: {
        enabled: true
    },
    xaxis: {
        type: 'datetime'
    }
};
Display Options tab of an Apex Charts widget with Real Time Update, the Spline Area chart template and the preview of the chart
Apex Charts with the Spline Area template

HTML Time Series ​

An HTML Widget that receives time series instead of single values: its sources work as in the Time Series Chart, with timeframe, aggregation and transformations. Use it to draw a custom chart or table with your own HTML and JavaScript. Its Display Options are those of the HTML Widget. The shape of its data and a table example are in HTML Widget.

HTML Time Series widget with a table of the date, temperature and humidity of the latest records of the climate bucket
HTML Time Series as a table

Donut Chart ​

A ring that fills from a minimum to a maximum, with the value in the center. Use it for values with known limits: a tank level, a battery percentage.

It has one source with one value (see Data sources), which can go through a dashboard function with Processing.

OptionDefaultWhat it does
UnitsemptyUnit shown with the value (%, °C).
Min Value0Value of the empty ring.
Max Value100Value of the full ring.
Donut Color#1E313EColor of the filled part.
Donut Chart of the greenhouse humidity at 65 %
Donut Chart

Progressbar ​

A horizontal bar that fills from a minimum to a maximum. Use it for progress or fill levels: a process completion, a tank, a disk.

It has one source with one value.

OptionDefaultWhat it does
UnitsemptyUnit shown with the value.
Min Value0Value of the empty bar.
Max Value100Value of the full bar.
IconnoneA Font Awesome class (fas fa-tachometer-alt) or the URL of an image, shown with the bar.
Icon Color#ffffffColor of a Font Awesome icon. Not shown for image URLs.
Icon Size24Height of the icon in pixels, 16 to 128.

Gauge ​

A semicircular gauge with the value in the center. Use it for a single reading with a range: speed, CPU load, noise level.

It has one source with one value.

OptionDefaultWhat it does
UnitsemptyUnit shown below the value.
Min Value0Start of the gauge.
Max Value100End of the gauge.
Text Color#1E313EColor of the value. With Gradient off, it is also the color of the gauge.
GradientonColors the gauge from green (low) through yellow to red (high).
Gauge of CPU load at 72 % on a scale from 0 to 100
Gauge

Tachometer ​

A dial with a needle, ticks and colored ranges, like a car speedometer. Use it when the reader must see at a glance whether a value is in a normal, warning or danger zone.

It has one source with one value.

OptionDefaultWhat it does
UnitsemptyUnit shown on the dial.
Range Values0 to 100Minimum and maximum of the dial. Click + to add colored ranges (min, max and color) drawn on the scale.
Plate Color#ffffffColor of the dial face.
Text Color#1E313EColor of the numbers and units.
Tick Color#000000Color of the ticks.
Major Ticks10Spacing between major ticks.
Show ValueonShows the value as a number in the dial.

To change the whole widget color when the value is dangerous, add background colors by value too.

Tachometer of line pressure at 72 psi with green, yellow and red ranges and the value shown as a number
Tachometer with color ranges

Text/Value ​

Shows a value or a text, with units, an icon and an extra text, each of them able to change with the value. Use it for any reading that needs no chart: the current temperature, a device status, the last error message.

It has one source with one value; with Manual, the fixed value is a text. The Display Options tab has three tabs.

Value:

OptionDefaultWhat it does
Decimal Places2Decimal places of numeric values.
UnitsemptyUnit shown after the value.
Units Size20pxSize of the unit, in px, em or rem.
Text Color#1E313EColor of the value. Accepts conditions (see below).
Text Size75pxSize of the value, in px, em or rem.
Text WeightLightLight, Normal or Bold.
Text AlignmentCenterLeft, Center or Right.
Open URLemptyA link opened when you click the value.

Icon:

OptionDefaultWhat it does
IconnoneA Font Awesome icon or the URL of an image. Accepts conditions.
Icon Coloroff, #1E313ETurn it on to give the icon its own color; off, Font Awesome icons use the text color and images keep theirs. Accepts conditions.
Icon Sizeoff, 75pxTurn it on to give the icon its own size; off, it uses the text size.
Icon PositionBefore ValueBefore Value, After Value, Top Right, Bottom Left or Bottom Right.
Icon Gap8pxSpace between the icon and the value.
Vertical Offset0pxMoves the icon up (negative) or down to align it with the value.

Extra Text:

OptionDefaultWhat it does
TextemptyAn additional text shown with the value. Accepts conditions.
Text Coloroff, #1E313ETurn it on to give the extra text its own color; off, it uses the main text color. Accepts conditions.
Text Size20pxSize of the extra text.
Text WeightLightLight, Normal or Bold.
Text PositionAbove ValueAbove Value, Below Value, After Value, Before Value or Replace Value. With Replace Value the text is shown instead of the value: use it with conditions to show a word for each value (0 → "Closed", 1 → "Open").

Conditions by value. The options that accept conditions let you add values for ranges: each condition has the value to use (a color, an icon or a text), a Min and a Max. When the widget value is a number greater than the minimum and lower than or equal to the maximum, the option takes the value of the first matching condition; otherwise it keeps its normal value.

Three Text/Value widgets: a temperature of 28.4 °C with a thermometer icon, a battery at 12 % with a red battery icon and a door shown as Open
Text/Value widgets with icons and text conditions

Led Indicator ​

A round light whose color depends on the value, and that can blink. Use it for states and alarms: green when a machine runs, red when it stops, blinking when it needs attention.

It has one source with one value.

OptionDefaultWhat it does
Led Size75pxDiameter of the LED, as a CSS size.
Color#4bd763Color of the LED when no range matches. Click + to add colored ranges.
Color rangesEach range has a color, a Min, a Max and a blink switch. A value between the minimum and the maximum (both included) gives the LED that color; with the switch on, the LED blinks. Click the LED to stop the blinking.

For an RGB LED with three states, add three ranges: 0 to 0 red, 1 to 1 green and 2 to 2 blue, and turn on blinking in the red one.

Three Led Indicator widgets: Pump 1 in red (value 0, blinking), Pump 2 in green (value 1) and Pump 3 in blue (value 2)
Three Led Indicators by value
Display Options tab of a Led Indicator with the LED size and three color ranges: 0 red with blink, 1 green and 2 blue
Color ranges of a Led Indicator

Clock ​

The current time of the viewer's computer, as HH:mm:ss. Use it on dashboards shown on a screen, or to compare local time with UTC. It has no data source.

OptionDefaultWhat it does
Color#1E313EColor of the digits.
UTCoffShow in UTC shows UTC instead of the local time of the browser.
Clock widget showing 12:00:00 in UTC
Clock in UTC

Google Map ​

A Google map with the location of one or more devices, live or from stored data. Use it to track vehicles, assets or sensors in the field: a GPS tracker, a Sigfox device that reports its position to a Data Bucket.

Each source is a marker. For each source, choose where the location comes from and select the Latitude and Longitude fields of the data (in degrees):

SourceWhat it shows
From Device ResourceThe position a connected device reports.
From Data Bucket or From Device BucketThe stored positions. With a Timeframe, the map draws the track of that time range.
From Device PropertyA position stored in a property.
Fixed LocationA latitude and longitude you enter.
Current LocationThe location of the viewer's browser.

Display Options:

OptionDefaultWhat it does
CenteronCenters the map on the latest position.
Zoom Level8Initial zoom, 1 (world) to 20 (buildings).
Map TypeRoadmapRoadmap, Satellite, Hybrid or Terrain.
WaypointsonShows a mark at each point of the track.
Location0, 0Latitude and longitude where the map starts, before it receives any position.
GeofencesnoneA device whose geofences the map draws.
Hide ControlsoffHides the Google Maps controls (zoom, map type, street view).

This video shows a device sending its GPS position over GPRS to a live map. It was recorded with an earlier version of the console; the map works the same way.

Watch “LinkItOne Real-Time GPS Tracking” on YouTube
Google Map widget with the track of a van in Madrid over the last 8 hours, drawn from the latitude and longitude of a Data Bucket
Google Map with the track of a vehicle
Google Map tab of Widget Settings with the fleet_gps bucket of van_01 as source and its lat and lon fields mapped to Latitude and Longitude
Latitude and Longitude fields of a Google Map source

Assets Map ​

A map with the location of many devices at once, with clusters, search and connection filters. Use it to see a whole fleet: every truck of a group, every sensor of a product.

The Assets Map tab sets Assets to Plot: All assets, From Asset Type, From Asset Group or From Asset Product, and the type, group or product to show. A device appears on the map when it has a location. See Assets.

Display Options:

OptionDefaultWhat it does
Map TypeRoadmapRoadmap, Satellite, Hybrid or Terrain.
Show OptionsoffShows controls on the map to turn its features on and off.
Show SearchonShows a search box to find a device on the map.
GeofencesonDraws the geofences of the asset type or group. Shown when you plot a type or a group.
ConnectedonShows the connected devices.
DisconnectedonShows the disconnected devices.
ClusteringonGroups nearby devices into clusters that show how many devices they hold.
Assets Map with two clusters, four assets near Madrid and three in Valencia, and the search box
Assets Map with clusters

Assets Table ​

A table with one row per device, with the columns you define, sortable and searchable, that you can export. Use it for fleet lists: name, product, connection state and time since the last connection of each device.

The Assets Table tab sets Assets to Plot as in the Assets Map. In Display Options, add Columns. Each column has:

FieldWhat it does
Column NameHeader of the column.
Field TypeHow the value is shown and sorted: String, Switch, Number, Date, Time, DateTime or TimeAgo (time since the value, such as "5 minutes ago").
Value TemplateThe value of the cell: text with fields of the device between double braces, such as {{name}}, {{asset_group}} or {{connection.active}}. Empty fields show -.

The available fields are device, name, description, type, enabled, connection, asset_type, asset_group and product. Click a header to sort, and use the search icon of a text column to filter. Export to CSV and Export to PDF download the table.

Assets Table of the madrid_plant group with the columns Name, Product, Connected as a switch and Last connection, and the Export to CSV and Export to PDF buttons
Assets Table

Image/MJPEG ​

An image from a URL: a still image that can refresh, or the MJPEG stream of an IP camera. Use it for logos and plans, or to watch a camera next to the readings of the same place.

OptionDefaultWhat it does
Image SourceMJPEG Url for a camera stream, or Still Image Url for an image.
MJPEG URLURL of the MJPEG stream.
Image URLURL of the image.
Refresh Interval0For still images, seconds between reloads of the image. 0 loads it once.

The browser of the viewer loads the URL, so it must be reachable from it and, on an HTTPS console, served over HTTPS.

Image/MJPEG widget showing the floor plan of a greenhouse, a still image loaded from a public File Storage
Image/MJPEG with a still image

HTML Widget ​

A widget made with your own HTML, CSS and JavaScript, for anything the other widgets do not show. It receives the values of its sources, and can select several fields of a source.

OptionWhat it does
HTML SourceCode Snippet to write the HTML in an editor, or File Storage to load it from a file of a File Storage.
File StorageThe file storage and the file (index.html by default), with File Storage.

How to write the code, the variables it receives and examples are in HTML Widget.

HTML Widget with the hello world template: a Hello World heading, the timestamp, the date and the latest value of the climate bucket
HTML Widget with a hello world template

Group Widget ​

A container for other widgets, with its own grid. Use it to keep related widgets together, such as the gauge and the humidity chart of one room, and move them as one block.

In edit mode, click + in the group to add a widget inside it; drag the inner widgets to arrange them. A group can hold any widget except another Group Widget, an Assets Table and a Property Table.

Info

The Group Widget has no data of its own: each widget inside it has its own source and settings.

Group Widget titled Greenhouse 01 with a temperature gauge and a Time Series Chart of humidity inside
Group Widget with a gauge and a chart

Device control widgets ​

Control widgets change a device resource or a property. They write to Device Resource (an input resource of a device; the device must be connected) or Device Property, selected in Target Value. They also show the current value: the one the resource returns, or the one stored in the property. To write the input resources in your firmware, see Arduino coding.

On/Off State ​

A switch or a button that turns a boolean on and off. Use it to control a light, a relay or a motor, and to see its current state.

OptionDefaultWhat it does
Switch StyleSwitchSwitch shows a toggle. Button shows a round button that toggles on each click. Push Button is on while you hold it pressed and off when you release it, like a doorbell.
On Color#4bd763Color of the button when the value is on.
Off Color#ff4d4fColor of the button when the value is off.
Iconfa-power-offA Font Awesome icon or the URL of an image, shown in the button.
Icon Color#ffffffColor of a Font Awesome icon.
Icon Size42Height of the icon in pixels, 16 to 48.

All the options but Switch Style apply to the Button and Push Button styles.

Two On/Off State widgets: Fan with the Switch style turned on and Lights with the Button style and a lightbulb icon in green
On/Off State with the Switch and Button styles

Slider ​

A slider that sets a number. Use it to adjust a set point: a target temperature, a threshold, the speed of a fan.

OptionDefaultWhat it does
Min Value0Lowest value of the slider.
Max Value100Highest value of the slider.
Step Width1Increment between values, from 0.01.

The slider sends the value as you move it.

Slider of the target temperature from 10 to 30 with the handle at 24
Slider

Property Button ​

A button that opens a property of a device in a form, to read and edit it from the dashboard. Use it for settings that change rarely: the configuration of a device, its calibration.

OptionDefaultWhat it does
PropertyThe device and the property to open.
Button Iconfar fa-list-ulIcon of the button.
Property dialog opened by a Property Button with the settings property of greenhouse_01: sampling interval, temperature offset and alert thresholds
Property form opened by a Property Button

See Properties.

Property Table ​

A table of device properties that you can read and edit in place. Use it to manage the same setting across devices, or the fields of several properties of one device.

Each source is a row: a From Device Property source with a device and a Property Identifier, or a Property Pattern that adds one row for each property of the device that matches it. In Display Options, add Columns:

FieldWhat it does
Column NameHeader of the column.
Field TypeText (read only), Switch, Input Text, Input Number, Slider, Color Picker, Time Picker, Property Button (opens the property, as the Property Button) or Save Button (saves the changes of the row).
Value PathThe field of the property shown in the column. Not used by Property Button and Save Button.
Min and maxFor Input Number and Slider, the limits of the value.
Button Icon / Save IconFor Property Button and Save Button, the icon of the button.

Changes stay in the row until you click its Save Button, which writes them to the property. Add a Save Button column to any table with editable columns.

Property Table with one row per climate device and the columns Name, Enabled as a switch, Threshold as a number input and a Save button
Property Table

Dashboard control widgets ​

Source Switcher ​

A drop-down that changes the device, bucket or bucket tags of the widgets of the same dashboard tab. Use it to build one dashboard for every device of the same kind: the viewer picks a device and every widget shows its data.

OptionWhat it does
Source TypeWhat the switcher changes: Device, Bucket or Bucket Tags.
Search HintText of the drop-down before a selection, such as "Select truck...".
Search IconIcon shown with the selected item. Defaults to a rocket for devices, a database for buckets and a tag for tags. Device and Bucket only.
Asset Type, Asset Group and ProductLimit the items offered to those of an asset type, an asset group or a product. Device and Bucket only.
Bucket TagFor Bucket Tags: the bucket, the tag, and the Minimum Tag Number and Maximum Tag Number of values the viewer must and can select.

What each type changes:

  • Device: the device of the device resource, device property and device bucket sources, and the device tag of Data Bucket sources.
  • Bucket: the Data Bucket of the bucket sources.
  • Bucket Tags: the selected values of that tag in the sources of that bucket, to show one or several devices, places or groups stored in a shared bucket.

Configure the widgets with one device or bucket first: the switcher starts on it and replaces it with the viewer's choice.

Source Switcher open with the devices of the env_sensor product, above the temperature, humidity and temperature chart of the selected device
Source Switcher with the devices of a product