aws-cdk-lib.aws_quicksight.CfnTemplate.KPIConditionalFormattingOptionProperty

interface KPIConditionalFormattingOptionProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.KPIConditionalFormattingOptionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_KPIConditionalFormattingOptionProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.KPIConditionalFormattingOptionProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.KPIConditionalFormattingOptionProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » 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.CfnTemplate.KPIConditionalFormattingOptionProperty = {
  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

NameTypeDescription
primaryValue?IResolvable | KPIPrimaryValueConditionalFormattingPropertyThe conditional formatting for the primary value of a KPI visual.
progressBar?IResolvable | KPIProgressBarConditionalFormattingPropertyThe conditional formatting for the progress bar 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.