interface ComparisonConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.ComparisonConfigurationProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.ComparisonConfigurationProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.ComparisonConfigurationProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » ComparisonConfigurationProperty

The comparison display configuration of a KPI or gauge chart.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const comparisonConfigurationProperty: quicksight.CfnTemplate.ComparisonConfigurationProperty = {
  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',
};

Properties

Name	Type	Description
comparisonFormat?	IResolvable | ComparisonFormatConfigurationProperty	The format of the comparison.
comparisonMethod?	string	The method of the comparison. Choose from the following options:.

---

comparisonFormat?

Type: IResolvable | ComparisonFormatConfigurationProperty (optional)

The format of the comparison.

---

comparisonMethod?

Type: string (optional)

The method of the comparison. Choose from the following options:.

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT