Class SmallMultiplesOptions

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

Options that determine the layout and display options of a chart's small multiples.

See Also:

  • Method Details

    • maxVisibleRows

      public final Long maxVisibleRows()

      Sets the maximum number of visible rows to display in the grid of small multiples panels.

      The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

      Returns:
      Sets the maximum number of visible rows to display in the grid of small multiples panels.

      The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

    • maxVisibleColumns

      public final Long maxVisibleColumns()

      Sets the maximum number of visible columns to display in the grid of small multiples panels.

      The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

      Returns:
      Sets the maximum number of visible columns to display in the grid of small multiples panels.

      The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

    • panelConfiguration

      public final PanelConfiguration panelConfiguration()

      Configures the display options for each small multiples panel.

      Returns:
      Configures the display options for each small multiples panel.

    • xAxis

      public final SmallMultiplesAxisProperties xAxis()

      The properties of a small multiples X axis.

      Returns:
      The properties of a small multiples X axis.

    • yAxis

      public final SmallMultiplesAxisProperties yAxis()

      The properties of a small multiples Y axis.

      Returns:
      The properties of a small multiples Y axis.

    • toBuilder

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

    • builder

      public static SmallMultiplesOptions.Builder builder()

    • serializableBuilderClass

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