Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.ReferenceLineProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.ReferenceLineProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.ReferenceLineProperty
extends software.amazon.jsii.JsiiSerializable

The reference line visual display options.

Example:

 // 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.*;
 ReferenceLineProperty referenceLineProperty = ReferenceLineProperty.builder()
         .dataConfiguration(ReferenceLineDataConfigurationProperty.builder()
                 .axisBinding("axisBinding")
                 .dynamicConfiguration(ReferenceLineDynamicDataConfigurationProperty.builder()
                         .calculation(NumericalAggregationFunctionProperty.builder()
                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                         .percentileValue(123)
                                         .build())
                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                 .build())
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         // the properties below are optional
                         .measureAggregationFunction(AggregationFunctionProperty.builder()
                                 .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                         .simpleAttributeAggregation("simpleAttributeAggregation")
                                         .valueForMultipleValues("valueForMultipleValues")
                                         .build())
                                 .categoricalAggregationFunction("categoricalAggregationFunction")
                                 .dateAggregationFunction("dateAggregationFunction")
                                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                         .percentileAggregation(PercentileAggregationProperty.builder()
                                                 .percentileValue(123)
                                                 .build())
                                         .simpleNumericalAggregation("simpleNumericalAggregation")
                                         .build())
                                 .build())
                         .build())
                 .seriesType("seriesType")
                 .staticConfiguration(ReferenceLineStaticDataConfigurationProperty.builder()
                         .value(123)
                         .build())
                 .build())
         // the properties below are optional
         .labelConfiguration(ReferenceLineLabelConfigurationProperty.builder()
                 .customLabelConfiguration(ReferenceLineCustomLabelConfigurationProperty.builder()
                         .customLabel("customLabel")
                         .build())
                 .fontColor("fontColor")
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontSize(FontSizeProperty.builder()
                                 .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()
                                                         .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()
                                                         .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()
                                                         .symbol("symbol")
                                                         .visibility("visibility")
                                                         .build())
                                                 .build())
                                         .suffix("suffix")
                                         .build())
                                 .build())
                         .relativePosition("relativePosition")
                         .build())
                 .verticalPosition("verticalPosition")
                 .build())
         .status("status")
         .styleConfiguration(ReferenceLineStyleConfigurationProperty.builder()
                 .color("color")
                 .pattern("pattern")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.ReferenceLineProperty.Builder	A builder for CfnTemplate.ReferenceLineProperty
static final class	CfnTemplate.ReferenceLineProperty.Jsii$Proxy	An implementation for CfnTemplate.ReferenceLineProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.ReferenceLineProperty.Builder	builder()
Object	getDataConfiguration()	The data configuration of the reference line.
default Object	getLabelConfiguration()	The label configuration of the reference line.
default String	getStatus()	The status of the reference line.
default Object	getStyleConfiguration()	The style configuration of the reference line.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataConfiguration

@Stability(Stable)
@NotNull
Object getDataConfiguration()

The data configuration of the reference line.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-dataconfiguration

getLabelConfiguration

@Stability(Stable)
@Nullable
default Object getLabelConfiguration()

The label configuration of the reference line.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-labelconfiguration

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the reference line. Choose one of the following options:.

• ENABLE
• DISABLE

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-status

getStyleConfiguration

@Stability(Stable)
@Nullable
default Object getStyleConfiguration()

The style configuration of the reference line.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-styleconfiguration

builder

@Stability(Stable)
static CfnTemplate.ReferenceLineProperty.Builder builder()

Returns:

a CfnTemplate.ReferenceLineProperty.Builder of CfnTemplate.ReferenceLineProperty