HeatMapConfiguration (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The configuration of a heat map.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HeatMapConfiguration()

Constructors
Constructor and Description
`HeatMapConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HeatMapConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`ColorScale`	`getColorScale()` The color options (gradient color, point of divergence) in a heat map.
`ChartAxisLabelOptions`	`getColumnLabelOptions()` The label options of the column that is displayed in a heat map.
`DataLabelOptions`	`getDataLabels()` The options that determine if visual data labels are displayed.
`HeatMapFieldWells`	`getFieldWells()` The field wells of the visual.
`LegendOptions`	`getLegend()` The legend display setup of the visual.
`ChartAxisLabelOptions`	`getRowLabelOptions()` The label options of the row that is displayed in a `heat map`.
`HeatMapSortConfiguration`	`getSortConfiguration()` The sort configuration of a heat 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`	`setColorScale(ColorScale colorScale)` The color options (gradient color, point of divergence) in a heat map.
`void`	`setColumnLabelOptions(ChartAxisLabelOptions columnLabelOptions)` The label options of the column that is displayed in a heat map.
`void`	`setDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`void`	`setFieldWells(HeatMapFieldWells fieldWells)` The field wells of the visual.
`void`	`setLegend(LegendOptions legend)` The legend display setup of the visual.
`void`	`setRowLabelOptions(ChartAxisLabelOptions rowLabelOptions)` The label options of the row that is displayed in a `heat map`.
`void`	`setSortConfiguration(HeatMapSortConfiguration sortConfiguration)` The sort configuration of a heat map.
`void`	`setTooltip(TooltipOptions tooltip)` The tooltip display setup of the visual.
`String`	`toString()` Returns a string representation of this object.
`HeatMapConfiguration`	`withColorScale(ColorScale colorScale)` The color options (gradient color, point of divergence) in a heat map.
`HeatMapConfiguration`	`withColumnLabelOptions(ChartAxisLabelOptions columnLabelOptions)` The label options of the column that is displayed in a heat map.
`HeatMapConfiguration`	`withDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`HeatMapConfiguration`	`withFieldWells(HeatMapFieldWells fieldWells)` The field wells of the visual.
`HeatMapConfiguration`	`withLegend(LegendOptions legend)` The legend display setup of the visual.
`HeatMapConfiguration`	`withRowLabelOptions(ChartAxisLabelOptions rowLabelOptions)` The label options of the row that is displayed in a `heat map`.
`HeatMapConfiguration`	`withSortConfiguration(HeatMapSortConfiguration sortConfiguration)` The sort configuration of a heat map.
`HeatMapConfiguration`	`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
  - HeatMapConfiguration
```
public HeatMapConfiguration()
```
- Method Detail
  - setFieldWells
```
public void setFieldWells(HeatMapFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
  - getFieldWells
```
public HeatMapFieldWells getFieldWells()
```
    The field wells of the visual.
    
    Returns:
    
    The field wells of the visual.
  - withFieldWells
```
public HeatMapConfiguration withFieldWells(HeatMapFieldWells 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(HeatMapSortConfiguration sortConfiguration)
```
    The sort configuration of a heat map.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a heat map.
  - getSortConfiguration
```
public HeatMapSortConfiguration getSortConfiguration()
```
    The sort configuration of a heat map.
    
    Returns:
    
    The sort configuration of a heat map.
  - withSortConfiguration
```
public HeatMapConfiguration withSortConfiguration(HeatMapSortConfiguration sortConfiguration)
```
    The sort configuration of a heat map.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a heat map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRowLabelOptions
```
public void setRowLabelOptions(ChartAxisLabelOptions rowLabelOptions)
```
    The label options of the row that is displayed in a heat map.
    
    Parameters:
    
    rowLabelOptions - The label options of the row that is displayed in a heat map.
  - getRowLabelOptions
```
public ChartAxisLabelOptions getRowLabelOptions()
```
    The label options of the row that is displayed in a heat map.
    
    Returns:
    
    The label options of the row that is displayed in a heat map.
  - withRowLabelOptions
```
public HeatMapConfiguration withRowLabelOptions(ChartAxisLabelOptions rowLabelOptions)
```
    The label options of the row that is displayed in a heat map.
    
    Parameters:
    
    rowLabelOptions - The label options of the row that is displayed in a heat map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumnLabelOptions
```
public void setColumnLabelOptions(ChartAxisLabelOptions columnLabelOptions)
```
    The label options of the column that is displayed in a heat map.
    
    Parameters:
    
    columnLabelOptions - The label options of the column that is displayed in a heat map.
  - getColumnLabelOptions
```
public ChartAxisLabelOptions getColumnLabelOptions()
```
    The label options of the column that is displayed in a heat map.
    
    Returns:
    
    The label options of the column that is displayed in a heat map.
  - withColumnLabelOptions
```
public HeatMapConfiguration withColumnLabelOptions(ChartAxisLabelOptions columnLabelOptions)
```
    The label options of the column that is displayed in a heat map.
    
    Parameters:
    
    columnLabelOptions - The label options of the column that is displayed in a heat 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) in a heat map.
    
    Parameters:
    
    colorScale - The color options (gradient color, point of divergence) in a heat map.
  - getColorScale
```
public ColorScale getColorScale()
```
    The color options (gradient color, point of divergence) in a heat map.
    
    Returns:
    
    The color options (gradient color, point of divergence) in a heat map.
  - withColorScale
```
public HeatMapConfiguration withColorScale(ColorScale colorScale)
```
    The color options (gradient color, point of divergence) in a heat map.
    
    Parameters:
    
    colorScale - The color options (gradient color, point of divergence) in a heat 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 HeatMapConfiguration 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 HeatMapConfiguration 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 HeatMapConfiguration 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 HeatMapConfiguration 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 HeatMapConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HeatMapConfiguration

Method Detail

setFieldWells

getFieldWells

withFieldWells

setSortConfiguration

getSortConfiguration

withSortConfiguration

setRowLabelOptions

getRowLabelOptions

withRowLabelOptions

setColumnLabelOptions

getColumnLabelOptions

withColumnLabelOptions

setColorScale

getColorScale

withColorScale

setLegend

getLegend

withLegend

setDataLabels

getDataLabels

withDataLabels

setTooltip

getTooltip

withTooltip

toString

equals

hashCode

clone

marshall