You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/contribution/widgets-development-before-3.0.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ title: Widgets Development Guide Before 3.0
14
14
This is a widget development guide for the ThingsBoard version before the ThingsBoard 3.0 version.
15
15
In case if you are using the ThingsBoard 3.0+ version, you can refer to the next link for the [Widget Development ThingsBoard 3.0+ version](/docs/user-guide/contribution/widgets-development/) guide.
16
16
17
-
**ThingsBoard widgets** are additional UI modules that can be easily integrated into any [IoT Dashboards](/docs/user-guide/ui/dashboards/) and provide end-user functions such as data visualization, remote device control, alarms management and displaying static custom html content.
17
+
**ThingsBoard widgets** are additional UI modules that can be easily integrated into any [IoT Dashboards](/docs/user-guide/dashboards/) and provide end-user functions such as data visualization, remote device control, alarms management and displaying static custom html content.
18
18
According to the provided features each widget definition represents specific [Widget Type](/docs/user-guide/ui/widget-library/#widget-types).
19
19
20
20
## Creating new widget definition
@@ -902,4 +902,4 @@ Browser debugger (if enabled) will automatically pause code execution at the deb
902
902
903
903
## Next steps
904
904
905
-
{% assign currentGuide = "Contribution" %}{% include templates/guides-banner.md %}
905
+
{% assign currentGuide = "Contribution" %}{% include templates/guides-banner.md %}
Copy file name to clipboardExpand all lines: docs/user-guide/contribution/widgets-development.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ title: Widgets Development Guide
11
11
12
12
## Introduction
13
13
14
-
**ThingsBoard widgets** are additional UI modules that easily integrate into any [IoT Dashboard](/docs/user-guide/ui/dashboards/). They provide end-user functions such as data visualization, remote device control, alarms management and display of static custom html content.
14
+
**ThingsBoard widgets** are additional UI modules that easily integrate into any [IoT Dashboard](/docs/user-guide/dashboards/). They provide end-user functions such as data visualization, remote device control, alarms management and display of static custom html content.
15
15
According to the provided features, each widget definition represents a specific [Widget Type](/docs/user-guide/ui/widget-library/#widget-types).
@@ -236,18 +246,22 @@ For faster learning and a better understanding of this guide, first, you have to
236
246
237
247
ThingsBoard provides the ability to create and manage Dashboards.
238
248
239
-
You can have unlimited number of Dashboards. Each Dashboard may contain plenty of widgets.
249
+
Each Dashboard may contain plenty of widgets.
240
250
Dashboards display data from many entities: devices, assets, etc. Dashboards can be assigned to Customers.
241
251
242
252
This guide covers main concepts and various configuration settings.
243
253
244
254
## Dashboard overview
245
255
246
-
Before starting working with a dashboard, get acquainted with its appearance and understand which features are responsible for what actions.
256
+
Before starting working with a dashboard, get familiar with its appearance and understand which features are responsible for what actions.
247
257
248
258
### Title
249
259
250
260
Editable dashboard title appears in the top-left corner of the dashboard. Dashboard Title displays in the application breadcrumbs to simplify the navigation.
261
+
You can change and adjust a Title in the [settings of the dashboard](/docs/user-guide/dashboards/#title-of-the-dashboard)
262
+
263
+
{% include images-gallery.html imageCollection="dash-title" %}
264
+
251
265
252
266
### Edit mode
253
267
@@ -269,6 +283,8 @@ Dashboard toolbar allows you to manage
269
283
Some of these icons (stats, layout, settings) are visible only in the "edit" mode. All other icons are visible in both "view" and "edit" mode.
270
284
You can hide these icons or configure the toolbar to be minimized by default using [settings](/docs/user-guide/dashboards/#settings).
271
285
286
+
{% include images-gallery.html imageCollection="toolbar-review" %}
287
+
272
288
### Entity Aliases
273
289
274
290
Entity Aliases determine which entities (devices, assets, etc) you would like to display on the dashboard.
@@ -326,6 +342,8 @@ Widgets are the building blocks of your dashboard. There are 5 types of widgets:
326
342
* **Alarm** widgets allow you to display [alarms](/docs/user-guide/alarms/);
327
343
* **Static** widgets are designed to display static data. For example, floor plan or static company information.
328
344
345
+
More about widget types you can learn [here](docs/user-guide/ui/widget-library/).
346
+
329
347
#### Adding widget to the dashboard
330
348
331
349
To add a widget to the dashboard, you should:
@@ -344,7 +362,7 @@ Therefore, the "Add widget" dialog contains four tabs to define a widget. Note t
344
362
You may leave all other configuration tabs with the default values in most of the cases.
345
363
We will discuss each of those tabs below.
346
364
347
-
##### Widget data settings
365
+
##### 1. Widget data settings
348
366
349
367
Widget data settings allow you to add one or multiple data sources.
350
368
A Data source is a combination of [entity alias](/docs/user-guide/dashboards/#entity-aliases), optional [filter](/docs/user-guide/dashboards/#entity-filters), and list of data keys.
@@ -373,7 +391,7 @@ In such case, you can still add a key to the data source, and the widget will st
373
391
Besides the data keys, time series widget allows you to select the [time window](/docs/user-guide/dashboards/#time-window).
374
392
Also, alarm widget allows you to select both [time window](/docs/user-guide/dashboards/#time-window) and [alarm filter](/docs/user-guide/dashboards/#alarm-filter).
375
393
376
-
##### Data keys
394
+
##### 2. Data keys
377
395
378
396
Data key defines time series, attribute or entity field that you would like to use in the widget.
379
397
Data key definition consists of type (time series, attribute of entity field) and the actual key.
@@ -389,15 +407,15 @@ List of entity fields depends on the entity type and may extend in the future:
389
407
* **User** has the following fields: created time, first name, last name, email and additional info.
390
408
* **Customer** has the following fields: create time, entity type, email, title, country, state, city, address, zip code, phone, additional info.
391
409
392
-
##### Basic Data keys settings
410
+
###### 2.1. Basic Data keys settings
393
411
394
412
Coming soon...
395
413
396
-
##### Advanced Data keys settings
414
+
###### 2.2. Advanced Data keys settings
397
415
398
416
Coming soon...
399
417
400
-
##### Widget time window
418
+
##### 3. Widget time window
401
419
402
420
A widget time window defines a time interval and aggregation function that should be used to fetch the time series or alarm data.
403
421
By default, every widget uses the main [time window](/docs/user-guide/dashboards/#time-window) determined in the dashboard's [toolbar](/docs/user-guide/dashboards/#toolbar).
@@ -408,7 +426,7 @@ You can also hide the time window selection for a specific widget from the user
408
426
409
427
Learn more about time window configuration [here](/docs/user-guide/dashboards/#time-window).
410
428
411
-
##### Alarm filter
429
+
##### 4. Alarm filter
412
430
413
431
In addition to the time window configuration, alarm widgets allow you to filter [alarms](/docs/user-guide/alarms/) based on [status](/docs/user-guide/alarms/#lifecycle), [severity](/docs/user-guide/alarms/#severity), and [type](/docs/user-guide/alarms/#type).
414
432
You can choose a combination of alarm statuses and severity. You may also define specific alarm types as well as enable search of [propagated](/docs/user-guide/alarms/#propagation) alarms.
@@ -424,7 +442,7 @@ You should see a similar widget (note that you should send/simulate some data to
424
442
425
443
Let's use the basic widget settings to customize the widget. We will demonstrate how each setting affects the widget.
426
444
427
-
##### Widget Title
445
+
##### 1. Widget Title
428
446
429
447
You can input custom widget title, tooltip and title style. You may also add an icon to the title and control icon color and size. See configuration and the corresponding result below.
430
448
@@ -447,7 +465,7 @@ All those settings are enabled by default.
447
465
448
466
{: .copy-code}
449
467
450
-
##### Widget Style
468
+
##### 2. Widget Style
451
469
452
470
You can customize personal style for the widget using CSS properties. This style will be applied to the main div element of the widget. You can also change the background color, text color, padding, and margin.
453
471
See the configuration and the corresponding result below.
@@ -467,7 +485,7 @@ Widget style from the screen above:
467
485
```
468
486
{: .copy-code}
469
487
470
-
##### Legend settings
488
+
##### 3. Legend settings
471
489
472
490
For chart widgets, the “Display legend” option is enabled by default. The legend is used to display the min/max/average/total values.
473
491
Other widgets have this option disabled.
@@ -482,7 +500,7 @@ See configuration and the corresponding result below:
482
500
483
501
{% include images-gallery.html imageCollection="basic-settings-legend" %}
484
502
485
-
##### Mobile mode settings
503
+
##### 4. Mobile mode settings
486
504
487
505
Mobile Mode settings consist of two options:
488
506
- Order - set to an integer, specifies the priority of the order of displaying widgets in mobile mode (note that in mobile mode all widgets are displayed in one vertical column).
@@ -492,14 +510,14 @@ For example, with a value of 5, the widget height will be 350px. (70 * 5)
492
510
If no value is specified, its original height will be used.
493
511
494
512
495
-
##### Other settings
513
+
##### 5. Other settings
496
514
497
515
You can choose which symbol to display next to the value and the number of digits after the floating-point number.
498
516
These settings are useful if you want to apply the same settings for all axis.
499
517
For example, if you are showing temperature readings for multiple devices, you can add '°C' or '°F' symbol.
500
518
However, if you are displaying both temperature and humidity, you have to configure these data keys separately using data key settings.
501
519
502
-
##### Advanced widget settings
520
+
##### 6. Advanced widget settings
503
521
504
522
Advanced widget settings are specific to widget implementation. Those settings allow you to fine tune the widget. For example, “Timeseries - Flot” widget allows you to configure line style, width, enable comparison with the previous time interval and use entity attributes in the legend.
505
523
@@ -509,7 +527,9 @@ Coming soon...
509
527
510
528
##### Widget actions
511
529
512
-
Coming soon...
530
+
Each type of widget has its own actions. They are similar and serve the same purpose - to help you quickly switch from the created widget to certain detailed information about its devices.
531
+
532
+
You can read more about the action widget in the [article dedicated to it](/docs/user-guide/ui/widget-actions/).
513
533
514
534
## Time window
515
535
@@ -613,15 +633,15 @@ If you tick this option, all the widgets on the Dashboard will fill in verticall
613
633
614
634
#### Background
615
635
616
-
##### Background color
636
+
##### 1. Background color
617
637
618
638
The Background color option allows you to customize the color that you'd like to be on the Dashboard's background.
619
639
To alter it, click on the colored circle, and with sliders choose the needed color and wished transparency. Then, press "Save" to apply changes.
620
640
After saving, you can see the customized background.
621
641
622
642
{% include images-gallery.html imageCollection="background-settings" %}
623
643
624
-
##### Background image
644
+
##### 2. Background image
625
645
626
646
This option allows setting the picture as a background. To do this, you should drop an image in the appropriate field, or upload it from a folder on your computer.
627
647
Once you select it, an image preview will appear on the left of the Settings window.
Copy file name to clipboardExpand all lines: docs/user-guide/rbac.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ description:
24
24
ThingsBoard Community Edition (TB CE) supports a straight-forward security model with three main roles: System administrator, Tenant administrator, and Customer user.
25
25
A system administrator is able to manage tenants, while a tenant administrator manages devices, dashboards, customers, and other entities that belong to a particular tenant.
26
26
Customer user is able to view dashboards and control devices that are assigned to a specific customer.
27
-
TB CE functionality is sufficient for a lot of simple use cases, especially building real-time [end-user dashboards](/docs/user-guide/ui/dashboards/).
27
+
TB CE functionality is sufficient for a lot of simple use cases, especially building real-time [end-user dashboards](/docs/user-guide/dashboards/).
28
28
29
29
ThingsBoard Professional Edition (TB PE) brings much more flexibility in terms of user, customer, and role management.
30
30
It is designed to cover use cases for businesses and enterprises with multiple user groups that have different permissions but may interact with the same devices and assets.
All [IoT Dashboards](/docs/user-guide/ui/dashboards/) are constructed using **ThingsBoard widgets** that are defined in Widget Library.
15
+
All [IoT Dashboards](/docs/user-guide/dashboards/) are constructed using **ThingsBoard widgets** that are defined in Widget Library.
16
16
Each widget provides end-user functions such as data visualization, remote device control, alarms management and displaying static custom html content.
0 commit comments