Skip to content
v2.277.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

reference_line_label_configuration_property = quicksight.CfnAnalysis.ReferenceLineLabelConfigurationProperty(
    custom_label_configuration=quicksight.CfnAnalysis.ReferenceLineCustomLabelConfigurationProperty(
        custom_label="customLabel"
    ),
    font_color="fontColor",
    font_configuration=quicksight.CfnAnalysis.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight.CfnAnalysis.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnAnalysis.FontWeightProperty(
            name="name"
        )
    ),
    horizontal_position="horizontalPosition",
    value_label_configuration=quicksight.CfnAnalysis.ReferenceLineValueLabelConfigurationProperty(
        format_configuration=quicksight.CfnAnalysis.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnAnalysis.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnAnalysis.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnAnalysis.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        relative_position="relativePosition"
    ),
    vertical_position="verticalPosition"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

ReferenceLineLabelConfigurationProperty referenceLineLabelConfigurationProperty = ReferenceLineLabelConfigurationProperty.builder()
        .customLabelConfiguration(ReferenceLineCustomLabelConfigurationProperty.builder()
                .customLabel("customLabel")
                .build())
        .fontColor("fontColor")
        .fontConfiguration(FontConfigurationProperty.builder()
                .fontColor("fontColor")
                .fontDecoration("fontDecoration")
                .fontFamily("fontFamily")
                .fontSize(FontSizeProperty.builder()
                        .absolute("absolute")
                        .relative("relative")
                        .build())
                .fontStyle("fontStyle")
                .fontWeight(FontWeightProperty.builder()
                        .name("name")
                        .build())
                .build())
        .horizontalPosition("horizontalPosition")
        .valueLabelConfiguration(ReferenceLineValueLabelConfigurationProperty.builder()
                .formatConfiguration(NumericFormatConfigurationProperty.builder()
                        .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
                                .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                        .decimalPlaces(123)
                                        .build())
                                .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                        .displayMode("displayMode")
                                        .build())
                                .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                        .nullString("nullString")
                                        .build())
                                .numberScale("numberScale")
                                .prefix("prefix")
                                .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                        .decimalSeparator("decimalSeparator")
                                        .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                                .groupingStyle("groupingStyle")
                                                .symbol("symbol")
                                                .visibility("visibility")
                                                .build())
                                        .build())
                                .suffix("suffix")
                                .symbol("symbol")
                                .build())
                        .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
                                .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                        .decimalPlaces(123)
                                        .build())
                                .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                        .displayMode("displayMode")
                                        .build())
                                .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                        .nullString("nullString")
                                        .build())
                                .numberScale("numberScale")
                                .prefix("prefix")
                                .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                        .decimalSeparator("decimalSeparator")
                                        .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                                .groupingStyle("groupingStyle")
                                                .symbol("symbol")
                                                .visibility("visibility")
                                                .build())
                                        .build())
                                .suffix("suffix")
                                .build())
                        .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
                                .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                        .decimalPlaces(123)
                                        .build())
                                .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                        .displayMode("displayMode")
                                        .build())
                                .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                        .nullString("nullString")
                                        .build())
                                .prefix("prefix")
                                .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                        .decimalSeparator("decimalSeparator")
                                        .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                                .groupingStyle("groupingStyle")
                                                .symbol("symbol")
                                                .visibility("visibility")
                                                .build())
                                        .build())
                                .suffix("suffix")
                                .build())
                        .build())
                .relativePosition("relativePosition")
                .build())
        .verticalPosition("verticalPosition")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var referenceLineLabelConfigurationProperty = new ReferenceLineLabelConfigurationProperty {
    CustomLabelConfiguration = new ReferenceLineCustomLabelConfigurationProperty {
        CustomLabel = "customLabel"
    },
    FontColor = "fontColor",
    FontConfiguration = new FontConfigurationProperty {
        FontColor = "fontColor",
        FontDecoration = "fontDecoration",
        FontFamily = "fontFamily",
        FontSize = new FontSizeProperty {
            Absolute = "absolute",
            Relative = "relative"
        },
        FontStyle = "fontStyle",
        FontWeight = new FontWeightProperty {
            Name = "name"
        }
    },
    HorizontalPosition = "horizontalPosition",
    ValueLabelConfiguration = new ReferenceLineValueLabelConfigurationProperty {
        FormatConfiguration = new NumericFormatConfigurationProperty {
            CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                NumberScale = "numberScale",
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        GroupingStyle = "groupingStyle",
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix",
                Symbol = "symbol"
            },
            NumberDisplayFormatConfiguration = new NumberDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                NumberScale = "numberScale",
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        GroupingStyle = "groupingStyle",
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix"
            },
            PercentageDisplayFormatConfiguration = new PercentageDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        GroupingStyle = "groupingStyle",
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix"
            }
        },
        RelativePosition = "relativePosition"
    },
    VerticalPosition = "verticalPosition"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

referenceLineLabelConfigurationProperty := &ReferenceLineLabelConfigurationProperty{
	CustomLabelConfiguration: &ReferenceLineCustomLabelConfigurationProperty{
		CustomLabel: jsii.String("customLabel"),
	},
	FontColor: jsii.String("fontColor"),
	FontConfiguration: &FontConfigurationProperty{
		FontColor: jsii.String("fontColor"),
		FontDecoration: jsii.String("fontDecoration"),
		FontFamily: jsii.String("fontFamily"),
		FontSize: &FontSizeProperty{
			Absolute: jsii.String("absolute"),
			Relative: jsii.String("relative"),
		},
		FontStyle: jsii.String("fontStyle"),
		FontWeight: &FontWeightProperty{
			Name: jsii.String("name"),
		},
	},
	HorizontalPosition: jsii.String("horizontalPosition"),
	ValueLabelConfiguration: &ReferenceLineValueLabelConfigurationProperty{
		FormatConfiguration: &NumericFormatConfigurationProperty{
			CurrencyDisplayFormatConfiguration: &CurrencyDisplayFormatConfigurationProperty{
				DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
					DecimalPlaces: jsii.Number(123),
				},
				NegativeValueConfiguration: &NegativeValueConfigurationProperty{
					DisplayMode: jsii.String("displayMode"),
				},
				NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
					NullString: jsii.String("nullString"),
				},
				NumberScale: jsii.String("numberScale"),
				Prefix: jsii.String("prefix"),
				SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
					DecimalSeparator: jsii.String("decimalSeparator"),
					ThousandsSeparator: &ThousandSeparatorOptionsProperty{
						GroupingStyle: jsii.String("groupingStyle"),
						Symbol: jsii.String("symbol"),
						Visibility: jsii.String("visibility"),
					},
				},
				Suffix: jsii.String("suffix"),
				Symbol: jsii.String("symbol"),
			},
			NumberDisplayFormatConfiguration: &NumberDisplayFormatConfigurationProperty{
				DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
					DecimalPlaces: jsii.Number(123),
				},
				NegativeValueConfiguration: &NegativeValueConfigurationProperty{
					DisplayMode: jsii.String("displayMode"),
				},
				NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
					NullString: jsii.String("nullString"),
				},
				NumberScale: jsii.String("numberScale"),
				Prefix: jsii.String("prefix"),
				SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
					DecimalSeparator: jsii.String("decimalSeparator"),
					ThousandsSeparator: &ThousandSeparatorOptionsProperty{
						GroupingStyle: jsii.String("groupingStyle"),
						Symbol: jsii.String("symbol"),
						Visibility: jsii.String("visibility"),
					},
				},
				Suffix: jsii.String("suffix"),
			},
			PercentageDisplayFormatConfiguration: &PercentageDisplayFormatConfigurationProperty{
				DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
					DecimalPlaces: jsii.Number(123),
				},
				NegativeValueConfiguration: &NegativeValueConfigurationProperty{
					DisplayMode: jsii.String("displayMode"),
				},
				NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
					NullString: jsii.String("nullString"),
				},
				Prefix: jsii.String("prefix"),
				SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
					DecimalSeparator: jsii.String("decimalSeparator"),
					ThousandsSeparator: &ThousandSeparatorOptionsProperty{
						GroupingStyle: jsii.String("groupingStyle"),
						Symbol: jsii.String("symbol"),
						Visibility: jsii.String("visibility"),
					},
				},
				Suffix: jsii.String("suffix"),
			},
		},
		RelativePosition: jsii.String("relativePosition"),
	},
	VerticalPosition: jsii.String("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