AWS CDK Reference

Appearance

v2.274.0

PivotTableCellConditionalFormattingProperty Struct ​

The cell conditional formatting option for a pivot table.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// 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 pivotTableCellConditionalFormattingProperty: quicksight.CfnAnalysis.PivotTableCellConditionalFormattingProperty = {
  fieldId: 'fieldId',

  // the properties below are optional
  scope: {
    role: 'role',
  },
  scopes: [{
    role: 'role',
  }],
  textFormat: {
    backgroundColor: {
      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',
      },
    },
    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',
      },
    },
  },
};

Properties ​

fieldIdstringfield_idstrfieldIdStringFieldIdstringFieldId*stringrequired#
The field ID of the cell for conditional formatting.
scopeoptionalIResolvable | CfnAnalysis.PivotTableConditionalFormattingScopePropertyscopeoptionaltyping.Union[IResolvable, PivotTableConditionalFormattingScopeProperty]scopeoptionalIResolvableScopeoptionalIResolvableScopeoptionalinterface{}#
The scope of the cell for conditional formatting.
scopesoptionalIResolvable | IResolvable | CfnAnalysis.PivotTableConditionalFormattingScopeProperty[]scopesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableConditionalFormattingScopeProperty]]]scopesoptionalIResolvableScopesoptionalIResolvableScopesoptionalinterface{}#
A list of cell scopes for conditional formatting.
textFormatoptionalIResolvable | CfnAnalysis.TextConditionalFormatPropertytext_formatoptionaltyping.Union[IResolvable, TextConditionalFormatProperty]textFormatoptionalIResolvableTextFormatoptionalIResolvableTextFormatoptionalinterface{}#
The text format of the cell for conditional formatting.