Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.KPIOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.KPIOptionsProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

The options that determine the presentation of a KPI visual.

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.*;
 KPIOptionsProperty kPIOptionsProperty = KPIOptionsProperty.builder()
         .comparison(ComparisonConfigurationProperty.builder()
                 .comparisonFormat(ComparisonFormatConfigurationProperty.builder()
                         .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())
                 .comparisonMethod("comparisonMethod")
                 .build())
         .primaryValueDisplayType("primaryValueDisplayType")
         .primaryValueFontConfiguration(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())
         .progressBar(ProgressBarOptionsProperty.builder()
                 .visibility("visibility")
                 .build())
         .secondaryValue(SecondaryValueOptionsProperty.builder()
                 .visibility("visibility")
                 .build())
         .secondaryValueFontConfiguration(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())
         .sparkline(KPISparklineOptionsProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .color("color")
                 .tooltipVisibility("tooltipVisibility")
                 .visibility("visibility")
                 .build())
         .trendArrows(TrendArrowOptionsProperty.builder()
                 .visibility("visibility")
                 .build())
         .visualLayoutOptions(KPIVisualLayoutOptionsProperty.builder()
                 .standardLayout(KPIVisualStandardLayoutProperty.builder()
                         .type("type")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.KPIOptionsProperty.Builder	builder()
default Object	getComparison()	The comparison configuration of a KPI visual.
default String	getPrimaryValueDisplayType()	The options that determine the primary value display type.
default Object	getPrimaryValueFontConfiguration()	The options that determine the primary value font configuration.
default Object	getProgressBar()	The options that determine the presentation of the progress bar of a KPI visual.
default Object	getSecondaryValue()	The options that determine the presentation of the secondary value of a KPI visual.
default Object	getSecondaryValueFontConfiguration()	The options that determine the secondary value font configuration.
default Object	getSparkline()	The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
default Object	getTrendArrows()	The options that determine the presentation of trend arrows in a KPI visual.
default Object	getVisualLayoutOptions()	The options that determine the layout a KPI visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComparison

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

The comparison configuration of a KPI visual.

Returns union: either IResolvable or CfnTemplate.ComparisonConfigurationProperty

See Also:

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

getPrimaryValueDisplayType

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

The options that determine the primary value display type.

See Also:

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

getPrimaryValueFontConfiguration

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

The options that determine the primary value font configuration.

Returns union: either IResolvable or CfnTemplate.FontConfigurationProperty

See Also:

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

getProgressBar

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

The options that determine the presentation of the progress bar of a KPI visual.

Returns union: either IResolvable or CfnTemplate.ProgressBarOptionsProperty

See Also:

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

getSecondaryValue

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

The options that determine the presentation of the secondary value of a KPI visual.

Returns union: either IResolvable or CfnTemplate.SecondaryValueOptionsProperty

See Also:

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

getSecondaryValueFontConfiguration

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

The options that determine the secondary value font configuration.

Returns union: either IResolvable or CfnTemplate.FontConfigurationProperty

See Also:

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

getSparkline

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

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPISparklineOptionsProperty

See Also:

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

getTrendArrows

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

The options that determine the presentation of trend arrows in a KPI visual.

Returns union: either IResolvable or CfnTemplate.TrendArrowOptionsProperty

See Also:

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

getVisualLayoutOptions

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

The options that determine the layout a KPI visual.

Returns union: either IResolvable or CfnTemplate.KPIVisualLayoutOptionsProperty

See Also:

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

builder

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

Returns:

a CfnTemplate.KPIOptionsProperty.Builder of CfnTemplate.KPIOptionsProperty