BoxPlotChartConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.BoxPlotChartConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BoxPlotChartConfiguration.Builder,BoxPlotChartConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class BoxPlotChartConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BoxPlotChartConfiguration.Builder,BoxPlotChartConfiguration>

The configuration of a BoxPlotVisual.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BoxPlotChartConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BoxPlotChartConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxPlotOptions`	`boxPlotOptions()` The box plot chart options for a box plot visual
`static BoxPlotChartConfiguration.Builder`	`builder()`
`AxisDisplayOptions`	`categoryAxis()` The label display options (grid line, range, scale, axis step) of a box plot category.
`ChartAxisLabelOptions`	`categoryLabelOptions()` The label options (label text, label visibility and sort Icon visibility) of a box plot category.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`BoxPlotFieldWells`	`fieldWells()` The field wells of the visual.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReferenceLines()` For responses, this returns true if the service returned a value for the ReferenceLines property.
`LegendOptions`	`legend()` Returns the value of the Legend property for this object.
`AxisDisplayOptions`	`primaryYAxisDisplayOptions()` The label display options (grid line, range, scale, axis step) of a box plot category.
`ChartAxisLabelOptions`	`primaryYAxisLabelOptions()` The label options (label text, label visibility and sort icon visibility) of a box plot value.
`List<ReferenceLine>`	`referenceLines()` The reference line setup of the visual.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BoxPlotChartConfiguration.Builder>`	`serializableBuilderClass()`
`BoxPlotSortConfiguration`	`sortConfiguration()` The sort configuration of a `BoxPlotVisual`.
`BoxPlotChartConfiguration.Builder`	`toBuilder()`
`TooltipOptions`	`tooltip()` The tooltip display setup of the visual.
`String`	`toString()` Returns a string representation of this object.
`VisualPalette`	`visualPalette()` The palette (chart color) display setup of the visual.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
  - toBuilder
```
public BoxPlotChartConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BoxPlotChartConfiguration.Builder,BoxPlotChartConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class BoxPlotChartConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fieldWells

sortConfiguration

boxPlotOptions

categoryAxis

categoryLabelOptions

primaryYAxisDisplayOptions

primaryYAxisLabelOptions

legend

tooltip

hasReferenceLines

referenceLines

visualPalette

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields