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
{{ message }}
This repository was archived by the owner on May 22, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: _includes/docs/user-guide/widgets.md
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -409,19 +409,19 @@ In the legend settings, you can:
409
409
410
410
The legend displays a label for each [data key](/docs/{{docsPrefix}}user-guide/widgets/#data-keys). When a widget contains data from multiple devices, or when several devices use the same data key name (for example, temperature), it may be difficult to determine which key value corresponds to which device in the legend or tooltip.
411
411
412
-
To make the legend or tooltip clearer, you should use <b>${entityName}</b> or <b>${entityLabel}</b> in the data key configuration.
412
+
To make the legend clearer, you should use **${entityName}** or **${entityLabel}** in the **Label** field of the data key configuration.
413
413
414
-
-<b>${entityName}</b> – a variable that automatically inserts the system name of the entity in the legend or tooltip. This helps clearly identify the object, especially when its technical name or unique identifier is important.
415
-
Example: If a device has the name <b>sensor-101</b>, then in the field where <b>${entityName}</b> is used, you will see <b>sensor-101</b>.
414
+
-**${entityName}** – a variable that automatically inserts the system name of the entity in the legend. This helps clearly identify the object, especially when its technical name or unique identifier is important.
415
+
Example: If a device has the name **sensor-101**, then in the field where **${entityName}** is used, you will see **sensor-101**.
416
416
417
417
{% include images-gallery.html imageCollection="entity-name-legend" %}
418
418
419
-
-<b>${entityLabel}</b> – a variable that inserts the entity's label in the legend or tooltip.. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
419
+
-**${entityLabel}** – a variable that inserts the entity's label in the legend. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
In the field where <b>${entityLabel}</b> is used, the operator will see the more understandable text: <b>Temperature Sensor, Warehouse #1</b>.
424
+
In the field where **${entityLabel}** is used, the operator will see the more understandable text: **Temperature Sensor, Warehouse #1**.
425
425
426
426
{% include images-gallery.html imageCollection="entity-label-legend" %}
427
427
@@ -466,7 +466,23 @@ You can change the appearance of the chart grid: customize the color of the back
466
466
467
467
-**Show cumulative values in stacking mode**. While stacking mode is on, you can check the box "Cumulative values" to enable your chart to display sum of all entity values.
468
468
469
-
**Tooltip value format function, f(value, latestData)** is used when you want to manually customize the tooltip.
469
+
Tooltip value format function, **f(value, latestData)** is used when you want to manually customize the tooltip.
470
+
471
+
To make the tooltip clearer, you should use **${entityName}** or **${entityLabel}** in the **Label** field of the data key configuration.
472
+
473
+
-**${entityName}** – a variable that automatically inserts the system name of the entity in the tooltip. This helps clearly identify the object, especially when its technical name or unique identifier is important.
474
+
Example: If a device has the name **Sensor 1**, then in the field where **${entityName}** is used, you will see **Sensor 1**.
475
+
476
+
{% include images-gallery.html imageCollection="entity-name-tooltip" %}
477
+
478
+
-**${entityLabel}** – a variable that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
479
+
Example: A device has:
480
+
-**Name** = **Sensor 1**
481
+
-**Label** = **Sensor 1 Label**
482
+
483
+
In the field where **${entityLabel}** is used, the operator will see the more understandable text: **Sensor 1 Label**.
484
+
485
+
{% include images-gallery.html imageCollection="entity-label-tooltip" %}
470
486
471
487
You can customize the values that will be displayed in the tooltip via tooltip settings or
472
488
[Advanced Data key configuration](/docs/{{docsPrefix}}user-guide/ui/advanced-data-key-configuration/#tooltip-settings){:target="_blank"}.
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the tooltip.'
title: 'Use the <b>${entityName}</b> variable in the key label, which automatically inserts the system name of the entity. This helps clearly identify the object, especially when its technical name or unique identifier is important.'
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the legend or tooltip.'
344
+
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the legend.'
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the legend or tooltip.This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
361
+
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the legend. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the tooltip.'
title: 'Use the <b>${entityName}</b> variable in the key label, which automatically inserts the system name of the entity. This helps clearly identify the object, especially when its technical name or unique identifier is important.'
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the tooltip.'
title: 'Use the <b>${entityName}</b> variable in the key label, which automatically inserts the system name of the entity. This helps clearly identify the object, especially when its technical name or unique identifier is important.'
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the tooltip.'
title: 'Use the <b>${entityName}</b> variable in the key label, which automatically inserts the system name of the entity. This helps clearly identify the object, especially when its technical name or unique identifier is important.'
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
0 commit comments