primaryValueDisplayTypestringprimary_value_display_typestrprimaryValueDisplayTypeStringPrimaryValueDisplayTypestringPrimaryValueDisplayType*string#The options that determine the primary value display type.
KPIOptionsProperty Struct
The options that determine the presentation of a KPI visual.
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 kPIOptionsProperty: quicksight.CfnDashboard.KPIOptionsProperty = {
comparison: {
comparisonFormat: {
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',
},
},
comparisonMethod: 'comparisonMethod',
},
primaryValueDisplayType: 'primaryValueDisplayType',
primaryValueFontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontFamily: 'fontFamily',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
progressBar: {
visibility: 'visibility',
},
secondaryValue: {
visibility: 'visibility',
},
secondaryValueFontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontFamily: 'fontFamily',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
sparkline: {
type: 'type',
// the properties below are optional
color: 'color',
tooltipVisibility: 'tooltipVisibility',
visibility: 'visibility',
},
trendArrows: {
visibility: 'visibility',
},
visualLayoutOptions: {
standardLayout: {
type: 'type',
},
},
};
Properties
comparisonIResolvable | CfnDashboard.ComparisonConfigurationPropertycomparisontyping.Union[IResolvable, ComparisonConfigurationProperty]comparisonIResolvableComparisonIResolvableComparisoninterface{}#The comparison configuration of a KPI visual.
primaryValueFontConfigurationIResolvable | CfnDashboard.FontConfigurationPropertyprimary_value_font_configurationtyping.Union[IResolvable, FontConfigurationProperty]primaryValueFontConfigurationIResolvablePrimaryValueFontConfigurationIResolvablePrimaryValueFontConfigurationinterface{}#The options that determine the primary value font configuration.
progressBarIResolvable | CfnDashboard.ProgressBarOptionsPropertyprogress_bartyping.Union[IResolvable, ProgressBarOptionsProperty]progressBarIResolvableProgressBarIResolvableProgressBarinterface{}#The options that determine the presentation of the progress bar of a KPI visual.
secondaryValueIResolvable | CfnDashboard.SecondaryValueOptionsPropertysecondary_valuetyping.Union[IResolvable, SecondaryValueOptionsProperty]secondaryValueIResolvableSecondaryValueIResolvableSecondaryValueinterface{}#The options that determine the presentation of the secondary value of a KPI visual.
secondaryValueFontConfigurationIResolvable | CfnDashboard.FontConfigurationPropertysecondary_value_font_configurationtyping.Union[IResolvable, FontConfigurationProperty]secondaryValueFontConfigurationIResolvableSecondaryValueFontConfigurationIResolvableSecondaryValueFontConfigurationinterface{}#The options that determine the secondary value font configuration.
sparklineIResolvable | CfnDashboard.KPISparklineOptionsPropertysparklinetyping.Union[IResolvable, KPISparklineOptionsProperty]sparklineIResolvableSparklineIResolvableSparklineinterface{}#The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
trendArrowsIResolvable | CfnDashboard.TrendArrowOptionsPropertytrend_arrowstyping.Union[IResolvable, TrendArrowOptionsProperty]trendArrowsIResolvableTrendArrowsIResolvableTrendArrowsinterface{}#The options that determine the presentation of trend arrows in a KPI visual.
visualLayoutOptionsIResolvable | CfnDashboard.KPIVisualLayoutOptionsPropertyvisual_layout_optionstyping.Union[IResolvable, KPIVisualLayoutOptionsProperty]visualLayoutOptionsIResolvableVisualLayoutOptionsIResolvableVisualLayoutOptionsinterface{}#The options that determine the layout a KPI visual.