aws-cdk-lib.aws_quicksight.CfnAnalysis.LegendOptionsProperty

interface LegendOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.LegendOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_LegendOptionsProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.LegendOptionsProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.LegendOptionsProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const legendOptionsProperty: quicksight.CfnAnalysis.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

NameTypeDescription
height?stringThe height of the legend.
position?stringThe positions for the legend. Choose one of the following options:.
title?IResolvable | LabelOptionsPropertyThe custom title for the legend.
visibility?stringDetermines whether or not the legend is visible.
width?stringThe 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.