aws-cdk-lib.aws_quicksight.CfnAnalysis.KPIOptionsProperty

interface KPIOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.KPIOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_KPIOptionsProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.KPIOptionsProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.KPIOptionsProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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.CfnAnalysis.KPIOptionsProperty = {
  comparison: {
    comparisonFormat: {
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
    comparisonMethod: 'comparisonMethod',
  },
  primaryValueDisplayType: 'primaryValueDisplayType',
  primaryValueFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontSize: {
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  progressBar: {
    visibility: 'visibility',
  },
  secondaryValue: {
    visibility: 'visibility',
  },
  secondaryValueFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontSize: {
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  trendArrows: {
    visibility: 'visibility',
  },
};

Properties

NameTypeDescription
comparison?IResolvable | ComparisonConfigurationPropertyThe comparison configuration of a KPI visual.
primaryValueDisplayType?stringThe options that determine the primary value display type.
primaryValueFontConfiguration?IResolvable | FontConfigurationPropertyThe options that determine the primary value font configuration.
progressBar?IResolvable | ProgressBarOptionsPropertyThe options that determine the presentation of the progress bar of a KPI visual.
secondaryValue?IResolvable | SecondaryValueOptionsPropertyThe options that determine the presentation of the secondary value of a KPI visual.
secondaryValueFontConfiguration?IResolvable | FontConfigurationPropertyThe options that determine the secondary value font configuration.
trendArrows?IResolvable | TrendArrowOptionsPropertyThe options that determine the presentation of trend arrows in a KPI visual.

comparison?

Type: IResolvable | ComparisonConfigurationProperty (optional)

The comparison configuration of a KPI visual.


primaryValueDisplayType?

Type: string (optional)

The options that determine the primary value display type.


primaryValueFontConfiguration?

Type: IResolvable | FontConfigurationProperty (optional)

The options that determine the primary value font configuration.


progressBar?

Type: IResolvable | ProgressBarOptionsProperty (optional)

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


secondaryValue?

Type: IResolvable | SecondaryValueOptionsProperty (optional)

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


secondaryValueFontConfiguration?

Type: IResolvable | FontConfigurationProperty (optional)

The options that determine the secondary value font configuration.


trendArrows?

Type: IResolvable | TrendArrowOptionsProperty (optional)

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