Class BoxPlotChartConfiguration

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

The configuration of a BoxPlotVisual.

See Also:

  • Method Details

    • fieldWells

      public final BoxPlotFieldWells fieldWells()

      The field wells of the visual.

      Returns:
      The field wells of the visual.

    • sortConfiguration

      public final BoxPlotSortConfiguration sortConfiguration()

      The sort configuration of a BoxPlotVisual.

      Returns:
      The sort configuration of a BoxPlotVisual.

    • boxPlotOptions

      public final BoxPlotOptions boxPlotOptions()

      The box plot chart options for a box plot visual

      Returns:
      The box plot chart options for a box plot visual

    • categoryAxis

      public final AxisDisplayOptions categoryAxis()

      The label display options (grid line, range, scale, axis step) of a box plot category.

      Returns:
      The label display options (grid line, range, scale, axis step) of a box plot category.

    • categoryLabelOptions

      public final ChartAxisLabelOptions categoryLabelOptions()

      The label options (label text, label visibility and sort Icon visibility) of a box plot category.

      Returns:
      The label options (label text, label visibility and sort Icon visibility) of a box plot category.

    • primaryYAxisDisplayOptions

      public final AxisDisplayOptions primaryYAxisDisplayOptions()

      The label display options (grid line, range, scale, axis step) of a box plot category.

      Returns:
      The label display options (grid line, range, scale, axis step) of a box plot category.

    • primaryYAxisLabelOptions

      public final ChartAxisLabelOptions primaryYAxisLabelOptions()

      The label options (label text, label visibility and sort icon visibility) of a box plot value.

      Returns:
      The label options (label text, label visibility and sort icon visibility) of a box plot value.

    • legend

      public final LegendOptions legend()
      Returns the value of the Legend property for this object.
      Returns:
      The value of the Legend property for this object.

    • tooltip

      public final TooltipOptions tooltip()

      The tooltip display setup of the visual.

      Returns:
      The tooltip display setup of the visual.

    • hasReferenceLines

      public final boolean hasReferenceLines()
      For responses, this returns true if the service returned a value for the ReferenceLines property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • referenceLines

      public final List<ReferenceLine> referenceLines()

      The reference line setup of the visual.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReferenceLines() method.

      Returns:
      The reference line setup of the visual.

    • visualPalette

      public final VisualPalette visualPalette()

      The palette (chart color) display setup of the visual.

      Returns:
      The palette (chart color) 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 BoxPlotChartConfiguration.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<BoxPlotChartConfiguration.Builder,BoxPlotChartConfiguration>
      Returns:
      a builder for type T

    • builder

      public static BoxPlotChartConfiguration.Builder builder()

    • serializableBuilderClass

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