Home

Welcome to the node-red-soop-dashboard wiki!

Nodes

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	Set label of widget	widget label
tooltip	Set tootip of widget	widget tooltip
color	Set color of widget	blue
name	Set widget name on palette	widget name

Button: A widget that delivers a specific message when pressed by a user.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	Set label of widget	Button title
tooltip	Set tootip of widget	Button tooltip
color	Set color of widget	blue
shape	Set shape of button	rectangle
msg	Set msg(payload, topic)	{payload: "Hi", topic: "A"}
get input	Click button using input signal or not	false
name	Set widget name on palette	Button name

Chart: A widget that receives data from a user and displays it in a chart.

• Line: Plot a time-series data as a line chart on the dashboard.

• Bar: Plot a time-series or non-time-series data as a bar chart on the dashboard.

• Pie: Plot a non-time-series data as a pie chart on the dashboard.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	-	-
type	-	-
time-series	-	-
x-axis format	-	-
y-axis	-	-
legend	-	-
blank label	-	-
name	Set widget name on palette	Chart

Dropdown: A widget that shows the value entered by the user in a drop-down format.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	Set label of widget	Dropdown title
tooltip	Set tootip of widget	Dropdown tooltip
options	Set value and label of the content	{value: value, label: label}
name	Set widget name on palette	Dropdown

Gauge: A widget that shows the percentage of the total value that a user receives.

• Gauge: Plot a data as a gauge graph on the dashboard.

• Donut: Plot a data as a donut graph on the dashboard.

• Liquid: Plot a data as a liquid fill gauge chart on the dashboard.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
type	-	-
label	-	-
value format	-	-
units	-	-
range	-	-
color	Set color of widget	blue
name	Set widget name on palette	Gauge

Image: A widget that shows images through an image file or image URL.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
option	Set image source option	upload
source	Set image source as file or URL	-
object fit	Set image fit option	fill
name	Set widget name on palette	Image

List: A widget that shows the values entered by the user in list form.

• Ordered: Show an ordered list on the dashboard.
• Unordered: Show an unordered list on the dashboard.
• Checkbox: Show a checkbox list on the dashboard.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	Set label of widget	List title
tooltip	Set tootip of widget	List tooltip
type	Set type of list	Ordered list
options	Set value of the content	content
name	Set widget name on palette	List

Slider: A slider-type widget that allows users to set values.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
color	Set color of widget	blue
label	Set label of widget	Slider title
tooltip	Set tootip of widget	Slider tooltip
range	Set range(min, max, step) of the slider	1 100 1
pass	Allow passing through input value to output or not	true
when	Decide when to reflect the changed values from the dashboard.	always value changed
name	Set widget name on palette	Slider

Switch: A widget that allows the user to toggle (on/off) values.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
color	Set color of widget	blue
label	Set label of widget	Switch title
name	Set widget name on palette	Switch

Text: A widget that shows the value entered by the user in text format.

Name	Description	example
group	Choose group of widget	[Tab #0] Group 1
group table	Set widget start position(x,y) and size(w,h)	0 0 1 1
label	Set label of widget	label
label format	-----------	-------
value	-----------	value
value format	-----------	-------
layout	-----------	-------
font size	-----------	-------
name	-----------	Text

Dashboard Config: A configuration node for soop dashboard.

Data Format: A node for labeling each dataset to use chart nodes.

Name	Description	example
label	Set label of dataset	dataset 1
name	Set widget name on palette	Data Format

Group: A set of widgets. It will be sorted automatically.

Name	Description	example
name	Set group name	Group 1
tab	Set tab of the group	Tab #0
group table	Set width and height of the group	5 5
display	Set group name visible or not	true

Tab: A set of groups. The default name is given as Tab # number. It doesn't matter if the name is duplicated.

Name	Description	example
name	Set tab name	Tab #0

Flows

Release

npm package
link

Node-RED
link