ClearBlade IoT Enterprise and Edge

Widgets tutorial

Data types

All widgets will require you to choose an incoming data type to render.

Static: Data will be loaded as is and unchanged unless code is written to listen and force changes.

Dynamic: The datasource is added, and data gets updated as changes are made in the datasource.

Bar chart

Creating a new bar chart

1. Change the type to Bar Chart.

2. Choose your data type and datasource. The datasources in the example below were created previously and not by default.

3. Click to automatically populate the graph with generated recommendations based on the data types.

Magic Wand
Modify Chart Data
Change type
Fill in graph

The rest of the tabs are for editing the graph.

chart-toolbar.png

Bars

barstab.png

Key

Description

Example

Data Key

Property from the data object corresponding to a bar on the graph

{“dataKey”:“humidity”}

Legend Type

The icon associated with the data key

stars

Stack ID

Two bars with the same ID and value axis will be stacked

stackid.png

Name

The bar label if it’s different from the data key

hum (in the legend)=humidity

Click Add bar to add more bars. Hover over the bar data entry window to reveal the trash can for deletion.

Colors

barcolors.png

This is used to give each bar a fill color. Click Add Bar Color to add more colors. Hover over colors to reveal the trash can for deletion.

Y-axes

yaxis.png

The multiple y-axes appear once each bar has matching y-axis data.

Key

Description

Example

Data Key

Data object property whose values correspond to the y-axis ranges

return [{“temperature”:61,“humidity”:50,“wind”:14,“rainfall”:5,“timestamp”:“2016-06-22T02:26:14.368Z”}];

Label

Y-axis name

yaxis-label.png

Orientation

Changes the side the y-axis is on

y-left.png
y-right.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Top Padding

Creates extra spacing for the graph on the top

toppadding.png

Bottom Padding

Creates extra spacing for the graph on the bottom

bottompadding.png

Show Standard Deviation Reference Lines

Shows standard deviation bounds

bar_std_dev_refline.png

Standard Deviations

Number of standard deviations from the mean to render the reference line

bar-std-dev.png

Line Label

Standard deviation line name

std-dev-name.png

Lower Bound

The lowest number on the y-axis range

lowerbound.png

Upper Bound

The highest number on the y-axis range

upperbound.png

Auto Bounds

If marked, the bounds will automatically adjust based on the data

bar-autobounds.png

Click Add Y-Axis to add more axes. Hover over the Y-axis data entry window to reveal the trash can for deletion.

X-axis

xaxis.png

Key

Description

Example

Data Key

Property from the data object whose values correspond to the x-axis ranges

{“dataKey”:“rainfall”}

Label

X-axis name

xaxis-label.png

Orientation

Changes the side the x-axis is on

x-bottom.png
x-top.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Left Padding

Creates extra spacing for the graph on the left

bar-leftpadding.png

Right Padding

Creates extra spacing for the graph on the right

bar-rightpadding.png

Unit Type

The unit type used to scale data on the x-axis. The graph will not appear with a number if it is a string

bar-number.png
bar-category.png

Reference lines

X and y-axis lines can be added to define values and compare against the dataset (only one coordinate per reference line window).

bar-referenceline.png

Click Add Reference Line to add more reference lines. Hover over the reference lines data entry window to reveal the trash can for deletion.

Chart

margins.png

Change the graph’s margin measurements.

Brush

brush.png

Key

Description

Example

Brush

Mark the box to appear below the graph. This is used to zoom in on a graph section

bar-brush.png

Stroke

Change the brush color

colorpalette.png

Data Key

Data object property whose values correspond to the brush

{“dataKey”:“rainfall”}

Height

Changes the brush’s height

bar-brushheight.png


Change the brush’s size and section by dragging the sides.

bar-brushscaling.png

Grid

grid.png

Edit the chart’s grid lines.




bar-hiddengrid.png
bar-horizontal.png
bar-vertical.png

Legend

legendwindow.png

Key

Description

Example

Show/Hide

Show and hide the legend

legend.png

Font Color

Changes the legend’s text font color

fontcolor.png

Layout

Changes the placement of the legend’s labels

legend.png
verticallayout.png

Horizontal Align

Changes the legend’s horizontal placement

horizontalleft.png
horizontalright.png

Vertical Align

Changes the legend’s vertical placement

verticaltop.png
verticalmiddle.png

Icon Type

Changes the legend labels' icon

legend.png

Statistics

statistics.png

Key

Description

Example

Enable Statistics

Displays a button to open a window for graph statistics. The button is disabled while editing a widget

bar-statistics-button.png
https://docs.clearblade.com/v/4/static/img/portal-v2/widgets/widgets-tutorial/statistics-modals.png

Anomaly Detection Strictness

Number of standard deviations used to calculate and detect anomalies

anomalies.png

Other tools

tools.png

Key

Description

Example

Tooltip

Display data box on hover

tooltip.png

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: ##myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the chart fullscreen

fullscreen.png

Line chart

Creating a new line chart

1. Change the type to Line Chart.

2. Choose your data type and datasource. The datasources in the example below were created previously and not by default.

3. Click to automatically populate the graph with generated recommendations based on the data types.

Magic Wand
Modify Chart Data
Change type
Fill in graph


The rest of the tabs are for editing the graph.

chart-toolbar.png

Lines

linestab.png

Key

Description

Example

Data Key

Data object property corresponding to a bar on the graph

{“dataKey”:“humidity”}

Type

The interpolation line type

Each line type description

Legend Type

The icon associated with the data key

stars

Name

The line label if it’s different from the data key

hum (in the legend)=humidity

Check the Show Dots box to add points to the graph. Click Add Line to add more lines. Hover over the line data entry window to reveal the trash can for deletion.

Colors

strokecolors.png

This is used to give each line a stroke color. Click Add Line Color to add more colors. Hover over colors to reveal the trash can for deletion.

Y-axes

yaxis.png

The multiple y-axes appear once each line has matching y-axis data.

Key

Description

Example

Data Key

Data object property whose values correspond to the y-axis ranges

return [{“temperature”:61,“humidity”:50,“wind”:14,“rainfall”:5,“timestamp”:“2016-06-22T02:26:14.368Z”}];

Label

Y-axis name

yaxis-label.png

Orientation

Changes the side the y-axis is on

liney-left.png
liney-right.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Top Padding

Creates extra spacing for the graph on the top

line-toppadding.png

Bottom Padding

Creates extra spacing for the graph on the bottom

line-bottompadding.png

Show Standard Deviation Reference Lines

Shows standard deviation bounds

std_dev_refline.png

Standard Deviations

Number of standard deviations from the mean to render the reference line

std-dev.png

Line Label

Standard deviation line name

std-dev-name.png

Lower Bound

The lowest number on the y-axis range

lowerbound.png

Upper Bound

The highest number on the y-axis range

upperbound.png

Auto Bounds

If marked, the bounds will automatically adjust based on the data

autobounds.png

X-axis

xaxis.png

Key

Description

Example

Data Key

Data object property whose values correspond to the x-axis ranges

{“dataKey”:“rainfall”}

Label

X-axis name

xaxis-label.png

Orientation

Changes the side the x-axis is on

linex-bottom.png
linex-top.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Left Padding

Creates extra spacing for the graph on the left

line-leftpadding.png

Right Padding

Creates extra spacing for the graph on the right

line-rightpadding.png

Unit Type

The unit type used to scale data on the x-axis. The graph will not appear with a number if it is a string

line-number.png
line-category.png

Reference lines

X and y-axis lines can be added to define values and compare against the dataset (only one coordinate per reference line window).

line-referenceline.png

Click Add Reference Line to add more reference lines. Hover over the reference lines data entry window to reveal the trash can for deletion.

Chart

margins.png

Change the graph’s margin measurements.

Brush

brush.png

Key

Description

Example

Brush

Mark the box to appear below the graph. This is used to zoom in on a graph section

bar-brush.png

Stroke

Change the brush color

colorpalette.png

Data Key

Data object property whose values correspond to the brush

{“dataKey”:“rainfall”}

Height

Changes the brush’s height

bar-brushheight.png


Change the brush size and section by dragging the sides.

line-brushscaling.png

Grid

grid.png

Edit the chart’s grid lines.




line-hiddengrid.png
line-horizontal.png
line-vertical.png

Legend

legendwindow.png

Key

Description

Example

Show/Hide

Show and hide the legend

legend.png

Font Color

Changes the legend’s text font color

fontcolor.png

Layout

Changes the placement of the legend’s labels

legend.png
verticallayout.png

Horizontal Align

Changes the legend’s horizontal placement

horizontalleft.png
horizontalright.png

Vertical Align

Changes the legend’s vertical placement

verticaltop.png
line-verticalmiddle.png

Icon Type

Changes the legend labels' icon

legend.png

Statistics

statistics.png

Key

Description

Example

Enable Statistics

Displays a button to open a window for graph statistics. The button is disabled while editing a widget

statistics-button.png
https://docs.clearblade.com/v/4/static/img/portal-v2/widgets/widgets-tutorial/statistics-modals.png

Anomaly Detection Strictness

Number of standard deviations used to calculate and detect anomalies

anomalies.png

Other tools

tools.png

Key

Description

Example

Tooltip

Display data box on hover

line-tooltip.png

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: ##myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the chart fullscreen

fullscreen.png

Pie chart

Creating a new pie chart

1. Change the type to Pie Chart.

2. Choose your data type and datasource. The datasources in the example below were created previously and not by default.

3. Click to automatically populate the graph with generated recommendations based on the data types.

Magic Wand
Modify Chart Data
Change type
Fill in graph

The rest of the tabs are for editing the graph.

pie-toolbar.png

Chart

margins.png

Change the graph’s margin measurements.

Sections

pie-fillcolors.png

This is used to give each section a fill color. Click Next Slice to add more colors. Hover over colors to reveal the trash can for deletion.

Other tools

pie-tools.png

Key

Description

Example

Label

Displays labels for each section

pie-label.png

Tooltip

Display data box on hover

pie-tooltip.png

Inner Radius

Creates a circle in the middle of the chart

innerradius.png

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the chart fullscreen

fullscreen.png

Scatter plot

Creating a new scatter plot

1. Change the type to Scatter Plot.

2. Choose your data type and datasource. The datasources in the example below were created previously and not by default.

Change type
Modify Chart Data

Dots

dots.png

Key

Description

Example

Show Line

Connects the points

showline.png

Color

Colors the dots and line

dotscolors.png

Y-axes

yaxis.png

Key

Description

Example

Data Key

Data object property whose values correspond to the y-axis ranges

return [{“temperature”:61,“humidity”:50,“wind”:14,“rainfall”:5,“timestamp”:“2016-06-22T02:26:14.368Z”}];

Label

Y-axis name

yaxis-label.png

Orientation

Changes the side the y-axis is on

scattply-left.png
scattply-right.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Top Padding

Creates extra spacing for the graph on the top

scattpl-toppadding.png

Bottom Padding

Creates extra spacing for the graph on the bottom

scattpl-bottompadding.png

Show Standard Deviation Reference Lines

Shows standard deviation bounds

scattpl_std_dev_refline.png

Standard Deviations

Number of standard deviations from the mean to render the reference line

scattpl-std-dev.png

Line Label

Standard deviation line name

std-dev-name.png

Lower Bound

The lowest number on the y-axis range

lowerbound.png

Upper Bound

The highest number on the y-axis range

upperbound.png

Auto Bounds

If marked, the bounds will automatically adjust based on the data

scattpl-autobounds.png

X-axis

xaxis.png

Key

Description

Example

Data Key

Data object property whose values correspond to the x-axis ranges

{“dataKey”:“rainfall”}

Label

X-axis name

xaxis-label.png

Orientation

Changes the side the x-axis is on

scattplx-bottom.png
scattplx-top.png

Time Format

Edits the time and date format

http://localhost:1313/v/3/static/img/portal-v2/widgets/widgets-tutorial/timeformat.png

Left Padding

Creates extra spacing for the graph on the left

scattpl-leftpadding.png

Right Padding

Creates extra spacing for the graph on the right

scattpl-rightpadding.png

Unit Type

The unit type used to scale data on the x-axis. The graph will not appear with a number if it is a string

scattpl-number.png
scattpl-category.png

Statistics

statistics.png

Key

Description

Example

Enable Statistics

Displays a button to open a window for graph statistics. The button is disabled while editing a widget

scattpl-statistics-button.png
https://docs.clearblade.com/v/4/static/img/portal-v2/widgets/widgets-tutorial/statistics-modals.png

Anomaly Detection Strictness

Number of standard deviations used to calculate and detect anomalies

anomalies.png

Other tools

scattpl-tools.png

Key

Description

Example

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the chart fullscreen

fullscreen.png

Text

Creating new text

1. Change the type to Text.

2. Choose your data type and datasource (if using Dynamic).

Change type

The datasources in the example below were created previously and not by default.

Modify Data

The rest of the tabs are for editing the text.

text-toolbar.png

Style

styletab.png

Key

Description

Example

Font Family

Type the font, and the text will change to it. The default is Helvetica

Cursive:

fontfamily.png

Font Color

Changes the text color

text-fontcolor.png

Font Size

Changes the text size

fontsize.png

Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Button

Creating a new button

1. Change the type to Button.

2. Choose your datasource (this is the only datatype option). The datasources in the example below were created previously and not by default.

Modify Target
Change type

The rest of the tabs are for editing the button.

button-toolbar.png

Style

button-styletab.png

Key

Description

Example

Background color

Changes the button color

buttoncolor.png

Background hover color

Changes the button color when the cursor is over it

hovercolor.png

Font color

Changes the text’s color inside of the button

button-fontcolor.png

Border color

Changes the button outline color

bordercolor.png

Other tools

buttontools.png

Key

Description

Example

Label

Modifies the button name

buttonlabel.png

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Input

Creating a new input

1. Change the type to Input.

2. Choose your datatype and datasource (if using dynamic) if you are doing a value.

3. Dynamic is the only datatype option if you are doing a target. The datasources in the example below were created previously and not by default.

Modify Target
Change type

HTML

htmlpage.png

This allows you to create in the widget.

Use Static to create your code or Dynamic to upload your code.

The datasource is available within the JS section.

Edit static data:

codepage.png

Key

Description

Example

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

List

Creating a new list

Change the type to List.

Change type

List Source: Renders incoming data.

Selected Item (dynamic only): The portal datasources to be affected by the action.

Choose your datatypes and datasources. The datasources in the example below were created previously and not by default.

Modify Target

The rest of the tabs are for editing the list.

list-toolbar.png

Format

listformat.png

Key

Description

Example

Title

Gives the list a name

listtitle.png

Tracking Column Name

Gives the column name used to keep track of the active list item

trackingcolumn.png

Default List Item

Default items selected. The Tracking Column Name property determines the value

defaultlistid.png
defaultlist.png

Style

list-style.png

Key

Description

Example

Title

Changes the title’s color

list-titlecolor.png

List Item Font

Changes the item name’s color

itemname-color.png

List Item Background

Changes the item’s background color

itembackground-color.png

Active Item Font

Changes the active item name’s color

activefont.png

Active Item Background

Changes the item’s active background color

activefont.png

Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Toggle

Creating a new toggle

Change the type to Toggle.

Change type

Value: Renders incoming data.

Event Target (dynamic only): Portal datasources to be affected by an action.

Choose your datatypes and datasources. The datasources in the example below were created previously and not by default.

Modify Target


The rest of the tabs are for editing the toggle.

toggle-toolbar.png

Labels

toggle-labels.png

Key

Description

Example

On Label

True value label

onlabel.png

Off Label

False value label

offlabel.png

Style

toggle-style.png

Key

Description

Example

On Color

Changes true value colors

oncolor.png

Off Color

Changes false value colors

offcolor.png

Background Color

Changes the toggle’s background color

togglebackground-color.png

Font Color

Changes the labels' color


Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Color picker

colorpickerpage.png

This allows you to create in the widget.

Use Static to create your code or Dynamic to upload your code.

Other tools

texttools.png

Key

Description

Example

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Grouping list

Creating a new grouping list

Change the type to Grouping List.

Change type

List Source (dynamic only): Renders incoming data.

Selected Item (dynamic only): Portal datasources to be affected by the action.

Choose your datasources. The datasources in the example below were created previously and not by default.

Modify Target


The rest of the tabs are for editing the list.

grouplist-toolbar.png

Format

listformat.png

Key

Description

Example

Title

Gives the list a name

glist-title.png

Display Attribute

Property type displayed for list items

displayattribute.png

Status Attribute

A property with a boolean value to create active/inactive icons

boolean.png
statusattribute.png
status.png

Default List Item

Default items selected. Value determined by the Tracking Column Name property

defaultlistid.png
defaultlist.png

Allow Search

Displays search bar to search a specific item

searchbar.png

Groups

grouptools.png

Items can be grouped by their properties.

groups.png

Style

list-style.png

Key

Description

Example

Title

Changes the title’s color

grouplist-titlecolor.png

List Item Font

Changes the item name’s color

group-itemname-color.png

List Item Background

Changes the item’s background color

group-itembackground-color.png

Active Item Font

Changes the active item name’s color

group-activefont.png

Active Item Background

Changes the active item’s background color

group-activebackground.png

Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target a DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Filterable list

Creating a new filterable list

Change the type to Filterable List.

Change type

List Source (dynamic only): Renders incoming data.

Selected Item (dynamic only): Portal datasources to be affected by an action.

Choose your datatypes and datasources. The datasources in the example below were created previously and not by default.

Modify Target


The rest of the tabs are for editing the list.

list-toolbar.png

Format

listformat.png

Key

Description

Example

Title

Gives the list a name

glist-title.png

Display Attribute

Property type displayed for list items

displayattribute.png

Status Attribute

A property with a boolean value to create active/inactive icons

boolean.png
statusattribute.png
status.png

Tracking Column Name

Makes the used column name track the active list item

trackingcolumn.png

Default List Item

Default items selected. The Tracking column name property determines the value

defaultlistid.png
defaultlist.png

Allow Search

Displays search bar to search a specific item

searchbar.png

Allow Filters

Displays and choose filters

filters.png
selectfilters.png
viewfilter.png

Style

list-style.png

Key

Description

Example

Title

Changes the title’s color

grouplist-titlecolor.png

List Item Font

Changes the item name’s color

group-itemname-color.png

List Item Background

Changes the item’s background color

group-itembackground-color.png

Active Item Font

Changes the active item name’s color

group-activefont.png

Active Item Background

Changes the active item’s background color

group-activebackground.png

Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

JSON editor

Data

json.png

JSON assigns data to a label, whether from the collection or in parser editing. Data in the example has been previously created and is not by default.

Other

json-other.png

Type

Description

Example

Read Only

Does not allow you to save edits. The Save button disappears

readonly.png

Save Button Color

Changes the Save button color

savebutton.png

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Form

Creating a new form

Change the type to Form.

Change type
form-datasource.png

Form Source: Renders incoming form data.

Submit Item: Portal datasources to be affected by an action.

The only option available is Calculated. To edit what information type is returned, click Edit calculated data.

Fields

form_fields.png

Key

Description

Example

All read-only

Makes all fields uneditable. It also removes the submit button

all_readonly.png

Name

Internal name to use as a parser key

last_name

Label

Item name that will appear on the form

form_label.png

Data type

Choose what data type can be inputted into the form

String:

form_datatype.png

Input type

Choose what can be inputted based on the data type

Password:

form_inputype.png

Read only

Make field uneditable

form_readonly.png

Required

An error message appears when a required field is empty

required.png

Validation

An error message when validation is not in the correct format

validation.png

Error text

Customize error message for validation

error_text.png

Default value

Adds a default value to the field. The value can be overridden by using the parser

form_default.png

Help text

Adds a help text icon next to the field label


Placeholder

Helper text that is shown in the field

form_placeholder.png

Small text

Subtext below field

form_smalltext.png

Width Percent

Changes field size

100%:

100width.png
25%:
25width.png

Order

Changes field placement

Last name = 2:

order.png

Hide label

Hides the field label

form_hidelabel.png

Display

Removes field if unchecked


Add field

Adds another field to the form

form_addfield.png

Form text

form_text.png

Key

Description

Example

Title

Gives the form a title

form_title.png

Submit Text

The submit button’s text

submit_text.png

No Data Text

Appears when data is not returned in the parser

no_data.png

Success Text

Appears on the left side of the page when the form has been submitted

success_text.png

Display Attribute for Row

Uses data returned from a key as a subtitle

display_attribute.png

Form style

form-style.png

Key

Description

Example

Compact Mode

Changes format to inline style

compactmode.png

Hide Submit Button

Removes the submit button

hide_submit.png

Title

Changes the title color

form-titlecolor.png

Background

Changes the form’s background color

formbackground.png

List Item Font

Changes the item name’s color

form-itemcolor.png

Slider

Changes the slider’s color if available

slidercolor.png

Toggle Switch Color

Changes the toggle switch’s color when it’s set to true if available

toggleswitch-color.png

Button Group Color

Changes the selected button outline’s color if available

updatebutton-color.png

Type Ahead Color

Changes the highlighted item for type ahead color if available

typeahead-color.png

Button Color

Changes the submit button’s color

button-color.png

Form other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Advanced section

You can create a dynamic form widget using a list widget, a local variable datasource, and an aggregator datasource.

Target local variable datasource:

1. Add a local variable datasource.

2. Add a list widget whose target is the local variable.

3. Create a datasource aggregator that aggregates the local variable and datasource providing data for the form widget.

4. Create a new form widget whose incoming datasource is the aggregator. A parser error will display.

5. The default parser should look different when re-opening it.

6. Fill in the datasource names corresponding to the bracket labels in the designated areas.

7. The form dynamically displays whichever item is selected in the list.

formfinal.png
form-style.png
uneditparser.png
formsource.png
addaggregator.png

Radial gauge

Data

radialgauge.png

Type

Description

Static

Can type a plain text number to measure in a gauge

Calculated

A JavaScript function not bound to any datasources

Dynamic

A JavaScript function that will be updated as the corresponding datasource gets updated

Min Value

The gauge range’s minimum number

Max Value

The gauge range’s maximum number

The rest of the tabs are for editing the gauge appearance.

gaugetoolbar.png

Style

gaugestyle.png

Type

Description

Example

Progress Color

Changes the progress bar’s color

progresscolor.png

Background Color

The gauge’s color

gaugecolor.png

Label

The gauge’s title

gaugelabel.png

Others

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Speedometer

Data

speedometer.png

Type

Description

Static

Can type a plain text number to measure in the meter

Calculated

A JavaScript function not bound to any datasources

Dynamic

A JavaScript function that will be updated as the corresponding datasource gets updated

Min Value

The meter range’s minimum number

Max Value

The meter range’s maximum number


The rest of the tabs are for editing the meter appearance.

speedometertoolbar.png

Sections

Click Add Section to add more sections. Hover over the bar data entry window to reveal the trash can for deletion. The percentages are not cumulative.

speedometersections.png

Colors

sectioncolor.png

This is used to give each section a fill color. Click Add Color to add more colors. Hover over colors to reveal the trash can for deletion.

Style

image-20240110-194137.png

Type

Description

Example

Label

The meter’s title

meterlabel.png

Label Color

Changes the label’s color

speedometer-labelcolor.png

Arrow Color

The arrow’s color

arrowcolor.png

Others

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Google Maps

Data

googlemaps.png

The data on the map is default. To change locations, go to Edit Calculated Data. Retrieve the API Key from your Google Maps account.

Format

image-20240110-194635.png

Key

Description

Example

Default Zoom

Creates the map’s default size when you see it in the pane

@1:

zoom1.png

@10:

zoom10.png

Default Center

The map’s default location

defaultcenter.png

Map Theme

Get theme from Google Maps

mapstheme.png

Other tools

texttools.png

Key

Description

Example

Unique Style

Overrides the overall style settings to change a specific setting. It is automatically checked when you change a style


HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Rule builder

Edit widget window

rulebuilder.png

Type

Description

Example

Allow Create

Allows users to define new widget rules

addrule.png

Allow Delete

Allows users to delete rules

deleterule.png

Allow Edit

Allows users to modify rules by clicking the rule and going to settings

rb-settings.png
rb-mainpage.png

Allow On/Off

Allows users to enable/disable widget rules

enablerules.png

Name

Rule builder label

rulebuilder-name.png

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png

Save to add a new rule.

Add a new rule window

The user needs code, roles, and trigger permissions before using this widget.

Go to the widget window and click Add New Rule.

sources.png

Type

Setting

Data

data-pt1.png
data-pt2.png

Asset

asset.png

User

user.png

Messaging

msg-pt1.png
msg-pt2.png

Device

device.png

Code

The final rule will appear in the console’s code tab.

code-rule.png

CRUD Grid

CRUD Grid allows the end user to create, read, update, and delete elements in a collection or given dataset.

Data

crudgrid.png

Data

Description

griddata.png

Choose the incoming data type to render. Expected format:

expectedformat.png
fetchdata.png

Retrieve a datasource’s data

gridexport.png

Create the option to export grid items

gridadd.png

Affect the ability to add datasource items

griddelete.png

Affect the ability to delete datasource items

updategrid.png

Affect the ability to edit datasource items

highlight_item.png

Create the option to highlight grid items

Capabilities

capabilities.png

Key

Description

Example

Allow Create

Users can add rows

addrow.png

Allow Delete

Users can delete rows

deleterow.png

Allow Update

Users can edit rows. The changes made here are also made in the original datasource

updaterow.png

Allow Filter

Users can filter tables

filterrow.png

Allow Data Export

Users can export tables

dataexport.png

Allow Search

Users can search for a specific item

search_data.png

Allow Data Import

Users can import tables

dataexport.png

Allow Column Sorting

Sort items by column data

columnsorting.png

Allow Highlight Row

Highlight items by clicking them

highlight_data.png

Fields

fields.png

Key

Description

Example

Get fields from datasource

Retrieves datasource column information

field_datasource.png

Name

Internal name to use as a parser key

item_id

Label

The column’s name

field_label.png

Data Type

Choose what data type will be retrieved and shown

Integer:

field_type.png

Input Type

Choose how the data should be displayed

Radial gauge:

input_type.png

Read Only

The field cannot be editable


Help Text

Adds a help text icon next to the field label

columnsorting.png

Small Text

The subtext below the field label

smalltext.png

Width in pixels

Changes the field size

field_width.png

Hide label

Hides the field label


Display

Hides the field if checked

before_field.png
after_field.png

Add field

Adds empty field

add_field.png

Style

field_style.png

Other

field_tools.png

Key

Description

Example

Default sorting direction

Orders fields in ascending or descending order


Hide Footer

Shows page and count when unchecked

footer.png

Rows per page

Change the number of rows displayed

field_rows.png

HTML ID

Used to target the DOM’s widget elements

Add an ID to the page like this: <div id="myCustomHtmlId">some text </div> and write CSS like this: #myCustomHtmlId{ color: red }

Allow Fullscreen

Makes the widget fullscreen

fullscreen.png