interface KPIConditionalFormattingProperty

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

The conditional formatting of a KPI visual.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformatting.html

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 kPIConditionalFormattingProperty: quicksight.CfnAnalysis.KPIConditionalFormattingProperty = {
  conditionalFormattingOptions: [{
    actualValue: {
      icon: {
        customCondition: {
          expression: 'expression',
          iconOptions: {
            icon: 'icon',
            unicodeIcon: 'unicodeIcon',
          },

          // the properties below are optional
          color: 'color',
          displayConfiguration: {
            iconDisplayOption: 'iconDisplayOption',
          },
        },
        iconSet: {
          expression: 'expression',

          // the properties below are optional
          iconSetType: 'iconSetType',
        },
      },
      textColor: {
        gradient: {
          color: {
            stops: [{
              gradientOffset: 123,

              // the properties below are optional
              color: 'color',
              dataValue: 123,
            }],
          },
          expression: 'expression',
        },
        solid: {
          expression: 'expression',

          // the properties below are optional
          color: 'color',
        },
      },
    },
    comparisonValue: {
      icon: {
        customCondition: {
          expression: 'expression',
          iconOptions: {
            icon: 'icon',
            unicodeIcon: 'unicodeIcon',
          },

          // the properties below are optional
          color: 'color',
          displayConfiguration: {
            iconDisplayOption: 'iconDisplayOption',
          },
        },
        iconSet: {
          expression: 'expression',

          // the properties below are optional
          iconSetType: 'iconSetType',
        },
      },
      textColor: {
        gradient: {
          color: {
            stops: [{
              gradientOffset: 123,

              // the properties below are optional
              color: 'color',
              dataValue: 123,
            }],
          },
          expression: 'expression',
        },
        solid: {
          expression: 'expression',

          // the properties below are optional
          color: 'color',
        },
      },
    },
    primaryValue: {
      icon: {
        customCondition: {
          expression: 'expression',
          iconOptions: {
            icon: 'icon',
            unicodeIcon: 'unicodeIcon',
          },

          // the properties below are optional
          color: 'color',
          displayConfiguration: {
            iconDisplayOption: 'iconDisplayOption',
          },
        },
        iconSet: {
          expression: 'expression',

          // the properties below are optional
          iconSetType: 'iconSetType',
        },
      },
      textColor: {
        gradient: {
          color: {
            stops: [{
              gradientOffset: 123,

              // the properties below are optional
              color: 'color',
              dataValue: 123,
            }],
          },
          expression: 'expression',
        },
        solid: {
          expression: 'expression',

          // the properties below are optional
          color: 'color',
        },
      },
    },
    progressBar: {
      foregroundColor: {
        gradient: {
          color: {
            stops: [{
              gradientOffset: 123,

              // the properties below are optional
              color: 'color',
              dataValue: 123,
            }],
          },
          expression: 'expression',
        },
        solid: {
          expression: 'expression',

          // the properties below are optional
          color: 'color',
        },
      },
    },
  }],
};

Properties

Name	Type	Description
conditionalFormattingOptions?	IResolvable | (IResolvable | KPIConditionalFormattingOptionProperty)[]	The conditional formatting options of a KPI visual.

---

conditionalFormattingOptions?

Type: IResolvable | (IResolvable | KPIConditionalFormattingOptionProperty)[] (optional)

The conditional formatting options of a KPI visual.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformatting.html#cfn-quicksight-analysis-kpiconditionalformatting-conditionalformattingoptions