Class HeatMapConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.HeatMapConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HeatMapConfiguration.Builder,HeatMapConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class HeatMapConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HeatMapConfiguration.Builder,HeatMapConfiguration>

The configuration of a heat map.

See Also:

  • Method Details

    • fieldWells

      public final HeatMapFieldWells fieldWells()

      The field wells of the visual.

      Returns:
      The field wells of the visual.

    • sortConfiguration

      public final HeatMapSortConfiguration sortConfiguration()

      The sort configuration of a heat map.

      Returns:
      The sort configuration of a heat map.

    • rowAxisDisplayOptions

      public final AxisDisplayOptions rowAxisDisplayOptions()

      The options that determine the presentation of the row axis label.

      Returns:
      The options that determine the presentation of the row axis label.

    • rowLabelOptions

      public final ChartAxisLabelOptions rowLabelOptions()

      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.

    • columnAxisDisplayOptions

      public final AxisDisplayOptions columnAxisDisplayOptions()

      The options that determine the presentation of the row axis label.

      Returns:
      The options that determine the presentation of the row axis label.

    • columnLabelOptions

      public final ChartAxisLabelOptions columnLabelOptions()

      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.

    • colorScale

      public final ColorScale colorScale()

      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.

    • legend

      public final LegendOptions legend()

      The legend display setup of the visual.

      Returns:
      The legend display setup of the visual.

    • dataLabels

      public final DataLabelOptions dataLabels()

      The options that determine if visual data labels are displayed.

      Returns:
      The options that determine if visual data labels are displayed.

    • tooltip

      public final TooltipOptions tooltip()

      The tooltip display setup of the visual.

      Returns:
      The tooltip display setup of the visual.

    • interactions

      public final VisualInteractionOptions interactions()

      The general visual interactions setup for a visual.

      Returns:
      The general visual interactions setup for a visual.

    • toBuilder

      public HeatMapConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HeatMapConfiguration.Builder,HeatMapConfiguration>
      Returns:
      a builder for type T

    • builder

      public static HeatMapConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HeatMapConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.