TreeMapConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.TreeMapConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TreeMapConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration of a tree map.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TreeMapConfiguration()

Constructors
Constructor and Description
`TreeMapConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TreeMapConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`ChartAxisLabelOptions`	`getColorLabelOptions()` The label options (label text, label visibility) for the colors displayed in a tree map.
`ColorScale`	`getColorScale()` The color options (gradient color, point of divergence) of a tree map.
`DataLabelOptions`	`getDataLabels()` The options that determine if visual data labels are displayed.
`TreeMapFieldWells`	`getFieldWells()` The field wells of the visual.
`ChartAxisLabelOptions`	`getGroupLabelOptions()` The label options (label text, label visibility) of the groups that are displayed in a tree map.
`LegendOptions`	`getLegend()` The legend display setup of the visual.
`ChartAxisLabelOptions`	`getSizeLabelOptions()` The label options (label text, label visibility) of the sizes that are displayed in a tree map.
`TreeMapSortConfiguration`	`getSortConfiguration()` The sort configuration of a tree map.
`TooltipOptions`	`getTooltip()` The tooltip display setup of the visual.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)` The label options (label text, label visibility) for the colors displayed in a tree map.
`void`	`setColorScale(ColorScale colorScale)` The color options (gradient color, point of divergence) of a tree map.
`void`	`setDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`void`	`setFieldWells(TreeMapFieldWells fieldWells)` The field wells of the visual.
`void`	`setGroupLabelOptions(ChartAxisLabelOptions groupLabelOptions)` The label options (label text, label visibility) of the groups that are displayed in a tree map.
`void`	`setLegend(LegendOptions legend)` The legend display setup of the visual.
`void`	`setSizeLabelOptions(ChartAxisLabelOptions sizeLabelOptions)` The label options (label text, label visibility) of the sizes that are displayed in a tree map.
`void`	`setSortConfiguration(TreeMapSortConfiguration sortConfiguration)` The sort configuration of a tree map.
`void`	`setTooltip(TooltipOptions tooltip)` The tooltip display setup of the visual.
`String`	`toString()` Returns a string representation of this object.
`TreeMapConfiguration`	`withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)` The label options (label text, label visibility) for the colors displayed in a tree map.
`TreeMapConfiguration`	`withColorScale(ColorScale colorScale)` The color options (gradient color, point of divergence) of a tree map.
`TreeMapConfiguration`	`withDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`TreeMapConfiguration`	`withFieldWells(TreeMapFieldWells fieldWells)` The field wells of the visual.
`TreeMapConfiguration`	`withGroupLabelOptions(ChartAxisLabelOptions groupLabelOptions)` The label options (label text, label visibility) of the groups that are displayed in a tree map.
`TreeMapConfiguration`	`withLegend(LegendOptions legend)` The legend display setup of the visual.
`TreeMapConfiguration`	`withSizeLabelOptions(ChartAxisLabelOptions sizeLabelOptions)` The label options (label text, label visibility) of the sizes that are displayed in a tree map.
`TreeMapConfiguration`	`withSortConfiguration(TreeMapSortConfiguration sortConfiguration)` The sort configuration of a tree map.
`TreeMapConfiguration`	`withTooltip(TooltipOptions tooltip)` The tooltip display setup of the visual.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TreeMapConfiguration
```
public TreeMapConfiguration()
```
- Method Detail
  - setFieldWells
```
public void setFieldWells(TreeMapFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
  - getFieldWells
```
public TreeMapFieldWells getFieldWells()
```
    The field wells of the visual.
    
    Returns:
    
    The field wells of the visual.
  - withFieldWells
```
public TreeMapConfiguration withFieldWells(TreeMapFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSortConfiguration
```
public void setSortConfiguration(TreeMapSortConfiguration sortConfiguration)
```
    The sort configuration of a tree map.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a tree map.
  - getSortConfiguration
```
public TreeMapSortConfiguration getSortConfiguration()
```
    The sort configuration of a tree map.
    
    Returns:
    
    The sort configuration of a tree map.
  - withSortConfiguration
```
public TreeMapConfiguration withSortConfiguration(TreeMapSortConfiguration sortConfiguration)
```
    The sort configuration of a tree map.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a tree map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroupLabelOptions
```
public void setGroupLabelOptions(ChartAxisLabelOptions groupLabelOptions)
```
    The label options (label text, label visibility) of the groups that are displayed in a tree map.
    
    Parameters:
    
    groupLabelOptions - The label options (label text, label visibility) of the groups that are displayed in a tree map.
  - getGroupLabelOptions
```
public ChartAxisLabelOptions getGroupLabelOptions()
```
    The label options (label text, label visibility) of the groups that are displayed in a tree map.
    
    Returns:
    
    The label options (label text, label visibility) of the groups that are displayed in a tree map.
  - withGroupLabelOptions
```
public TreeMapConfiguration withGroupLabelOptions(ChartAxisLabelOptions groupLabelOptions)
```
    The label options (label text, label visibility) of the groups that are displayed in a tree map.
    
    Parameters:
    
    groupLabelOptions - The label options (label text, label visibility) of the groups that are displayed in a tree map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeLabelOptions
```
public void setSizeLabelOptions(ChartAxisLabelOptions sizeLabelOptions)
```
    The label options (label text, label visibility) of the sizes that are displayed in a tree map.
    
    Parameters:
    
    sizeLabelOptions - The label options (label text, label visibility) of the sizes that are displayed in a tree map.
  - getSizeLabelOptions
```
public ChartAxisLabelOptions getSizeLabelOptions()
```
    The label options (label text, label visibility) of the sizes that are displayed in a tree map.
    
    Returns:
    
    The label options (label text, label visibility) of the sizes that are displayed in a tree map.
  - withSizeLabelOptions
```
public TreeMapConfiguration withSizeLabelOptions(ChartAxisLabelOptions sizeLabelOptions)
```
    The label options (label text, label visibility) of the sizes that are displayed in a tree map.
    
    Parameters:
    
    sizeLabelOptions - The label options (label text, label visibility) of the sizes that are displayed in a tree map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColorLabelOptions
```
public void setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
```
    The label options (label text, label visibility) for the colors displayed in a tree map.
    
    Parameters:
    
    colorLabelOptions - The label options (label text, label visibility) for the colors displayed in a tree map.
  - getColorLabelOptions
```
public ChartAxisLabelOptions getColorLabelOptions()
```
    The label options (label text, label visibility) for the colors displayed in a tree map.
    
    Returns:
    
    The label options (label text, label visibility) for the colors displayed in a tree map.
  - withColorLabelOptions
```
public TreeMapConfiguration withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
```
    The label options (label text, label visibility) for the colors displayed in a tree map.
    
    Parameters:
    
    colorLabelOptions - The label options (label text, label visibility) for the colors displayed in a tree map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColorScale
```
public void setColorScale(ColorScale colorScale)
```
    The color options (gradient color, point of divergence) of a tree map.
    
    Parameters:
    
    colorScale - The color options (gradient color, point of divergence) of a tree map.
  - getColorScale
```
public ColorScale getColorScale()
```
    The color options (gradient color, point of divergence) of a tree map.
    
    Returns:
    
    The color options (gradient color, point of divergence) of a tree map.
  - withColorScale
```
public TreeMapConfiguration withColorScale(ColorScale colorScale)
```
    The color options (gradient color, point of divergence) of a tree map.
    
    Parameters:
    
    colorScale - The color options (gradient color, point of divergence) of a tree map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLegend
```
public void setLegend(LegendOptions legend)
```
    The legend display setup of the visual.
    
    Parameters:
    
    legend - The legend display setup of the visual.
  - getLegend
```
public LegendOptions getLegend()
```
    The legend display setup of the visual.
    
    Returns:
    
    The legend display setup of the visual.
  - withLegend
```
public TreeMapConfiguration withLegend(LegendOptions legend)
```
    The legend display setup of the visual.
    
    Parameters:
    
    legend - The legend display setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataLabels
```
public void setDataLabels(DataLabelOptions dataLabels)
```
    The options that determine if visual data labels are displayed.
    
    Parameters:
    
    dataLabels - The options that determine if visual data labels are displayed.
  - getDataLabels
```
public DataLabelOptions getDataLabels()
```
    The options that determine if visual data labels are displayed.
    
    Returns:
    
    The options that determine if visual data labels are displayed.
  - withDataLabels
```
public TreeMapConfiguration withDataLabels(DataLabelOptions dataLabels)
```
    The options that determine if visual data labels are displayed.
    
    Parameters:
    
    dataLabels - The options that determine if visual data labels are displayed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTooltip
```
public void setTooltip(TooltipOptions tooltip)
```
    The tooltip display setup of the visual.
    
    Parameters:
    
    tooltip - The tooltip display setup of the visual.
  - getTooltip
```
public TooltipOptions getTooltip()
```
    The tooltip display setup of the visual.
    
    Returns:
    
    The tooltip display setup of the visual.
  - withTooltip
```
public TreeMapConfiguration withTooltip(TooltipOptions tooltip)
```
    The tooltip display setup of the visual.
    
    Parameters:
    
    tooltip - The tooltip display setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TreeMapConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TreeMapConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeMapConfiguration

Method Detail

setFieldWells

getFieldWells

withFieldWells

setSortConfiguration

getSortConfiguration

withSortConfiguration

setGroupLabelOptions

getGroupLabelOptions

withGroupLabelOptions

setSizeLabelOptions

getSizeLabelOptions

withSizeLabelOptions

setColorLabelOptions

getColorLabelOptions

withColorLabelOptions

setColorScale

getColorScale

withColorScale

setLegend

getLegend

withLegend

setDataLabels

getDataLabels

withDataLabels

setTooltip

getTooltip

withTooltip

toString

equals

hashCode

clone

marshall