com.vmware.nsx.model

Class Legend.Builder

java.lang.Object

com.vmware.nsx.model.Legend.Builder

Enclosing class:

Legend

public static final class Legend.Builder
extends java.lang.Object

Builder class for Legend.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of Legend.

Method Summary

Modifier and Type	Method and Description
Legend	build()
Legend.Builder	setAlignment(java.lang.String alignment) Possible values are: Legend.ALIGNMENT_HORIZONTAL Legend.ALIGNMENT_VERTICAL Describes the alignment of legend.
Legend.Builder	setDisplayCount(java.lang.Boolean displayCount) If set to true, it will display the counts in legend.
Legend.Builder	setDisplayMode(java.lang.String displayMode) Possible values are: Legend.DISPLAY_MODE_ALL_LEGENDS Legend.DISPLAY_MODE_MIN_NO_OF_LEGENDS Legend.DISPLAY_MODE_OTHER_GROUP_WITH_LEGENDS Display mode for legends.
Legend.Builder	setFilterable(java.lang.Boolean filterable) Show checkbox along with legends if value is set to true.
Legend.Builder	setMinLegendsDisplayCount(java.lang.Long minLegendsDisplayCount) A minimum number of legends to be displayed upfront.
Legend.Builder	setOtherGroupLegendLabel(java.lang.String otherGroupLegendLabel) A translated label for showing other category label in legends.
Legend.Builder	setPosition(java.lang.String position) Possible values are: Legend.POSITION_TOP Legend.POSITION_BOTTOM Legend.POSITION_LEFT Legend.POSITION_RIGHT Legend.POSITION_TOP_RIGHT Describes the relative placement of legend.
Legend.Builder	setType(java.lang.String type) Possible values are: Legend.TYPE_CIRCLE Describes the render type for the legend.
Legend.Builder	setUnit(java.lang.String unit) Show unit of entities in the legend.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of Legend.

Method Detail

setAlignment

public Legend.Builder setAlignment(java.lang.String alignment)

Possible values are:

• Legend.ALIGNMENT_HORIZONTAL
• Legend.ALIGNMENT_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.

Parameters:

alignment - New value for the property.

setDisplayCount

public Legend.Builder setDisplayCount(java.lang.Boolean displayCount)

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

Parameters:

displayCount - New value for the property.

setDisplayMode

public Legend.Builder setDisplayMode(java.lang.String displayMode)

Possible values are:

• Legend.DISPLAY_MODE_ALL_LEGENDS
• Legend.DISPLAY_MODE_MIN_NO_OF_LEGENDS
• Legend.DISPLAY_MODE_OTHER_GROUP_WITH_LEGENDS

Display mode for legends.

Parameters:

displayMode - New value for the property.

setFilterable

public Legend.Builder setFilterable(java.lang.Boolean filterable)

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.

Parameters:

filterable - New value for the property.

setMinLegendsDisplayCount

public Legend.Builder setMinLegendsDisplayCount(java.lang.Long minLegendsDisplayCount)

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. format: int32

Parameters:

minLegendsDisplayCount - New value for the property.

setOtherGroupLegendLabel

public Legend.Builder setOtherGroupLegendLabel(java.lang.String otherGroupLegendLabel)

A translated label for showing other category label in legends.

Parameters:

otherGroupLegendLabel - New value for the property.

setPosition

public Legend.Builder setPosition(java.lang.String position)

Possible values are:

• Legend.POSITION_TOP
• Legend.POSITION_BOTTOM
• Legend.POSITION_LEFT
• Legend.POSITION_RIGHT
• Legend.POSITION_TOP_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.

Parameters:

position - New value for the property.

setType

public Legend.Builder setType(java.lang.String type)

Possible values are:

• Legend.TYPE_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.

Parameters:

type - New value for the property.

setUnit

public Legend.Builder setUnit(java.lang.String unit)

Show unit of entities in the legend.

Parameters:

unit - New value for the property.

build

public Legend build()