aws-cdk-lib.aws_quicksight.CfnDashboard.KPIConditionalFormattingOptionProperty

KPIConditionalFormattingOptionProperty Struct

The conditional formatting options of a KPI visual.

Source

Generated code

Type last changed

v2.101.0 · 13 Oct 2023

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.CfnDashboard.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

actualValue?optionalIResolvable | CfnDashboard.KPIActualValueConditionalFormattingPropertyactual_value?optionaltyping.Union[IResolvable, KPIActualValueConditionalFormattingProperty]actualValue?optionalIResolvableActualValue?optionalIResolvableActualValue?optionalinterface{}#

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

comparisonValue?optionalIResolvable | CfnDashboard.KPIComparisonValueConditionalFormattingPropertycomparison_value?optionaltyping.Union[IResolvable, KPIComparisonValueConditionalFormattingProperty]comparisonValue?optionalIResolvableComparisonValue?optionalIResolvableComparisonValue?optionalinterface{}#

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

primaryValue?optionalIResolvable | CfnDashboard.KPIPrimaryValueConditionalFormattingPropertyprimary_value?optionaltyping.Union[IResolvable, KPIPrimaryValueConditionalFormattingProperty]primaryValue?optionalIResolvablePrimaryValue?optionalIResolvablePrimaryValue?optionalinterface{}#

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

progressBar?optionalIResolvable | CfnDashboard.KPIProgressBarConditionalFormattingPropertyprogress_bar?optionaltyping.Union[IResolvable, KPIProgressBarConditionalFormattingProperty]progressBar?optionalIResolvableProgressBar?optionalIResolvableProgressBar?optionalinterface{}#

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