Label

Label
Label

Label that will be displayed for a UI element.

JSON Example
{
    "condition": "string",
    "hover": false,
    "icons": [
        {
            "color": "string",
            "placement": "string",
            "size": "number",
            "size_unit": "string",
            "tooltip": [
                {
                    "condition": "string",
                    "heading": false,
                    "text": "string"
                }
            ],
            "type": "string"
        }
    ],
    "navigation": "string",
    "text": "string"
}
string
condition
Optional
Constraints: maxLength: 1024

If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.

boolean
hover
Optional

If true, displays the label only on hover

array of Icon
icons
Optional
Constraints: minItems: 0

Icons to be applied at dashboard for the label

string
navigation
Optional
Constraints: maxLength: 1024

Hyperlink of the specified UI page that provides details.

string
text
Required
Constraints: maxLength: 255

Text to be displayed at the label.