This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QuickSight::Template TreeMapConfiguration
<a name="aws-properties-quicksight-template-treemapconfiguration"></a>

The configuration of a tree map.

## Syntax
<a name="aws-properties-quicksight-template-treemapconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-quicksight-template-treemapconfiguration-syntax.json"></a>

```
{
  "[ColorLabelOptions](#cfn-quicksight-template-treemapconfiguration-colorlabeloptions)" : {{ChartAxisLabelOptions}},
  "[ColorScale](#cfn-quicksight-template-treemapconfiguration-colorscale)" : {{ColorScale}},
  "[DataLabels](#cfn-quicksight-template-treemapconfiguration-datalabels)" : {{DataLabelOptions}},
  "[FieldWells](#cfn-quicksight-template-treemapconfiguration-fieldwells)" : {{TreeMapFieldWells}},
  "[GroupLabelOptions](#cfn-quicksight-template-treemapconfiguration-grouplabeloptions)" : {{ChartAxisLabelOptions}},
  "[Interactions](#cfn-quicksight-template-treemapconfiguration-interactions)" : {{VisualInteractionOptions}},
  "[Legend](#cfn-quicksight-template-treemapconfiguration-legend)" : {{LegendOptions}},
  "[SizeLabelOptions](#cfn-quicksight-template-treemapconfiguration-sizelabeloptions)" : {{ChartAxisLabelOptions}},
  "[SortConfiguration](#cfn-quicksight-template-treemapconfiguration-sortconfiguration)" : {{TreeMapSortConfiguration}},
  "[Tooltip](#cfn-quicksight-template-treemapconfiguration-tooltip)" : {{TooltipOptions}}
}
```

### YAML
<a name="aws-properties-quicksight-template-treemapconfiguration-syntax.yaml"></a>

```
  [ColorLabelOptions](#cfn-quicksight-template-treemapconfiguration-colorlabeloptions): {{
    ChartAxisLabelOptions}}
  [ColorScale](#cfn-quicksight-template-treemapconfiguration-colorscale): {{
    ColorScale}}
  [DataLabels](#cfn-quicksight-template-treemapconfiguration-datalabels): {{
    DataLabelOptions}}
  [FieldWells](#cfn-quicksight-template-treemapconfiguration-fieldwells): {{
    TreeMapFieldWells}}
  [GroupLabelOptions](#cfn-quicksight-template-treemapconfiguration-grouplabeloptions): {{
    ChartAxisLabelOptions}}
  [Interactions](#cfn-quicksight-template-treemapconfiguration-interactions): {{
    VisualInteractionOptions}}
  [Legend](#cfn-quicksight-template-treemapconfiguration-legend): {{
    LegendOptions}}
  [SizeLabelOptions](#cfn-quicksight-template-treemapconfiguration-sizelabeloptions): {{
    ChartAxisLabelOptions}}
  [SortConfiguration](#cfn-quicksight-template-treemapconfiguration-sortconfiguration): {{
    TreeMapSortConfiguration}}
  [Tooltip](#cfn-quicksight-template-treemapconfiguration-tooltip): {{
    TooltipOptions}}
```

## Properties
<a name="aws-properties-quicksight-template-treemapconfiguration-properties"></a>

`ColorLabelOptions`  <a name="cfn-quicksight-template-treemapconfiguration-colorlabeloptions"></a>
The label options (label text, label visibility) for the colors displayed in a tree map.  
*Required*: No  
*Type*: [ChartAxisLabelOptions](aws-properties-quicksight-template-chartaxislabeloptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ColorScale`  <a name="cfn-quicksight-template-treemapconfiguration-colorscale"></a>
The color options (gradient color, point of divergence) of a tree map.  
*Required*: No  
*Type*: [ColorScale](aws-properties-quicksight-template-colorscale.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataLabels`  <a name="cfn-quicksight-template-treemapconfiguration-datalabels"></a>
The options that determine if visual data labels are displayed.  
*Required*: No  
*Type*: [DataLabelOptions](aws-properties-quicksight-template-datalabeloptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FieldWells`  <a name="cfn-quicksight-template-treemapconfiguration-fieldwells"></a>
The field wells of the visual.  
*Required*: No  
*Type*: [TreeMapFieldWells](aws-properties-quicksight-template-treemapfieldwells.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GroupLabelOptions`  <a name="cfn-quicksight-template-treemapconfiguration-grouplabeloptions"></a>
The label options (label text, label visibility) of the groups that are displayed in a tree map.  
*Required*: No  
*Type*: [ChartAxisLabelOptions](aws-properties-quicksight-template-chartaxislabeloptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Interactions`  <a name="cfn-quicksight-template-treemapconfiguration-interactions"></a>
The general visual interactions setup for a visual.  
*Required*: No  
*Type*: [VisualInteractionOptions](aws-properties-quicksight-template-visualinteractionoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Legend`  <a name="cfn-quicksight-template-treemapconfiguration-legend"></a>
The legend display setup of the visual.  
*Required*: No  
*Type*: [LegendOptions](aws-properties-quicksight-template-legendoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeLabelOptions`  <a name="cfn-quicksight-template-treemapconfiguration-sizelabeloptions"></a>
The label options (label text, label visibility) of the sizes that are displayed in a tree map.  
*Required*: No  
*Type*: [ChartAxisLabelOptions](aws-properties-quicksight-template-chartaxislabeloptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SortConfiguration`  <a name="cfn-quicksight-template-treemapconfiguration-sortconfiguration"></a>
The sort configuration of a tree map.  
*Required*: No  
*Type*: [TreeMapSortConfiguration](aws-properties-quicksight-template-treemapsortconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tooltip`  <a name="cfn-quicksight-template-treemapconfiguration-tooltip"></a>
The tooltip display setup of the visual.  
*Required*: No  
*Type*: [TooltipOptions](aws-properties-quicksight-template-tooltipoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)