Soracom Lagoon

Panels

Panels are the building blocks of Lagoon dashboards which allow you to parse device data and generate various types of visualizations. Lagoon supports a wide number of panels useful for various kinds of data, such as time series graphs, maps, and dynamic images.

Panel Types

Static Panels

• Clock Panel - A basic clock panel.
• Text Panel - A basic static content panel for text, markdown, or HTML content.

Data Panels

• Singlestat Panel - A panel that displays a single value, configurable as a gauge or sparkline.
• Table Panel - A panel that displays data in rows and columns.
• Graph Panel - A time series panel that plots one or more data series, configurable as a line, area, or bar chart.
• Heatmap Panel - A time series panel that aggregates data points in order to generate a heatmap.
• Image Panel - A panel that displays a static image, which can be overlayed with icons or other images that change according to data values.
• Dynamic Image Panel - A panel that dynamically displays images as they are captured from a device.
• Map Panel - A tile map panel that plots latitude and longitude data, with each coordinate configurable as icons or images that change according to data values, or connected with lines to visualize a geographical time series.
• Worldmap Panel - A tile map panel that overlays a data series based on latitude and longitude coordinates, with each series aggregation configurable as a current, min, max, average, or total value across a time series.

  The Worldmap Panel has been deprecated in favor of the Map Panel.

Organizational Panels

• Row Panel - A simple divider used to group panels together in order to quickly show and hide multiple panels.
• Dashboard List Panel - A panel that lists dashboards, allowing you to quickly jump from one dashboard to another.
• Alert List Panel - A panel that lists alerts and their status.

Creating a Panel

1. Login to the Lagoon Console for your region, and open a dashboard.

2. Click the Add panel button at the top of the dashboard.

3. Select the type of panel you want to add.

   https://g.lagoon.soracom.io

   

4. Click the Panel Title, then select Edit to configure the panel.

   https://g.lagoon.soracom.io

   

Importing a Panel

1. Login to the Lagoon Console for your region, and open a dashboard.

2. Click the Add panel button at the top of the dashboard.

3. Select the type of panel you want to import.

   https://g.lagoon.soracom.io

   

4. Click the Panel Title, then hover over More... and select Panel JSON.

   https://g.lagoon.soracom.io

   

5. Paste the JSON data of the panel you want to import, then click the Update button.

   

Panel Settings

Each Lagoon panel contains common panel settings, such as Title and Description. The following settings can be configured for each panel.

General

Info

• Title - The title displayed at the top of the panel.
• Description - A brief description of the panel. When configured, a icon will appear next to the title, which will show the description when clicked.
• Transparent - Enable or disable the background and border of the panel.

Drilldown / detail link - Allows you to add arbitrary links to the Description of the panel, such as a link to a website containing related information, or to another dashboard.

Repeat - When dashboard Variables are used, this setting can be used to create multiple instances of the panel for each variable.

Metrics

For Data Panels, the Metrics settings are used to specify what data is used in the panel. Depending on panel type, additional settings may be available for controlling how the data is formatted, aggregated, or parsed with respect to the panel type.

When adding metrics, the following options are available:

• Air - Query Harvest for data from a specific Air for Cellular subscriber.
• Sigfox - Query Harvest for data from a specific Sigfox device.
• Device - Query Harvest for data from a specific SORACOM Inventory device.
• Group - Query Harvest for data from multiple devices that belong to a specific group.

Additional query parameters vary depending on the panel type. Refer to the documentation for each specific panel type for more information.

Time Range

For Data Panels, the Time Range settings are used to adjust the range of data to use when generating the panel.

Override relative time - When the dashboard Time picker is set to a relative time range, this setting will override the dashboard time range, and instead use data from the time range specified in this setting. This setting has no effect when the dashboard time range is set to a custom absolute time range.

Add time shift - Shift the time range window by the amount specified, relative to the dashboard time range. When set, this setting will always apply to the panel regardless of whether the dashboard time range is set to a relative time range or an absolute time range.

Hide time override info - When the panel is using a time range that differs from the dashboard time range, info is displayed. This option supresses the info.

Sharing a Panel

When using Lagoon, you can create a URL link for a panel, including a specific time range, in order to share the panel with your team or other collaborators.

1. Login to the Lagoon Console for your region, and open a dashboard.

2. Find the panel that you want to share.

3. Click the Panel Title, then select Share.

   https://g.lagoon.soracom.io

   

4. Select your link preferences, then click the Copy button to copy the link.

   

   • Current time range - Include the current time range in the link, so that users are shown the current data.
   • Template variables - Include template variables in the link.
   • Theme - Specify the dashboard theme to show.

Deleting a Panel

1. Click the Panel Title, then select Remove.

   https://g.lagoon.soracom.io

   

2. Click the Remove button to confirm.