interface KPIConditionalFormattingOptionProperty

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

The conditional formatting options 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 kPIConditionalFormattingOptionProperty: quicksight.CfnAnalysis.KPIConditionalFormattingOptionProperty = {
  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
actualValue?	`IResolvable` `\|` `KPIActualValueConditionalFormattingProperty`	The conditional formatting for the actual value of a KPI visual.
comparisonValue?	`IResolvable` `\|` `KPIComparisonValueConditionalFormattingProperty`	The conditional formatting for the comparison value of a KPI visual.
primaryValue?	`IResolvable` `\|` `KPIPrimaryValueConditionalFormattingProperty`	The conditional formatting for the primary value of a KPI visual.
progressBar?	`IResolvable` `\|` `KPIProgressBarConditionalFormattingProperty`	The conditional formatting for the progress bar of a KPI visual.

actualValue?

Type: IResolvable | KPIActualValueConditionalFormattingProperty (optional)

The conditional formatting for the actual value of a KPI visual.

comparisonValue?

Type: IResolvable | KPIComparisonValueConditionalFormattingProperty (optional)

The conditional formatting for the comparison value of a KPI visual.

primaryValue?

Type: IResolvable | KPIPrimaryValueConditionalFormattingProperty (optional)

The conditional formatting for the primary value of a KPI visual.

progressBar?

Type: IResolvable | KPIProgressBarConditionalFormattingProperty (optional)

The conditional formatting for the progress bar of a KPI visual.