DonutPart

Represents an entity or portion to be plotted on a donut or stats chart.

JSON Example

{
    "condition": "string",
    "drilldown_id": "string",
    "field": "string",
    "hide_empty_legend": false,
    "label": {
        "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"
    },
    "navigation": "string",
    "render_configuration": [
        {
            "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"
                }
            ]
        }
    ],
    "tooltip": [
        {
            "condition": "string",
            "heading": false,
            "text": "string"
        }
    ]
}

string

condition

Optional

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

string

drilldown_id

Optional

Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.

string

field

Required

Constraints: maxLength: 1024

A numerical value that represents the portion or entity of the donut or stats chart.

boolean

hide_empty_legend

Optional

If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.

Label

label

Optional

Label that will be displayed for a UI element.

string

navigation

Optional

Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.

array of RenderConfiguration

render_configuration

Optional

Constraints: minItems: 0

Additional rendering or conditional evaluation of the field values to be performed, if any.

array of Tooltip

tooltip

Optional

Constraints: minItems: 0

Multi-line text to be shown on tooltip while hovering over the portion.

Property Of

DonutSection