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() .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()) .comparisonMethod("comparisonMethod") .build()) .primaryValueDisplayType("primaryValueDisplayType") .primaryValueFontConfiguration(FontConfigurationProperty.builder() .fontColor("fontColor") .fontDecoration("fontDecoration") .fontSize(FontSizeProperty.builder() .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") .fontSize(FontSizeProperty.builder() .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.KPIOptionsProperty
static final class
An implementation forCfnTemplate.KPIOptionsProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The comparison configuration of a KPI visual.default String
The options that determine the primary value display type.default Object
The options that determine the primary value font configuration.default Object
The options that determine the presentation of the progress bar of a KPI visual.default Object
The options that determine the presentation of the secondary value of a KPI visual.default Object
The options that determine the secondary value font configuration.default Object
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.default Object
The options that determine the presentation of trend arrows in a KPI visual.default Object
The options that determine the layout a KPI visual.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComparison
The comparison configuration of a KPI visual.- See Also:
-
getPrimaryValueDisplayType
The options that determine the primary value display type.- See Also:
-
getPrimaryValueFontConfiguration
The options that determine the primary value font configuration.- See Also:
-
getProgressBar
The options that determine the presentation of the progress bar of a KPI visual.- See Also:
-
getSecondaryValue
The options that determine the presentation of the secondary value of a KPI visual.- See Also:
-
getSecondaryValueFontConfiguration
The options that determine the secondary value font configuration.- See Also:
-
getSparkline
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.- See Also:
-
getTrendArrows
The options that determine the presentation of trend arrows in a KPI visual.- See Also:
-
getVisualLayoutOptions
The options that determine the layout a KPI visual.- See Also:
-
builder
-