Class PanelConfiguration

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

A collection of options that configure how each panel displays in a small multiples chart.

See Also:

  • Method Details

    • title

      public final PanelTitleOptions title()

      Configures the title display within each small multiples panel.

      Returns:
      Configures the title display within each small multiples panel.

    • borderVisibility

      public final Visibility borderVisibility()

      Determines whether or not each panel displays a border.

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

      Returns:
      Determines whether or not each panel displays a border.
      See Also:

    • borderVisibilityAsString

      public final String borderVisibilityAsString()

      Determines whether or not each panel displays a border.

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

      Returns:
      Determines whether or not each panel displays a border.
      See Also:

    • borderThickness

      public final String borderThickness()

      Sets the line thickness of panel borders.

      Returns:
      Sets the line thickness of panel borders.

    • borderStyle

      public final PanelBorderStyle borderStyle()

      Sets the line style of panel borders.

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

      Returns:
      Sets the line style of panel borders.
      See Also:

    • borderStyleAsString

      public final String borderStyleAsString()

      Sets the line style of panel borders.

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

      Returns:
      Sets the line style of panel borders.
      See Also:

    • borderColor

      public final String borderColor()

      Sets the line color of panel borders.

      Returns:
      Sets the line color of panel borders.

    • gutterVisibility

      public final Visibility gutterVisibility()

      Determines whether or not negative space between sibling panels is rendered.

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

      Returns:
      Determines whether or not negative space between sibling panels is rendered.
      See Also:

    • gutterVisibilityAsString

      public final String gutterVisibilityAsString()

      Determines whether or not negative space between sibling panels is rendered.

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

      Returns:
      Determines whether or not negative space between sibling panels is rendered.
      See Also:

    • gutterSpacing

      public final String gutterSpacing()

      Sets the total amount of negative space to display between sibling panels.

      Returns:
      Sets the total amount of negative space to display between sibling panels.

    • backgroundVisibility

      public final Visibility backgroundVisibility()

      Determines whether or not a background for each small multiples panel is rendered.

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

      Returns:
      Determines whether or not a background for each small multiples panel is rendered.
      See Also:

    • backgroundVisibilityAsString

      public final String backgroundVisibilityAsString()

      Determines whether or not a background for each small multiples panel is rendered.

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

      Returns:
      Determines whether or not a background for each small multiples panel is rendered.
      See Also:

    • backgroundColor

      public final String backgroundColor()

      Sets the background color for each panel.

      Returns:
      Sets the background color for each panel.

    • toBuilder

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

    • builder

      public static PanelConfiguration.Builder builder()

    • serializableBuilderClass

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