BoxPlotChartConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.BoxPlotChartConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BoxPlotChartConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration of a BoxPlotVisual.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoxPlotChartConfiguration()

Constructors
Constructor and Description
`BoxPlotChartConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxPlotChartConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`BoxPlotOptions`	`getBoxPlotOptions()` The box plot chart options for a box plot visual
`AxisDisplayOptions`	`getCategoryAxis()` The label display options (grid line, range, scale, axis step) of a box plot category.
`ChartAxisLabelOptions`	`getCategoryLabelOptions()` The label options (label text, label visibility and sort Icon visibility) of a box plot category.
`BoxPlotFieldWells`	`getFieldWells()` The field wells of the visual.
`VisualInteractionOptions`	`getInteractions()` The general visual interactions setup for a visual.
`LegendOptions`	`getLegend()`
`AxisDisplayOptions`	`getPrimaryYAxisDisplayOptions()` The label display options (grid line, range, scale, axis step) of a box plot category.
`ChartAxisLabelOptions`	`getPrimaryYAxisLabelOptions()` The label options (label text, label visibility and sort icon visibility) of a box plot value.
`List<ReferenceLine>`	`getReferenceLines()` The reference line setup of the visual.
`BoxPlotSortConfiguration`	`getSortConfiguration()` The sort configuration of a `BoxPlotVisual`.
`TooltipOptions`	`getTooltip()` The tooltip display setup of the visual.
`VisualPalette`	`getVisualPalette()` The palette (chart color) display setup of the visual.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBoxPlotOptions(BoxPlotOptions boxPlotOptions)` The box plot chart options for a box plot visual
`void`	`setCategoryAxis(AxisDisplayOptions categoryAxis)` The label display options (grid line, range, scale, axis step) of a box plot category.
`void`	`setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)` The label options (label text, label visibility and sort Icon visibility) of a box plot category.
`void`	`setFieldWells(BoxPlotFieldWells fieldWells)` The field wells of the visual.
`void`	`setInteractions(VisualInteractionOptions interactions)` The general visual interactions setup for a visual.
`void`	`setLegend(LegendOptions legend)`
`void`	`setPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)` The label display options (grid line, range, scale, axis step) of a box plot category.
`void`	`setPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)` The label options (label text, label visibility and sort icon visibility) of a box plot value.
`void`	`setReferenceLines(Collection<ReferenceLine> referenceLines)` The reference line setup of the visual.
`void`	`setSortConfiguration(BoxPlotSortConfiguration sortConfiguration)` The sort configuration of a `BoxPlotVisual`.
`void`	`setTooltip(TooltipOptions tooltip)` The tooltip display setup of the visual.
`void`	`setVisualPalette(VisualPalette visualPalette)` The palette (chart color) display setup of the visual.
`String`	`toString()` Returns a string representation of this object.
`BoxPlotChartConfiguration`	`withBoxPlotOptions(BoxPlotOptions boxPlotOptions)` The box plot chart options for a box plot visual
`BoxPlotChartConfiguration`	`withCategoryAxis(AxisDisplayOptions categoryAxis)` The label display options (grid line, range, scale, axis step) of a box plot category.
`BoxPlotChartConfiguration`	`withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)` The label options (label text, label visibility and sort Icon visibility) of a box plot category.
`BoxPlotChartConfiguration`	`withFieldWells(BoxPlotFieldWells fieldWells)` The field wells of the visual.
`BoxPlotChartConfiguration`	`withInteractions(VisualInteractionOptions interactions)` The general visual interactions setup for a visual.
`BoxPlotChartConfiguration`	`withLegend(LegendOptions legend)`
`BoxPlotChartConfiguration`	`withPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)` The label display options (grid line, range, scale, axis step) of a box plot category.
`BoxPlotChartConfiguration`	`withPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)` The label options (label text, label visibility and sort icon visibility) of a box plot value.
`BoxPlotChartConfiguration`	`withReferenceLines(Collection<ReferenceLine> referenceLines)` The reference line setup of the visual.
`BoxPlotChartConfiguration`	`withReferenceLines(ReferenceLine... referenceLines)` The reference line setup of the visual.
`BoxPlotChartConfiguration`	`withSortConfiguration(BoxPlotSortConfiguration sortConfiguration)` The sort configuration of a `BoxPlotVisual`.
`BoxPlotChartConfiguration`	`withTooltip(TooltipOptions tooltip)` The tooltip display setup of the visual.
`BoxPlotChartConfiguration`	`withVisualPalette(VisualPalette visualPalette)` The palette (chart color) display setup of the visual.

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

- Constructor Detail
  - BoxPlotChartConfiguration
```
public BoxPlotChartConfiguration()
```
- Method Detail
  - setFieldWells
```
public void setFieldWells(BoxPlotFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
  - getFieldWells
```
public BoxPlotFieldWells getFieldWells()
```
    The field wells of the visual.
    
    Returns:
    
    The field wells of the visual.
  - withFieldWells
```
public BoxPlotChartConfiguration withFieldWells(BoxPlotFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSortConfiguration
```
public void setSortConfiguration(BoxPlotSortConfiguration sortConfiguration)
```
    The sort configuration of a BoxPlotVisual.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a BoxPlotVisual.
  - getSortConfiguration
```
public BoxPlotSortConfiguration getSortConfiguration()
```
    The sort configuration of a BoxPlotVisual.
    
    Returns:
    
    The sort configuration of a BoxPlotVisual.
  - withSortConfiguration
```
public BoxPlotChartConfiguration withSortConfiguration(BoxPlotSortConfiguration sortConfiguration)
```
    The sort configuration of a BoxPlotVisual.
    
    Parameters:
    
    sortConfiguration - The sort configuration of a BoxPlotVisual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBoxPlotOptions
```
public void setBoxPlotOptions(BoxPlotOptions boxPlotOptions)
```
    The box plot chart options for a box plot visual
    
    Parameters:
    
    boxPlotOptions - The box plot chart options for a box plot visual
  - getBoxPlotOptions
```
public BoxPlotOptions getBoxPlotOptions()
```
    The box plot chart options for a box plot visual
    
    Returns:
    
    The box plot chart options for a box plot visual
  - withBoxPlotOptions
```
public BoxPlotChartConfiguration withBoxPlotOptions(BoxPlotOptions boxPlotOptions)
```
    The box plot chart options for a box plot visual
    
    Parameters:
    
    boxPlotOptions - The box plot chart options for a box plot visual
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategoryAxis
```
public void setCategoryAxis(AxisDisplayOptions categoryAxis)
```
    The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Parameters:
    
    categoryAxis - The label display options (grid line, range, scale, axis step) of a box plot category.
  - getCategoryAxis
```
public AxisDisplayOptions getCategoryAxis()
```
    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.
  - withCategoryAxis
```
public BoxPlotChartConfiguration withCategoryAxis(AxisDisplayOptions categoryAxis)
```
    The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Parameters:
    
    categoryAxis - The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategoryLabelOptions
```
public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
```
    The label options (label text, label visibility and sort Icon visibility) of a box plot category.
    
    Parameters:
    
    categoryLabelOptions - The label options (label text, label visibility and sort Icon visibility) of a box plot category.
  - getCategoryLabelOptions
```
public ChartAxisLabelOptions getCategoryLabelOptions()
```
    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.
  - withCategoryLabelOptions
```
public BoxPlotChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
```
    The label options (label text, label visibility and sort Icon visibility) of a box plot category.
    
    Parameters:
    
    categoryLabelOptions - The label options (label text, label visibility and sort Icon visibility) of a box plot category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryYAxisDisplayOptions
```
public void setPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
```
    The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Parameters:
    
    primaryYAxisDisplayOptions - The label display options (grid line, range, scale, axis step) of a box plot category.
  - getPrimaryYAxisDisplayOptions
```
public AxisDisplayOptions getPrimaryYAxisDisplayOptions()
```
    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.
  - withPrimaryYAxisDisplayOptions
```
public BoxPlotChartConfiguration withPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
```
    The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Parameters:
    
    primaryYAxisDisplayOptions - The label display options (grid line, range, scale, axis step) of a box plot category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryYAxisLabelOptions
```
public void setPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
```
    The label options (label text, label visibility and sort icon visibility) of a box plot value.
    
    Parameters:
    
    primaryYAxisLabelOptions - The label options (label text, label visibility and sort icon visibility) of a box plot value.
  - getPrimaryYAxisLabelOptions
```
public ChartAxisLabelOptions getPrimaryYAxisLabelOptions()
```
    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.
  - withPrimaryYAxisLabelOptions
```
public BoxPlotChartConfiguration withPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
```
    The label options (label text, label visibility and sort icon visibility) of a box plot value.
    
    Parameters:
    
    primaryYAxisLabelOptions - The label options (label text, label visibility and sort icon visibility) of a box plot value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLegend
```
public void setLegend(LegendOptions legend)
```
    Parameters:
    
    legend -
  - getLegend
```
public LegendOptions getLegend()
```
    Returns:
  - withLegend
```
public BoxPlotChartConfiguration withLegend(LegendOptions legend)
```
    Parameters:
    
    legend -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTooltip
```
public void setTooltip(TooltipOptions tooltip)
```
    The tooltip display setup of the visual.
    
    Parameters:
    
    tooltip - The tooltip display setup of the visual.
  - getTooltip
```
public TooltipOptions getTooltip()
```
    The tooltip display setup of the visual.
    
    Returns:
    
    The tooltip display setup of the visual.
  - withTooltip
```
public BoxPlotChartConfiguration withTooltip(TooltipOptions tooltip)
```
    The tooltip display setup of the visual.
    
    Parameters:
    
    tooltip - The tooltip display setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReferenceLines
```
public List<ReferenceLine> getReferenceLines()
```
    The reference line setup of the visual.
    
    Returns:
    
    The reference line setup of the visual.
  - setReferenceLines
```
public void setReferenceLines(Collection<ReferenceLine> referenceLines)
```
    The reference line setup of the visual.
    
    Parameters:
    
    referenceLines - The reference line setup of the visual.
  - withReferenceLines
```
public BoxPlotChartConfiguration withReferenceLines(ReferenceLine... referenceLines)
```
    The reference line setup of the visual.
    
    NOTE: This method appends the values to the existing list (if any). Use setReferenceLines(java.util.Collection) or withReferenceLines(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    referenceLines - The reference line setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReferenceLines
```
public BoxPlotChartConfiguration withReferenceLines(Collection<ReferenceLine> referenceLines)
```
    The reference line setup of the visual.
    
    Parameters:
    
    referenceLines - The reference line setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisualPalette
```
public void setVisualPalette(VisualPalette visualPalette)
```
    The palette (chart color) display setup of the visual.
    
    Parameters:
    
    visualPalette - The palette (chart color) display setup of the visual.
  - getVisualPalette
```
public VisualPalette getVisualPalette()
```
    The palette (chart color) display setup of the visual.
    
    Returns:
    
    The palette (chart color) display setup of the visual.
  - withVisualPalette
```
public BoxPlotChartConfiguration withVisualPalette(VisualPalette visualPalette)
```
    The palette (chart color) display setup of the visual.
    
    Parameters:
    
    visualPalette - The palette (chart color) display setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInteractions
```
public void setInteractions(VisualInteractionOptions interactions)
```
    The general visual interactions setup for a visual.
    
    Parameters:
    
    interactions - The general visual interactions setup for a visual.
  - getInteractions
```
public VisualInteractionOptions getInteractions()
```
    The general visual interactions setup for a visual.
    
    Returns:
    
    The general visual interactions setup for a visual.
  - withInteractions
```
public BoxPlotChartConfiguration withInteractions(VisualInteractionOptions interactions)
```
    The general visual interactions setup for a visual.
    
    Parameters:
    
    interactions - The general visual interactions setup for a visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BoxPlotChartConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class BoxPlotChartConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoxPlotChartConfiguration

Method Detail

setFieldWells

getFieldWells

withFieldWells

setSortConfiguration

getSortConfiguration

withSortConfiguration

setBoxPlotOptions

getBoxPlotOptions

withBoxPlotOptions

setCategoryAxis

getCategoryAxis

withCategoryAxis

setCategoryLabelOptions

getCategoryLabelOptions

withCategoryLabelOptions

setPrimaryYAxisDisplayOptions

getPrimaryYAxisDisplayOptions

withPrimaryYAxisDisplayOptions

setPrimaryYAxisLabelOptions

getPrimaryYAxisLabelOptions

withPrimaryYAxisLabelOptions

setLegend

getLegend

withLegend

setTooltip

getTooltip

withTooltip

getReferenceLines

setReferenceLines

withReferenceLines

withReferenceLines

setVisualPalette

getVisualPalette

withVisualPalette

setInteractions

getInteractions

withInteractions

toString

equals

hashCode

clone

marshall