Class LegendOptions

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

The options for the legend setup of a visual.

See Also:

  • Method Details

    • visibility

      public final Visibility visibility()

      Determines whether or not the legend is visible.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      Determines whether or not the legend is visible.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      Determines whether or not the legend is visible.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      Determines whether or not the legend is visible.
      See Also:

    • title

      public final LabelOptions title()

      The custom title for the legend.

      Returns:
      The custom title for the legend.

    • position

      public final LegendPosition position()

      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      If the service returns an enum value that is not available in the current SDK version, position will return LegendPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().

      Returns:
      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      See Also:

    • positionAsString

      public final String positionAsString()

      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      If the service returns an enum value that is not available in the current SDK version, position will return LegendPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().

      Returns:
      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      See Also:

    • width

      public final String width()

      The width of the legend. If this value is omitted, a default width is used when rendering.

      Returns:
      The width of the legend. If this value is omitted, a default width is used when rendering.

    • height

      public final String height()

      The height of the legend. If this value is omitted, a default height is used when rendering.

      Returns:
      The height of the legend. If this value is omitted, a default height is used when rendering.

    • toBuilder

      public LegendOptions.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<LegendOptions.Builder,LegendOptions>
      Returns:
      a builder for type T

    • builder

      public static LegendOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LegendOptions.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.