interface LegendOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.LegendOptionsProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.LegendOptionsProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.LegendOptionsProperty
TypeScript	@aws-cdk/aws-quicksight » CfnDashboard » LegendOptionsProperty

The options for the legend setup of a visual.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const legendOptionsProperty: quicksight.CfnDashboard.LegendOptionsProperty = {
  height: 'height',
  position: 'position',
  title: {
    customLabel: 'customLabel',
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontSize: {
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    visibility: 'visibility',
  },
  visibility: 'visibility',
  width: 'width',
};

Properties

Name	Type	Description
height?	string	The height of the legend.
position?	string	The positions for the legend. Choose one of the following options:.
title?	IResolvable | LabelOptionsProperty	The custom title for the legend.
visibility?	string	Determines whether or not the legend is visible.
width?	string	The width of the legend.

---

height?

Type: string (optional)

The height of the legend.

If this value is omitted, a default height is used when rendering.

---

position?

Type: string (optional)

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

• AUTO
• RIGHT
• BOTTOM
• LEFT

---

title?

Type: IResolvable | LabelOptionsProperty (optional)

The custom title for the legend.

---

visibility?

Type: string (optional)

Determines whether or not the legend is visible.

---

width?

Type: string (optional)

The width of the legend.

If this value is omitted, a default width is used when rendering.