RenderConfiguration

Render configuration to be applied to the widget.


Properties

Required Property Name Type Description
optional color string

The color to use when rendering an entity. For example, set color as ‘RED’ to render a portion of donut in red.

optional condition string

If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.

optional display_value string

If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.

optional icons array of Icon

Icons to be applied at dashboard for widgets and UI elements.

optional tooltip array of Tooltip

Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.

JSON Example

{
    "color": "string",
    "condition": "string",
    "display_value": "string",
    "icons": [
        {
            "placement": "string",
            "tooltip": [
                {
                    "condition": "string",
                    "heading": false,
                    "text": "string"
                }
            ],
            "type": "string"
        }
    ],
    "tooltip": [
        {
            "condition": "string",
            "heading": false,
            "text": "string"
        }
    ]
}
Feedback

Was this page helpful?