Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnTemplatePropsMixin.HeatMapVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.HeatMapVisualProperty.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

@Stability(Stable)
public static interface CfnTemplatePropsMixin.HeatMapVisualProperty
extends software.amazon.jsii.JsiiSerializable

A heat map.

For more information, see Using heat maps in the Amazon Quick Suite User Guide .

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplatePropsMixin.HeatMapVisualProperty.Builder	builder()
default Object	getActions()	The list of custom actions that are configured for a visual.
default Object	getChartConfiguration()	The configuration of a heat map.
default Object	getColumnHierarchies()	The column hierarchy that is used during drill-downs and drill-ups.
default Object	getSubtitle()	The subtitle that is displayed on the visual.
default Object	getTitle()	The title that is displayed on the visual.
default String	getVisualContentAltText()	The alt text for the visual.
default String	getVisualId()	The unique identifier of a visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@Nullable
default Object getActions()

The list of custom actions that are configured for a visual.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplatePropsMixin.VisualCustomActionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-actions

getChartConfiguration

@Stability(Stable)
@Nullable
default Object getChartConfiguration()

The configuration of a heat map.

Returns union: either IResolvable or CfnTemplatePropsMixin.HeatMapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-chartconfiguration

getColumnHierarchies

@Stability(Stable)
@Nullable
default Object getColumnHierarchies()

The column hierarchy that is used during drill-downs and drill-ups.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplatePropsMixin.ColumnHierarchyProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-columnhierarchies

getSubtitle

@Stability(Stable)
@Nullable
default Object getSubtitle()

The subtitle that is displayed on the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualSubtitleLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-subtitle

getTitle

@Stability(Stable)
@Nullable
default Object getTitle()

The title that is displayed on the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualTitleLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-title

getVisualContentAltText

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

The alt text for the visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualcontentalttext

getVisualId

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

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualid

builder

@Stability(Stable)
static CfnTemplatePropsMixin.HeatMapVisualProperty.Builder builder()

Returns:

a CfnTemplatePropsMixin.HeatMapVisualProperty.Builder of CfnTemplatePropsMixin.HeatMapVisualProperty