# LegendOptions


The options for the legend setup of a visual.

## Contents


**Note**  
In the following list, the required parameters are described first.

 ** Height **   <a name="QS-Type-LegendOptions-Height"></a>
The height of the legend. If this value is omitted, a default height is used when rendering.  
Type: String  
Required: No

 ** Position **   <a name="QS-Type-LegendOptions-Position"></a>
The positions for the legend. Choose one of the following options:  
+  `AUTO` 
+  `RIGHT` 
+  `BOTTOM` 
+  `LEFT` 
Type: String  
Valid Values: `AUTO | RIGHT | BOTTOM | TOP`   
Required: No

 ** Title **   <a name="QS-Type-LegendOptions-Title"></a>
The custom title for the legend.  
Type: [LabelOptions](API_LabelOptions.md) object  
Required: No

 ** ValueFontConfiguration **   <a name="QS-Type-LegendOptions-ValueFontConfiguration"></a>
Configures the display properties of the given text.  
Type: [FontConfiguration](API_FontConfiguration.md) object  
Required: No

 ** Visibility **   <a name="QS-Type-LegendOptions-Visibility"></a>
Determines whether or not the legend is visible.  
Type: String  
Valid Values: `HIDDEN | VISIBLE`   
Required: No

 ** Width **   <a name="QS-Type-LegendOptions-Width"></a>
The width of the legend. If this value is omitted, a default width is used when rendering.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/LegendOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/LegendOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/LegendOptions)