Legend

Represents legend that describes the entities of the widget.


Properties

string
alignment Optional

Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.

Possible values are: HORIZONTALVERTICAL


boolean
display_count Optional

If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.


string
position Optional

Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.

Possible values are: TOPBOTTOMLEFTRIGHTTOP_RIGHT


string
type Optional

Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity’s details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.

Possible values are: CIRCLE

JSON Example

{
    "alignment": "string",
    "display_count": false,
    "position": "string",
    "type": "string"
}
Feedback

Was this page helpful?