LegendOptions (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The options for the legend setup of a visual.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LegendOptions()

Constructors
Constructor and Description
`LegendOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LegendOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getHeight()` The height of the legend.
`String`	`getPosition()` The positions for the legend.
`LabelOptions`	`getTitle()` The custom title for the legend.
`String`	`getVisibility()` Determines whether or not the legend is visible.
`String`	`getWidth()` The width of the legend.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHeight(String height)` The height of the legend.
`void`	`setPosition(String position)` The positions for the legend.
`void`	`setTitle(LabelOptions title)` The custom title for the legend.
`void`	`setVisibility(String visibility)` Determines whether or not the legend is visible.
`void`	`setWidth(String width)` The width of the legend.
`String`	`toString()` Returns a string representation of this object.
`LegendOptions`	`withHeight(String height)` The height of the legend.
`LegendOptions`	`withPosition(LegendPosition position)` The positions for the legend.
`LegendOptions`	`withPosition(String position)` The positions for the legend.
`LegendOptions`	`withTitle(LabelOptions title)` The custom title for the legend.
`LegendOptions`	`withVisibility(String visibility)` Determines whether or not the legend is visible.
`LegendOptions`	`withVisibility(Visibility visibility)` Determines whether or not the legend is visible.
`LegendOptions`	`withWidth(String width)` The width of the legend.

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

- Constructor Detail
  - LegendOptions
```
public LegendOptions()
```
- Method Detail
  - setVisibility
```
public void setVisibility(String visibility)
```
    Determines whether or not the legend is visible.
    
    Parameters:
    
    visibility - Determines whether or not the legend is visible.
    
    See Also:
    
    Visibility
  - getVisibility
```
public String getVisibility()
```
    Determines whether or not the legend is visible.
    
    Returns:
    
    Determines whether or not the legend is visible.
    
    See Also:
    
    Visibility
  - withVisibility
```
public LegendOptions withVisibility(String visibility)
```
    Determines whether or not the legend is visible.
    
    Parameters:
    
    visibility - Determines whether or not the legend is visible.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withVisibility
```
public LegendOptions withVisibility(Visibility visibility)
```
    Determines whether or not the legend is visible.
    
    Parameters:
    
    visibility - Determines whether or not the legend is visible.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - setTitle
```
public void setTitle(LabelOptions title)
```
    The custom title for the legend.
    
    Parameters:
    
    title - The custom title for the legend.
  - getTitle
```
public LabelOptions getTitle()
```
    The custom title for the legend.
    
    Returns:
    
    The custom title for the legend.
  - withTitle
```
public LegendOptions withTitle(LabelOptions title)
```
    The custom title for the legend.
    
    Parameters:
    
    title - The custom title for the legend.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosition
```
public void setPosition(String position)
```
    The positions for the legend. Choose one of the following options:
    - AUTO
    - RIGHT
    - BOTTOM
    - LEFT
    Parameters:
    position - The positions for the legend. Choose one of the following options:
    
    AUTO
    
    RIGHT
    
    BOTTOM
    
    LEFT
    See Also:
    
    LegendPosition
  - getPosition
```
public String getPosition()
```
    The positions for the legend. Choose one of the following options:
    - AUTO
    - RIGHT
    - BOTTOM
    - LEFT
    Returns:
    The positions for the legend. Choose one of the following options:
    
    AUTO
    
    RIGHT
    
    BOTTOM
    
    LEFT
    See Also:
    
    LegendPosition
  - withPosition
```
public LegendOptions withPosition(String position)
```
    The positions for the legend. Choose one of the following options:
    - AUTO
    - RIGHT
    - BOTTOM
    - LEFT
    Parameters:
    position - The positions for the legend. Choose one of the following options:
    
    AUTO
    
    RIGHT
    
    BOTTOM
    
    LEFT
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LegendPosition
  - withPosition
```
public LegendOptions withPosition(LegendPosition position)
```
    The positions for the legend. Choose one of the following options:
    - AUTO
    - RIGHT
    - BOTTOM
    - LEFT
    Parameters:
    position - The positions for the legend. Choose one of the following options:
    
    AUTO
    
    RIGHT
    
    BOTTOM
    
    LEFT
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LegendPosition
  - setWidth
```
public void setWidth(String width)
```
    The width of the legend. If this value is omitted, a default width is used when rendering.
    
    Parameters:
    
    width - The width of the legend. If this value is omitted, a default width is used when rendering.
  - getWidth
```
public String getWidth()
```
    The width of the legend. If this value is omitted, a default width is used when rendering.
    
    Returns:
    
    The width of the legend. If this value is omitted, a default width is used when rendering.
  - withWidth
```
public LegendOptions withWidth(String width)
```
    The width of the legend. If this value is omitted, a default width is used when rendering.
    
    Parameters:
    
    width - The width of the legend. If this value is omitted, a default width is used when rendering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeight
```
public void setHeight(String height)
```
    The height of the legend. If this value is omitted, a default height is used when rendering.
    
    Parameters:
    
    height - The height of the legend. If this value is omitted, a default height is used when rendering.
  - getHeight
```
public String getHeight()
```
    The height of the legend. If this value is omitted, a default height is used when rendering.
    
    Returns:
    
    The height of the legend. If this value is omitted, a default height is used when rendering.
  - withHeight
```
public LegendOptions withHeight(String height)
```
    The height of the legend. If this value is omitted, a default height is used when rendering.
    
    Parameters:
    
    height - The height of the legend. If this value is omitted, a default height is used when rendering.
    
    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 LegendOptions 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.773

Class LegendOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LegendOptions

Method Detail

setVisibility

getVisibility

withVisibility

withVisibility

setTitle

getTitle

withTitle

setPosition

getPosition

withPosition

withPosition

setWidth

getWidth

withWidth

setHeight

getHeight

withHeight

toString

equals

hashCode

clone

marshall