Package software.amazon.awscdk.services.quicksight

Interface CfnTheme.UIColorPaletteProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTheme.UIColorPaletteProperty.Jsii$Proxy

Enclosing class:

CfnTheme

@Stability(Stable)
public static interface CfnTheme.UIColorPaletteProperty
extends software.amazon.jsii.JsiiSerializable

The theme colors that apply to UI and to charts, excluding data colors.

The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with # , for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Example:

 // 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.*;
 UIColorPaletteProperty uIColorPaletteProperty = UIColorPaletteProperty.builder()
         .accent("accent")
         .accentForeground("accentForeground")
         .danger("danger")
         .dangerForeground("dangerForeground")
         .dimension("dimension")
         .dimensionForeground("dimensionForeground")
         .measure("measure")
         .measureForeground("measureForeground")
         .primaryBackground("primaryBackground")
         .primaryForeground("primaryForeground")
         .secondaryBackground("secondaryBackground")
         .secondaryForeground("secondaryForeground")
         .success("success")
         .successForeground("successForeground")
         .warning("warning")
         .warningForeground("warningForeground")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTheme.UIColorPaletteProperty.Builder	A builder for CfnTheme.UIColorPaletteProperty
static final class	CfnTheme.UIColorPaletteProperty.Jsii$Proxy	An implementation for CfnTheme.UIColorPaletteProperty

Method Summary

Modifier and Type	Method	Description
static CfnTheme.UIColorPaletteProperty.Builder	builder()
default String	getAccent()	This color is that applies to selected states and buttons.
default String	getAccentForeground()	The foreground color that applies to any text or other elements that appear over the accent color.
default String	getDanger()	The color that applies to error messages.
default String	getDangerForeground()	The foreground color that applies to any text or other elements that appear over the error color.
default String	getDimension()	The color that applies to the names of fields that are identified as dimensions.
default String	getDimensionForeground()	The foreground color that applies to any text or other elements that appear over the dimension color.
default String	getMeasure()	The color that applies to the names of fields that are identified as measures.
default String	getMeasureForeground()	The foreground color that applies to any text or other elements that appear over the measure color.
default String	getPrimaryBackground()	The background color that applies to visuals and other high emphasis UI.
default String	getPrimaryForeground()	The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.
default String	getSecondaryBackground()	The background color that applies to the sheet background and sheet controls.
default String	getSecondaryForeground()	The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
default String	getSuccess()	The color that applies to success messages, for example the check mark for a successful download.
default String	getSuccessForeground()	The foreground color that applies to any text or other elements that appear over the success color.
default String	getWarning()	This color that applies to warning and informational messages.
default String	getWarningForeground()	The foreground color that applies to any text or other elements that appear over the warning color.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccent

@Stability(Stable)
@Nullable
default String getAccent()

This color is that applies to selected states and buttons.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accent

getAccentForeground

@Stability(Stable)
@Nullable
default String getAccentForeground()

The foreground color that applies to any text or other elements that appear over the accent color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accentforeground

getDanger

@Stability(Stable)
@Nullable
default String getDanger()

The color that applies to error messages.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-danger

getDangerForeground

@Stability(Stable)
@Nullable
default String getDangerForeground()

The foreground color that applies to any text or other elements that appear over the error color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dangerforeground

getDimension

@Stability(Stable)
@Nullable
default String getDimension()

The color that applies to the names of fields that are identified as dimensions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimension

getDimensionForeground

@Stability(Stable)
@Nullable
default String getDimensionForeground()

The foreground color that applies to any text or other elements that appear over the dimension color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimensionforeground

getMeasure

@Stability(Stable)
@Nullable
default String getMeasure()

The color that applies to the names of fields that are identified as measures.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measure

getMeasureForeground

@Stability(Stable)
@Nullable
default String getMeasureForeground()

The foreground color that applies to any text or other elements that appear over the measure color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measureforeground

getPrimaryBackground

@Stability(Stable)
@Nullable
default String getPrimaryBackground()

The background color that applies to visuals and other high emphasis UI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primarybackground

getPrimaryForeground

@Stability(Stable)
@Nullable
default String getPrimaryForeground()

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primaryforeground

getSecondaryBackground

@Stability(Stable)
@Nullable
default String getSecondaryBackground()

The background color that applies to the sheet background and sheet controls.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondarybackground

getSecondaryForeground

@Stability(Stable)
@Nullable
default String getSecondaryForeground()

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondaryforeground

getSuccess

@Stability(Stable)
@Nullable
default String getSuccess()

The color that applies to success messages, for example the check mark for a successful download.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-success

getSuccessForeground

@Stability(Stable)
@Nullable
default String getSuccessForeground()

The foreground color that applies to any text or other elements that appear over the success color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-successforeground

getWarning

@Stability(Stable)
@Nullable
default String getWarning()

This color that applies to warning and informational messages.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warning

getWarningForeground

@Stability(Stable)
@Nullable
default String getWarningForeground()

The foreground color that applies to any text or other elements that appear over the warning color.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warningforeground

builder

@Stability(Stable)
static CfnTheme.UIColorPaletteProperty.Builder builder()

Returns:

a CfnTheme.UIColorPaletteProperty.Builder of CfnTheme.UIColorPaletteProperty