interface PivotTableCellConditionalFormattingProperty

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

The cell conditional formatting option for a pivot table.

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 pivotTableCellConditionalFormattingProperty: quicksight.CfnDashboard.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

Name	Type	Description
fieldId	`string`	The field ID of the cell for conditional formatting.
scope?	`IResolvable` `\|` `PivotTableConditionalFormattingScopeProperty`	The scope of the cell for conditional formatting.
scopes?	`IResolvable` `\|` `IResolvable` `\|` `PivotTableConditionalFormattingScopeProperty[]`	A list of cell scopes for conditional formatting.
textFormat?	`IResolvable` `\|` `TextConditionalFormatProperty`	The text format of the cell for conditional formatting.

fieldId

Type: string

The field ID of the cell for conditional formatting.

scope?

Type: IResolvable | PivotTableConditionalFormattingScopeProperty (optional)

The scope of the cell for conditional formatting.

scopes?

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

A list of cell scopes for conditional formatting.

textFormat?

Type: IResolvable | TextConditionalFormatProperty (optional)

The text format of the cell for conditional formatting.