aws-cdk-lib.aws_quicksight.CfnTemplate.LegendOptionsProperty

LegendOptionsProperty Struct

The options for the legend setup of a visual.

Source

Generated code

Type last changed

v2.172.0 · 7 Dec 2024

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.CfnTemplate.LegendOptionsProperty = {
  height: 'height',
  position: 'position',
  title: {
    customLabel: 'customLabel',
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    visibility: 'visibility',
  },
  valueFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  visibility: 'visibility',
  width: 'width',
};

Properties

heightstringheightstrheightStringHeightstringHeight*string#

The height of the legend.

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

positionstringpositionstrpositionStringPositionstringPosition*string#

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

• AUTO
• RIGHT
• BOTTOM
• LEFT

titleIResolvable | CfnTemplate.LabelOptionsPropertytitletyping.Union[IResolvable, LabelOptionsProperty]titleIResolvableTitleIResolvableTitleinterface{}#

The custom title for the legend.

valueFontConfigurationIResolvable | CfnTemplate.FontConfigurationPropertyvalue_font_configurationtyping.Union[IResolvable, FontConfigurationProperty]valueFontConfigurationIResolvableValueFontConfigurationIResolvableValueFontConfigurationinterface{}#

visibilitystringvisibilitystrvisibilityStringVisibilitystringVisibility*string#

Determines whether or not the legend is visible.

widthstringwidthstrwidthStringWidthstringWidth*string#

The width of the legend.

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