interface KPIOptionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnTemplate.KPIOptionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_KPIOptionsProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnTemplate.KPIOptionsProperty`
Python	`aws_cdk.aws_quicksight.CfnTemplate.KPIOptionsProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnTemplate` » `KPIOptionsProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const kPIOptionsProperty: quicksight.CfnTemplate.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

Name	Type	Description
comparison?	`IResolvable` `\|` `ComparisonConfigurationProperty`	The comparison configuration of a KPI visual.
primaryValueDisplayType?	`string`	The options that determine the primary value display type.
primaryValueFontConfiguration?	`IResolvable` `\|` `FontConfigurationProperty`	The options that determine the primary value font configuration.
progressBar?	`IResolvable` `\|` `ProgressBarOptionsProperty`	The options that determine the presentation of the progress bar of a KPI visual.
secondaryValue?	`IResolvable` `\|` `SecondaryValueOptionsProperty`	The options that determine the presentation of the secondary value of a KPI visual.
secondaryValueFontConfiguration?	`IResolvable` `\|` `FontConfigurationProperty`	The options that determine the secondary value font configuration.
sparkline?	`IResolvable` `\|` `KPISparklineOptionsProperty`	The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
trendArrows?	`IResolvable` `\|` `TrendArrowOptionsProperty`	The options that determine the presentation of trend arrows in a KPI visual.
visualLayoutOptions?	`IResolvable` `\|` `KPIVisualLayoutOptionsProperty`	The options that determine the layout a KPI visual.