Class AxisDisplayOptions

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

The display options for the axis label.

See Also:

  • Method Details

    • tickLabelOptions

      public final AxisTickLabelOptions tickLabelOptions()

      The tick label options of an axis.

      Returns:
      The tick label options of an axis.

    • axisLineVisibility

      public final Visibility axisLineVisibility()

      Determines whether or not the axis line is visible.

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

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

    • axisLineVisibilityAsString

      public final String axisLineVisibilityAsString()

      Determines whether or not the axis line is visible.

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

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

    • gridLineVisibility

      public final Visibility gridLineVisibility()

      Determines whether or not the grid line is visible.

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

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

    • gridLineVisibilityAsString

      public final String gridLineVisibilityAsString()

      Determines whether or not the grid line is visible.

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

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

    • dataOptions

      public final AxisDataOptions dataOptions()

      The data options for an axis.

      Returns:
      The data options for an axis.

    • scrollbarOptions

      public final ScrollBarOptions scrollbarOptions()

      The scroll bar options for an axis.

      Returns:
      The scroll bar options for an axis.

    • axisOffset

      public final String axisOffset()

      The offset value that determines the starting placement of the axis within a visual's bounds.

      Returns:
      The offset value that determines the starting placement of the axis within a visual's bounds.

    • toBuilder

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

    • builder

      public static AxisDisplayOptions.Builder builder()

    • serializableBuilderClass

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