Legend

Legend
Legend

Represents legend that describes the entities of the widget.

JSON Example
{
    "alignment": "string",
    "display_count": false,
    "display_mode": "string",
    "filterable": false,
    "min_legends_display_count": 0,
    "other_group_legend_label": "string",
    "position": "string",
    "type": "string",
    "unit": "string"
}
string
alignment
Optional
Constraints: default: VERTICAL

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 : HORIZONTAL, VERTICAL,
boolean
display_count
Optional
Constraints: default: true

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
display_mode
Optional
Constraints: default: SHOW_ALL_LEGENDS

Display mode for legends.

Possible values are : SHOW_ALL_LEGENDS, SHOW_MIN_NO_OF_LEGENDS, SHOW_OTHER_GROUP_WITH_LEGENDS,
boolean
filterable
Optional

Show checkbox along with legends if value is set to true. Widget filtering capability can be enable based on legend checkbox selection. for 'display_mode' SHOW_OTHER_GROUP_WITH_LEGENDS filterable property is not supported.

integer As int32 As int32
min_legends_display_count
Optional
Constraints: minimum: 1 maximum: 12 default: 3

A minimum number of legends to be displayed upfront. if 'display_mode' is set to SHOW_MIN_NO_OF_LEGENDS then this property value will be used to display number of legends upfront in the UI.

string
other_group_legend_label
Optional
Constraints: default: WIDGET_LABEL_OTHER_LEGEND_LABEL

A translated label for showing other category label in legends.

string
position
Optional
Constraints: default: RIGHT

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 : TOP, BOTTOM, LEFT, RIGHT, TOP_RIGHT,
string
type
Optional
Constraints: default: CIRCLE

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.

string
unit
Optional

Show unit of entities in the legend.