view_widget.xml
This page lists all of the available tags within the view_widget.xml file and how to access them from within the widget
As described before, this file allows the developer to create a form so that it can be displayed as a GUI at the moment of creating the Widget on a dashboard.
The contents of this file are Ubidots-mapped XML-like tags to React elements, so it actually differs from the traditional XML supported tags. Also, view.xml
and view_widget.xml
are implemented differently, so their supported tags are different.
Please check our Custom UI documentation in order to know the available elements and how to use them:
pageCustom UI'Add Variables' feature.
Ubidots native widgets offer the capability to select the target variables for the widget:
This can be achieved also while developing a Widget-plugin using the addvariable
tag within the view_widget.xml
file.
For example, in order to replicate the Metric widget's UI shown above, you can use the following view_widget.xml
:
Note that within the addvariable
tag, you can use any of the elements described in the Custom UI documentation.
addvariable tag
This element is interpreted such that it displays the whole drawer for adding variables. The following are its attributes:
Attribute | Mandatory | Description |
---|---|---|
| Yes | Unique identifier used internally. Don't modify its default value. |
| Yes | Max number of variables that can be added. |
| Yes | Unique identifier used internally. Don't modify its default value. |
variablelabel tag
This element displays a label and a description within a container in order to provide detailed information.
Attribute | Mandatory | Description |
---|---|---|
label | Yes | Message displayed when selecting a variable. |
description | No | Message displayed below the label message |
With this in mind, if you changed the label
attribute from Variable label
to Variables
, such message will be displayed instead.
Adding variables' Aggregation methods.
If your Plugin-widget requires information about the variable's aggregation method, you can use a inputcombo
of the dropdown.list
type as shown above, however, for it to work correctly, it is mandatory that the id
attribute has the value aggregationMethod
Adding variable's time-span
If your Plugin-widget requires a time span for the variable's data, you can use a inputcombo
of the span
type as shown above, however, for it to work correctly, it is mandatory that the id
attribute has the value span
Accessing the view_widget.xml elements from within the Widget's Javascript script
The view_widget.xml
elements can be accessed from within the widget.js script using the input combo id attribute.
For example, suppose your Widget is implementing the following view_widget.xml
file:
You can access all of these data as follows:
Then, the settings
object will be something like:
This object contains on the root level, all the keys corresponding to each of the view_widget.xml
element's id.
For example note that above, it was used two input combo whose ids are device_label
and tittle
correspondingly, also note that those keys are within the settings object. Also note variables
key, this is always a list containing the selected variables.
Last updated