RenderConfiguration
RenderConfiguration
Render configuration to be applied to the widget.
JSON Example
{
"color": "string",
"condition": "string",
"display_value": "string",
"icons": [
{
"color": "string",
"placement": "string",
"size": "number",
"size_unit": "string",
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
],
"type": "string"
}
],
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
]
}
string
color
Optional
The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.
string
condition
Optional
Constraints:
maxLength: 1024
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.
string
display_value
Optional
Constraints:
maxLength: 255
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.
array of
Icon
icons
Optional
Constraints:
minItems: 0
Icons to be applied at dashboard for widgets and UI elements.
array of
Tooltip
tooltip
Optional
Constraints:
minItems: 0
Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.