Skip to content
v2.274.0

ReferenceLineLabelConfigurationProperty Struct ​

The label configuration of a reference line.

Example ​

ts
// 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 referenceLineLabelConfigurationProperty: quicksight.CfnAnalysis.ReferenceLineLabelConfigurationProperty = {
  customLabelConfiguration: {
    customLabel: 'customLabel',
  },
  fontColor: 'fontColor',
  fontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  horizontalPosition: 'horizontalPosition',
  valueLabelConfiguration: {
    formatConfiguration: {
      currencyDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
        symbol: 'symbol',
      },
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
    relativePosition: 'relativePosition',
  },
  verticalPosition: 'verticalPosition',
};

Properties ​

customLabelConfigurationoptionalIResolvable | CfnAnalysis.ReferenceLineCustomLabelConfigurationPropertycustom_label_configurationoptionaltyping.Union[IResolvable, ReferenceLineCustomLabelConfigurationProperty]customLabelConfigurationoptionalIResolvableCustomLabelConfigurationoptionalIResolvableCustomLabelConfigurationoptionalinterface{}#
The custom label configuration of the label in a reference line.
fontColoroptionalstringfont_coloroptionalstrfontColoroptionalStringFontColoroptionalstringFontColoroptional*string#
The font color configuration of the label in a reference line.
fontConfigurationoptionalIResolvable | CfnAnalysis.FontConfigurationPropertyfont_configurationoptionaltyping.Union[IResolvable, FontConfigurationProperty]fontConfigurationoptionalIResolvableFontConfigurationoptionalIResolvableFontConfigurationoptionalinterface{}#
The font configuration of the label in a reference line.
horizontalPositionoptionalstringhorizontal_positionoptionalstrhorizontalPositionoptionalStringHorizontalPositionoptionalstringHorizontalPositionoptional*string#
The horizontal position configuration of the label in a reference line. Choose one of the following options:.
  • LEFT
  • CENTER
  • RIGHT
valueLabelConfigurationoptionalIResolvable | CfnAnalysis.ReferenceLineValueLabelConfigurationPropertyvalue_label_configurationoptionaltyping.Union[IResolvable, ReferenceLineValueLabelConfigurationProperty]valueLabelConfigurationoptionalIResolvableValueLabelConfigurationoptionalIResolvableValueLabelConfigurationoptionalinterface{}#
The value label configuration of the label in a reference line.
verticalPositionoptionalstringvertical_positionoptionalstrverticalPositionoptionalStringVerticalPositionoptionalstringVerticalPositionoptional*string#
The vertical position configuration of the label in a reference line. Choose one of the following options:.
  • ABOVE
  • BELOW