Skip to content
v2.277.0

ConditionalFormattingIconProperty Struct ​

The formatting configuration for the icon.

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 conditionalFormattingIconProperty: quicksight.CfnTemplate.ConditionalFormattingIconProperty = {
  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',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

conditional_formatting_icon_property = quicksight.CfnTemplate.ConditionalFormattingIconProperty(
    custom_condition=quicksight.CfnTemplate.ConditionalFormattingCustomIconConditionProperty(
        expression="expression",
        icon_options=quicksight.CfnTemplate.ConditionalFormattingCustomIconOptionsProperty(
            icon="icon",
            unicode_icon="unicodeIcon"
        ),

        # the properties below are optional
        color="color",
        display_configuration=quicksight.CfnTemplate.ConditionalFormattingIconDisplayConfigurationProperty(
            icon_display_option="iconDisplayOption"
        )
    ),
    icon_set=quicksight.CfnTemplate.ConditionalFormattingIconSetProperty(
        expression="expression",

        # the properties below are optional
        icon_set_type="iconSetType"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

ConditionalFormattingIconProperty conditionalFormattingIconProperty = ConditionalFormattingIconProperty.builder()
        .customCondition(ConditionalFormattingCustomIconConditionProperty.builder()
                .expression("expression")
                .iconOptions(ConditionalFormattingCustomIconOptionsProperty.builder()
                        .icon("icon")
                        .unicodeIcon("unicodeIcon")
                        .build())

                // the properties below are optional
                .color("color")
                .displayConfiguration(ConditionalFormattingIconDisplayConfigurationProperty.builder()
                        .iconDisplayOption("iconDisplayOption")
                        .build())
                .build())
        .iconSet(ConditionalFormattingIconSetProperty.builder()
                .expression("expression")

                // the properties below are optional
                .iconSetType("iconSetType")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var conditionalFormattingIconProperty = new ConditionalFormattingIconProperty {
    CustomCondition = new ConditionalFormattingCustomIconConditionProperty {
        Expression = "expression",
        IconOptions = new ConditionalFormattingCustomIconOptionsProperty {
            Icon = "icon",
            UnicodeIcon = "unicodeIcon"
        },

        // the properties below are optional
        Color = "color",
        DisplayConfiguration = new ConditionalFormattingIconDisplayConfigurationProperty {
            IconDisplayOption = "iconDisplayOption"
        }
    },
    IconSet = new ConditionalFormattingIconSetProperty {
        Expression = "expression",

        // the properties below are optional
        IconSetType = "iconSetType"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

conditionalFormattingIconProperty := &ConditionalFormattingIconProperty{
	CustomCondition: &ConditionalFormattingCustomIconConditionProperty{
		Expression: jsii.String("expression"),
		IconOptions: &ConditionalFormattingCustomIconOptionsProperty{
			Icon: jsii.String("icon"),
			UnicodeIcon: jsii.String("unicodeIcon"),
		},

		// the properties below are optional
		Color: jsii.String("color"),
		DisplayConfiguration: &ConditionalFormattingIconDisplayConfigurationProperty{
			IconDisplayOption: jsii.String("iconDisplayOption"),
		},
	},
	IconSet: &ConditionalFormattingIconSetProperty{
		Expression: jsii.String("expression"),

		// the properties below are optional
		IconSetType: jsii.String("iconSetType"),
	},
}

Properties ​

customConditionoptionalIResolvable | CfnTemplate.ConditionalFormattingCustomIconConditionPropertycustom_conditionoptionaltyping.Union[IResolvable, ConditionalFormattingCustomIconConditionProperty]customConditionoptionalIResolvableCustomConditionoptionalIResolvableCustomConditionoptionalinterface{}#
Determines the custom condition for an icon set.
iconSetoptionalIResolvable | CfnTemplate.ConditionalFormattingIconSetPropertyicon_setoptionaltyping.Union[IResolvable, ConditionalFormattingIconSetProperty]iconSetoptionalIResolvableIconSetoptionalIResolvableIconSetoptionalinterface{}#
Formatting configuration for icon set.