AWS::QuickSight::Dashboard LegendOptions

The options for the legend setup of a visual.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Height" : String,
  "Position" : String,
  "Title" : LabelOptions,
  "Visibility" : String,
  "Width" : String
}

YAML

  Height: String
  Position: String
  Title: 
    LabelOptions
  Visibility: String
  Width: String

Properties

Height

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

Required: No

Type: String

Update requires: No interruption

Position

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

Required: No

Type: String

Allowed values: AUTO | RIGHT | BOTTOM | TOP

Update requires: No interruption

Title

The custom title for the legend.

Required: No

Type: LabelOptions

Update requires: No interruption

Visibility

Determines whether or not the legend is visible.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

Width

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

Required: No

Type: String

Update requires: No interruption