Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

LegendOptions - Amazon QuickSight

LegendOptions

The options for the legend setup of a visual.

Contents

Note

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

Height

The height of the legend. If this value is omitted, a default height is used when rendering.

Type: String

Required: No

Position

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

The custom title for the legend.

Type: LabelOptions object

Required: No

ValueFontConfiguration

Configures the display properties of the given text.

Type: FontConfiguration object

Required: No

Visibility

Determines whether or not the legend is visible.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

Width

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:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.