ScatterPlotConfiguration (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The configuration of a scatter plot.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScatterPlotConfiguration()

Constructors
Constructor and Description
`ScatterPlotConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScatterPlotConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`DataLabelOptions`	`getDataLabels()` The options that determine if visual data labels are displayed.
`ScatterPlotFieldWells`	`getFieldWells()` The field wells of the visual.
`LegendOptions`	`getLegend()` The legend display setup of the visual.
`TooltipOptions`	`getTooltip()` The legend display setup of the visual.
`VisualPalette`	`getVisualPalette()` The palette (chart color) display setup of the visual.
`AxisDisplayOptions`	`getXAxisDisplayOptions()` The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
`ChartAxisLabelOptions`	`getXAxisLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
`AxisDisplayOptions`	`getYAxisDisplayOptions()` The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
`ChartAxisLabelOptions`	`getYAxisLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`void`	`setFieldWells(ScatterPlotFieldWells fieldWells)` The field wells of the visual.
`void`	`setLegend(LegendOptions legend)` The legend display setup of the visual.
`void`	`setTooltip(TooltipOptions tooltip)` The legend display setup of the visual.
`void`	`setVisualPalette(VisualPalette visualPalette)` The palette (chart color) display setup of the visual.
`void`	`setXAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)` The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
`void`	`setXAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
`void`	`setYAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)` The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
`void`	`setYAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
`String`	`toString()` Returns a string representation of this object.
`ScatterPlotConfiguration`	`withDataLabels(DataLabelOptions dataLabels)` The options that determine if visual data labels are displayed.
`ScatterPlotConfiguration`	`withFieldWells(ScatterPlotFieldWells fieldWells)` The field wells of the visual.
`ScatterPlotConfiguration`	`withLegend(LegendOptions legend)` The legend display setup of the visual.
`ScatterPlotConfiguration`	`withTooltip(TooltipOptions tooltip)` The legend display setup of the visual.
`ScatterPlotConfiguration`	`withVisualPalette(VisualPalette visualPalette)` The palette (chart color) display setup of the visual.
`ScatterPlotConfiguration`	`withXAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)` The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
`ScatterPlotConfiguration`	`withXAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
`ScatterPlotConfiguration`	`withYAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)` The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
`ScatterPlotConfiguration`	`withYAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)` The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

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

- Constructor Detail
  - ScatterPlotConfiguration
```
public ScatterPlotConfiguration()
```
- Method Detail
  - setFieldWells
```
public void setFieldWells(ScatterPlotFieldWells fieldWells)
```
    The field wells of the visual.
    
    Parameters:
    
    fieldWells - The field wells of the visual.
  - getFieldWells
```
public ScatterPlotFieldWells getFieldWells()
```
    The field wells of the visual.
    
    Returns:
    
    The field wells of the visual.
  - withFieldWells
```
public ScatterPlotConfiguration withFieldWells(ScatterPlotFieldWells 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.
  - setXAxisLabelOptions
```
public void setXAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
    
    Parameters:
    
    xAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
  - getXAxisLabelOptions
```
public ChartAxisLabelOptions getXAxisLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
  - withXAxisLabelOptions
```
public ScatterPlotConfiguration withXAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
    
    Parameters:
    
    xAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setXAxisDisplayOptions
```
public void setXAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
    
    Parameters:
    
    xAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
  - getXAxisDisplayOptions
```
public AxisDisplayOptions getXAxisDisplayOptions()
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
    
    Returns:
    
    The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
  - withXAxisDisplayOptions
```
public ScatterPlotConfiguration withXAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
    
    Parameters:
    
    xAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setYAxisLabelOptions
```
public void setYAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
    
    Parameters:
    
    yAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
  - getYAxisLabelOptions
```
public ChartAxisLabelOptions getYAxisLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
  - withYAxisLabelOptions
```
public ScatterPlotConfiguration withYAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)
```
    The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
    
    Parameters:
    
    yAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setYAxisDisplayOptions
```
public void setYAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
    
    Parameters:
    
    yAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
  - getYAxisDisplayOptions
```
public AxisDisplayOptions getYAxisDisplayOptions()
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
    
    Returns:
    
    The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
  - withYAxisDisplayOptions
```
public ScatterPlotConfiguration withYAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)
```
    The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
    
    Parameters:
    
    yAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLegend
```
public void setLegend(LegendOptions legend)
```
    The legend display setup of the visual.
    
    Parameters:
    
    legend - The legend display setup of the visual.
  - getLegend
```
public LegendOptions getLegend()
```
    The legend display setup of the visual.
    
    Returns:
    
    The legend display setup of the visual.
  - withLegend
```
public ScatterPlotConfiguration withLegend(LegendOptions legend)
```
    The legend display setup of the visual.
    
    Parameters:
    
    legend - The legend display setup of the visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataLabels
```
public void setDataLabels(DataLabelOptions dataLabels)
```
    The options that determine if visual data labels are displayed.
    
    Parameters:
    
    dataLabels - The options that determine if visual data labels are displayed.
  - getDataLabels
```
public DataLabelOptions getDataLabels()
```
    The options that determine if visual data labels are displayed.
    
    Returns:
    
    The options that determine if visual data labels are displayed.
  - withDataLabels
```
public ScatterPlotConfiguration withDataLabels(DataLabelOptions dataLabels)
```
    The options that determine if visual data labels are displayed.
    
    Parameters:
    
    dataLabels - The options that determine if visual data labels are displayed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTooltip
```
public void setTooltip(TooltipOptions tooltip)
```
    The legend display setup of the visual.
    
    Parameters:
    
    tooltip - The legend display setup of the visual.
  - getTooltip
```
public TooltipOptions getTooltip()
```
    The legend display setup of the visual.
    
    Returns:
    
    The legend display setup of the visual.
  - withTooltip
```
public ScatterPlotConfiguration withTooltip(TooltipOptions tooltip)
```
    The legend display setup of the visual.
    
    Parameters:
    
    tooltip - The legend display 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 ScatterPlotConfiguration 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.
  - 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 ScatterPlotConfiguration 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.595

Class ScatterPlotConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScatterPlotConfiguration

Method Detail

setFieldWells

getFieldWells

withFieldWells

setXAxisLabelOptions

getXAxisLabelOptions

withXAxisLabelOptions

setXAxisDisplayOptions

getXAxisDisplayOptions

withXAxisDisplayOptions

setYAxisLabelOptions

getYAxisLabelOptions

withYAxisLabelOptions

setYAxisDisplayOptions

getYAxisDisplayOptions

withYAxisDisplayOptions

setLegend

getLegend

withLegend

setDataLabels

getDataLabels

withDataLabels

setTooltip

getTooltip

withTooltip

setVisualPalette

getVisualPalette

withVisualPalette

toString

equals

hashCode

clone

marshall