Image Overlay Node

Input

Requirement

Comments

Areas - Location

Mandatory

This is the location of the field that is being displayed on the uploaded image

Areas - Data Field Name

Mandatory

This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.

Section: General

This section contains basic configuration elements required for any Image Overlay implementation

Field

Requirement

Comments

Widget Name

Mandatory

Enter a name for this node.

This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.

Widget Header

Mandatory

Ability to show or hide the widget’s header.

Device Name

Optional

Select this option if the device name should be shown to the dashboard viewer.

Background Color

Optional

Ability to select desired colors as the image overlay’s background color.

Edit Overlay

Mandatory

Ability to upload an image, add objects and textbox. Every object and textbox has their own unique SVG_ID.

The SVG_ID will be shown on the right hand side of the edit overlay pop up when an object is created.

Widget Subtitle

Optional

Enter a subtitle for this node.

This provides additional information to the end user regarding the information displayed on this node.

Decimal Precision

Optional

Enter a numerical value to set the decimal precision of the information displayed.

Section: Areas

This section is where the user can configure the list of fields to be displayed on the dashboard and the location of the field on the uploaded image.

Field

Requirement

Comments

Area Name

Optional

Enter a name to be shown on the tooltip message when hovered over the object or text box that is overlaid on the image.

Note: There should not be any spacing in this field.

Text

Optional

Select an option from the dropdown menu:

• Text
• Object

Input Data Field

Optional

This is the field name within the incoming JSON payload that contains the data to be displayed on the objects overlaid on the image.

SVG ID

Mandatory

A unique ID that allows users to tie a value to an object that is overlaid on the image. 

Decimals

Optional

Enter the number of decimal places to display on the dashboard.

Pre Symbol

Optional

Enter a symbol that will be displayed at the beginning of the value.

Post Symbol

Optional

Enter a symbol that will be displayed at the end of the value.

Thousands Comma

Optional

Select an option from the dropdown menu:

• Commas - There will be comma separators at the thousand mark.
• No Commas - There will be no comma separators at the thousand mark.

Dashboard to Link to

Optional

Drop down list to select a configured dashboard to link to.

Section: Tooltip Info

Field

Requirement

Comments

Show Tooltip

Optional

When checked, it allows users to display their tooltip text on the widget.

Tooltip Text

Optional

This section only exists when “Show Tooltip” is checked.

Users are able to write any tooltip message they desire which will be display on the widget.

Section: Group by Device Label

Field

Requirement

Comments

Device label name

Mandatory

There are no labels available in this box until you have saved at least one in the Device Labels section of the Workspace. 

Select a Label to use to filter devices.

Grouped

Mandatory

Select a method for grouping the widget on the dashboard from the dropdown:

No Grouping (widget per device): one widget will appear for each device

Group by device label value (Widget per label value): One widget will appear for each value of a label. For example, if the Label is ‘Color’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Color Label equal to “Green” and one with devices with Color Label equal to “Gold”

Group by device label name (One widget): Only one widget will be displayed and this will contain data from all devices.