Create a view and add modules (v2 beta)

Suggest Edits

A view is a data dashboard for your device. A view contains one or more modules. Each module is a data visualization for one or more streams from your device.

This guide will teach you how to create an observability view with and configure modules to visualize your device data.

Step 1: Create a view

Navigate to the device for which you want to create a view.
In the upper-right corner, click the plus (+) button >> Dashboard (v2 Beta) to create a new view.

View-level settings

You can configure settings for your view, which will apply to all modules in that view.

📘
If you apply both view-level settings and module-level settings, the module settings will override the view settings for that particular module.
For more information, see the following section.

View setting	Description
Name	Name for your view. This name will appear in the device header.
Group query scope	Only applicable for group views. Sets the data scope for the view. Current device data only will only show data from devices which are currently in the group. All device data will show all data with the group tag applied, regardless of whether the device which generated the data is currently in the group. (Data from devices which were previously in the group, but presently are not, will be shown.)
Show Control Bar	If ON, the end user will be able to use the control bar to interact with the view, through either a timeline or date picker. If OFF, the end user will only be able to see data from the time range you specify here (unless you override view settings with module-specific settings).
Control bar: Timeline	The end user will be able to navigate data via a timeline, seek to past data points or events, play back data, and control playback speed.
Control bar: Date range	The end user will be able to navigate data via a static date picker with a defined start and end time.

Historical data view setting	Description
Time Span	If specified, all modules displaying Historical data will only present data within the specified Time Span. If Control bar is ON and set to Timeline, this setting will always be set to Sync with timeline. If you also specify a Time Span at the module level, this setting will be overriden for that module.

Aggregate data view setting	Description
Lookback range	If selected, aggregate modules will display from the Lookback range (i.e., `1W` will display the last seven days' worth of data, with the end date always being the present day). If you want to specify a time range for this view which does not end at the present time, use the Start date and End date controls. If you also specify a Lookback range at the module-level, this setting will be overriden for that module.
Start date	Start date for your Aggregate data query. If you also specify a Start date at the module level, this setting will be overriden for that module.
End date	End date for your Aggregate data query. If you also specify a End date at the module level, this setting will be overriden for that module.

Step 2: Add modules

Once you've created a view, you will populate it with modules. Each module is a data visualization from one or more streams.

In the upper-left corner, click Add (+) module.
Select your visualization:

The following modules are available:

Module	Description	Data mode	Valid data types
State monitor	View state of bits in a bitset.	Historical	Bitset
Readout	Display a single numeric value.	Historical, aggregate	Bitset, numeric, text
Line chart	Chart boolean and numeric data as a line.	Historical, aggregate	Bitset, numeric
Scatter chart	Chart boolean and numeric data as individual datapoints.	Aggregate	Bitset, numeric
Bar chart	Chart boolean and numeric data as a bar.	Aggregate	Bitset, numeric
Map	Display location data on a map.	Historical	Location
Donut chart	Display ratios of values.	Aggregate	Bitset, numeric
Log table	Display a table of values.	Historical, aggregate	Bitset, JSON, numeric, text
Video	Display real-time video or play back historical encoded video data.	Historical, real-time	Video
3D Scene	Display a 3D rendering of your robot with localization, odometry, and point cloud data. For more information, see 3D Scene module.	Historical, real-time (each layer configured separately)	Location, occupancy, point cloud
Iframe	Embed an Iframe element.	N/A	URL
Static image	Display a static image file by providing a URL to the image.	N/A	URL
Image	Display a non-encoded image stream.	Historical	Image

Select a data source. You can select multiple data sources and display them in a single module.

Module-level settings

You can configure each module's time range and data presentation independently. If you configure the time range at both the view level and the module level, individual module settings will override view settings for that module. This allows you to create a view which presents short-term and long-term data from various sources side by side.

Historical module settings

Module setting	Usage
Time span	Sync with view will defer to the View setting for this module's time span. If you specify a Time span, this module will only present data in this time span, regardless of the view-level setting for Time span. If your view has a control bar, changing the time span on the control bar will not affect this module.

Aggregate module settings

Module setting	Usage
Sync with view	If ON, this module will defer to the View setting to set the time span. If OFF, you'll specify a Time span. This module will only present data in this time span, regardless of the view-level setting for Time span. If your view has a control bar, changing the time span on the control bar will not affect this module.
Fill date gaps	If ON, the x-axis of your visualization will show the entire time interval selected, whether data is present or not. If OFF, time intervals in your selection without data points will not be included in your visualization.

Create a view and add modules (v2 beta)

Step 1: Create a view

View-level settings

📘

Step 2: Add modules

Module-level settings

Historical module settings

Aggregate module settings

See also

👋