NSX-T Data Center REST API
Legend (schema)
Legend for the widget
Represents legend that describes the entities of the widget.
| Name | Description | Type | Notes |
|---|---|---|---|
| alignment | Alignment of the legend 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. |
string | Enum: HORIZONTAL, VERTICAL Default: "VERTICAL" |
| display_count | Show count of entities in the legend If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend. |
boolean | Default: "True" |
| display_mode | Display mode for legends. Display mode for legends. |
string | Enum: SHOW_ALL_LEGENDS, SHOW_MIN_NO_OF_LEGENDS, SHOW_OTHER_GROUP_WITH_LEGENDS Default: "SHOW_ALL_LEGENDS" |
| filterable | Show checkbox along with legends if value is set to true 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. |
boolean | Default: "False" |
| min_legends_display_count | A minimum number of legends to be displayed. 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. |
int | Minimum: 1 Maximum: 12 Default: "3" |
| other_group_legend_label | A label for showing other category in legends. A translated label for showing other category label in legends. |
string | Default: "WIDGET_LABEL_OTHER_LEGEND_LABEL" |
| position | Placement of legend 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. |
string | Enum: TOP, BOTTOM, LEFT, RIGHT, TOP_RIGHT Default: "RIGHT" |
| type | Type of the legend 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 | Enum: CIRCLE Default: "CIRCLE" |
| unit | Show unit of entities in the legend Show unit of entities in the legend. |
string |