BoxPlotVisual (AWS Java SDK for Amazon QuickSight 1.12.558 API)

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

All Implemented Interfaces:

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

For more information, see Using box plots in the Amazon QuickSight User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoxPlotVisual()

Constructors
Constructor and Description
`BoxPlotVisual()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxPlotVisual`	`clone()`
`boolean`	`equals(Object obj)`
`List<VisualCustomAction>`	`getActions()` The list of custom actions that are configured for a visual.
`BoxPlotChartConfiguration`	`getChartConfiguration()` The configuration settings of the visual.
`List<ColumnHierarchy>`	`getColumnHierarchies()` The column hierarchy that is used during drill-downs and drill-ups.
`VisualSubtitleLabelOptions`	`getSubtitle()` The subtitle that is displayed on the visual.
`VisualTitleLabelOptions`	`getTitle()` The title that is displayed on the visual.
`String`	`getVisualId()` The unique identifier of a visual.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setActions(Collection<VisualCustomAction> actions)` The list of custom actions that are configured for a visual.
`void`	`setChartConfiguration(BoxPlotChartConfiguration chartConfiguration)` The configuration settings of the visual.
`void`	`setColumnHierarchies(Collection<ColumnHierarchy> columnHierarchies)` The column hierarchy that is used during drill-downs and drill-ups.
`void`	`setSubtitle(VisualSubtitleLabelOptions subtitle)` The subtitle that is displayed on the visual.
`void`	`setTitle(VisualTitleLabelOptions title)` The title that is displayed on the visual.
`void`	`setVisualId(String visualId)` The unique identifier of a visual.
`String`	`toString()` Returns a string representation of this object.
`BoxPlotVisual`	`withActions(Collection<VisualCustomAction> actions)` The list of custom actions that are configured for a visual.
`BoxPlotVisual`	`withActions(VisualCustomAction... actions)` The list of custom actions that are configured for a visual.
`BoxPlotVisual`	`withChartConfiguration(BoxPlotChartConfiguration chartConfiguration)` The configuration settings of the visual.
`BoxPlotVisual`	`withColumnHierarchies(Collection<ColumnHierarchy> columnHierarchies)` The column hierarchy that is used during drill-downs and drill-ups.
`BoxPlotVisual`	`withColumnHierarchies(ColumnHierarchy... columnHierarchies)` The column hierarchy that is used during drill-downs and drill-ups.
`BoxPlotVisual`	`withSubtitle(VisualSubtitleLabelOptions subtitle)` The subtitle that is displayed on the visual.
`BoxPlotVisual`	`withTitle(VisualTitleLabelOptions title)` The title that is displayed on the visual.
`BoxPlotVisual`	`withVisualId(String visualId)` The unique identifier of a visual.

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

- Constructor Detail
  - BoxPlotVisual
```
public BoxPlotVisual()
```
- Method Detail
  - setVisualId
```
public void setVisualId(String visualId)
```
    The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
    
    Parameters:
    
    visualId - The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  - getVisualId
```
public String getVisualId()
```
    The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
    
    Returns:
    
    The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  - withVisualId
```
public BoxPlotVisual withVisualId(String visualId)
```
    The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
    
    Parameters:
    
    visualId - The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(VisualTitleLabelOptions title)
```
    The title that is displayed on the visual.
    
    Parameters:
    
    title - The title that is displayed on the visual.
  - getTitle
```
public VisualTitleLabelOptions getTitle()
```
    The title that is displayed on the visual.
    
    Returns:
    
    The title that is displayed on the visual.
  - withTitle
```
public BoxPlotVisual withTitle(VisualTitleLabelOptions title)
```
    The title that is displayed on the visual.
    
    Parameters:
    
    title - The title that is displayed on the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubtitle
```
public void setSubtitle(VisualSubtitleLabelOptions subtitle)
```
    The subtitle that is displayed on the visual.
    
    Parameters:
    
    subtitle - The subtitle that is displayed on the visual.
  - getSubtitle
```
public VisualSubtitleLabelOptions getSubtitle()
```
    The subtitle that is displayed on the visual.
    
    Returns:
    
    The subtitle that is displayed on the visual.
  - withSubtitle
```
public BoxPlotVisual withSubtitle(VisualSubtitleLabelOptions subtitle)
```
    The subtitle that is displayed on the visual.
    
    Parameters:
    
    subtitle - The subtitle that is displayed on the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChartConfiguration
```
public void setChartConfiguration(BoxPlotChartConfiguration chartConfiguration)
```
    The configuration settings of the visual.
    
    Parameters:
    
    chartConfiguration - The configuration settings of the visual.
  - getChartConfiguration
```
public BoxPlotChartConfiguration getChartConfiguration()
```
    The configuration settings of the visual.
    
    Returns:
    
    The configuration settings of the visual.
  - withChartConfiguration
```
public BoxPlotVisual withChartConfiguration(BoxPlotChartConfiguration chartConfiguration)
```
    The configuration settings of the visual.
    
    Parameters:
    
    chartConfiguration - The configuration settings of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<VisualCustomAction> getActions()
```
    The list of custom actions that are configured for a visual.
    
    Returns:
    
    The list of custom actions that are configured for a visual.
  - setActions
```
public void setActions(Collection<VisualCustomAction> actions)
```
    The list of custom actions that are configured for a visual.
    
    Parameters:
    
    actions - The list of custom actions that are configured for a visual.
  - withActions
```
public BoxPlotVisual withActions(VisualCustomAction... actions)
```
    The list of custom actions that are configured for a visual.
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actions - The list of custom actions that are configured for a visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public BoxPlotVisual withActions(Collection<VisualCustomAction> actions)
```
    The list of custom actions that are configured for a visual.
    
    Parameters:
    
    actions - The list of custom actions that are configured for a visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getColumnHierarchies
```
public List<ColumnHierarchy> getColumnHierarchies()
```
    The column hierarchy that is used during drill-downs and drill-ups.
    
    Returns:
    
    The column hierarchy that is used during drill-downs and drill-ups.
  - setColumnHierarchies
```
public void setColumnHierarchies(Collection<ColumnHierarchy> columnHierarchies)
```
    The column hierarchy that is used during drill-downs and drill-ups.
    
    Parameters:
    
    columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.
  - withColumnHierarchies
```
public BoxPlotVisual withColumnHierarchies(ColumnHierarchy... columnHierarchies)
```
    The column hierarchy that is used during drill-downs and drill-ups.
    
    NOTE: This method appends the values to the existing list (if any). Use setColumnHierarchies(java.util.Collection) or withColumnHierarchies(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withColumnHierarchies
```
public BoxPlotVisual withColumnHierarchies(Collection<ColumnHierarchy> columnHierarchies)
```
    The column hierarchy that is used during drill-downs and drill-ups.
    
    Parameters:
    
    columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.
    
    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 BoxPlotVisual clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class BoxPlotVisual

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoxPlotVisual

Method Detail

setVisualId

getVisualId

withVisualId

setTitle

getTitle

withTitle

setSubtitle

getSubtitle

withSubtitle

setChartConfiguration

getChartConfiguration

withChartConfiguration

getActions

setActions

withActions

withActions

getColumnHierarchies

setColumnHierarchies

withColumnHierarchies

withColumnHierarchies

toString

equals

hashCode

clone

marshall