PivotTotalOptions (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PivotTotalOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The optional configuration of totals cells in a PivotTableVisual.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PivotTotalOptions()

Constructors
Constructor and Description
`PivotTotalOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PivotTotalOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomLabel()` The custom label string for the total cells.
`TableCellStyle`	`getMetricHeaderCellStyle()` The cell styling options for the total of header cells.
`String`	`getPlacement()` The placement (start, end) for the total cells.
`String`	`getScrollStatus()` The scroll status (pinned, scrolled) for the total cells.
`TableCellStyle`	`getTotalCellStyle()` The cell styling options for the total cells.
`String`	`getTotalsVisibility()` The visibility configuration for the total cells.
`TableCellStyle`	`getValueCellStyle()` The cell styling options for the totals of value cells.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomLabel(String customLabel)` The custom label string for the total cells.
`void`	`setMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)` The cell styling options for the total of header cells.
`void`	`setPlacement(String placement)` The placement (start, end) for the total cells.
`void`	`setScrollStatus(String scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`void`	`setTotalCellStyle(TableCellStyle totalCellStyle)` The cell styling options for the total cells.
`void`	`setTotalsVisibility(String totalsVisibility)` The visibility configuration for the total cells.
`void`	`setValueCellStyle(TableCellStyle valueCellStyle)` The cell styling options for the totals of value cells.
`String`	`toString()` Returns a string representation of this object.
`PivotTotalOptions`	`withCustomLabel(String customLabel)` The custom label string for the total cells.
`PivotTotalOptions`	`withMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)` The cell styling options for the total of header cells.
`PivotTotalOptions`	`withPlacement(String placement)` The placement (start, end) for the total cells.
`PivotTotalOptions`	`withPlacement(TableTotalsPlacement placement)` The placement (start, end) for the total cells.
`PivotTotalOptions`	`withScrollStatus(String scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`PivotTotalOptions`	`withScrollStatus(TableTotalsScrollStatus scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`PivotTotalOptions`	`withTotalCellStyle(TableCellStyle totalCellStyle)` The cell styling options for the total cells.
`PivotTotalOptions`	`withTotalsVisibility(String totalsVisibility)` The visibility configuration for the total cells.
`PivotTotalOptions`	`withTotalsVisibility(Visibility totalsVisibility)` The visibility configuration for the total cells.
`PivotTotalOptions`	`withValueCellStyle(TableCellStyle valueCellStyle)` The cell styling options for the totals of value cells.

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

- Constructor Detail
  - PivotTotalOptions
```
public PivotTotalOptions()
```
- Method Detail
  - setTotalsVisibility
```
public void setTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    See Also:
    
    Visibility
  - getTotalsVisibility
```
public String getTotalsVisibility()
```
    The visibility configuration for the total cells.
    
    Returns:
    
    The visibility configuration for the total cells.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public PivotTotalOptions withTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public PivotTotalOptions withTotalsVisibility(Visibility totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - setPlacement
```
public void setPlacement(String placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    See Also:
    
    TableTotalsPlacement
  - getPlacement
```
public String getPlacement()
```
    The placement (start, end) for the total cells.
    
    Returns:
    
    The placement (start, end) for the total cells.
    
    See Also:
    
    TableTotalsPlacement
  - withPlacement
```
public PivotTotalOptions withPlacement(String placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsPlacement
  - withPlacement
```
public PivotTotalOptions withPlacement(TableTotalsPlacement placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsPlacement
  - setScrollStatus
```
public void setScrollStatus(String scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    See Also:
    
    TableTotalsScrollStatus
  - getScrollStatus
```
public String getScrollStatus()
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    The scroll status (pinned, scrolled) for the total cells.
    
    See Also:
    
    TableTotalsScrollStatus
  - withScrollStatus
```
public PivotTotalOptions withScrollStatus(String scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsScrollStatus
  - withScrollStatus
```
public PivotTotalOptions withScrollStatus(TableTotalsScrollStatus scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsScrollStatus
  - setCustomLabel
```
public void setCustomLabel(String customLabel)
```
    The custom label string for the total cells.
    
    Parameters:
    
    customLabel - The custom label string for the total cells.
  - getCustomLabel
```
public String getCustomLabel()
```
    The custom label string for the total cells.
    
    Returns:
    
    The custom label string for the total cells.
  - withCustomLabel
```
public PivotTotalOptions withCustomLabel(String customLabel)
```
    The custom label string for the total cells.
    
    Parameters:
    
    customLabel - The custom label string for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalCellStyle
```
public void setTotalCellStyle(TableCellStyle totalCellStyle)
```
    The cell styling options for the total cells.
    
    Parameters:
    
    totalCellStyle - The cell styling options for the total cells.
  - getTotalCellStyle
```
public TableCellStyle getTotalCellStyle()
```
    The cell styling options for the total cells.
    
    Returns:
    
    The cell styling options for the total cells.
  - withTotalCellStyle
```
public PivotTotalOptions withTotalCellStyle(TableCellStyle totalCellStyle)
```
    The cell styling options for the total cells.
    
    Parameters:
    
    totalCellStyle - The cell styling options for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueCellStyle
```
public void setValueCellStyle(TableCellStyle valueCellStyle)
```
    The cell styling options for the totals of value cells.
    
    Parameters:
    
    valueCellStyle - The cell styling options for the totals of value cells.
  - getValueCellStyle
```
public TableCellStyle getValueCellStyle()
```
    The cell styling options for the totals of value cells.
    
    Returns:
    
    The cell styling options for the totals of value cells.
  - withValueCellStyle
```
public PivotTotalOptions withValueCellStyle(TableCellStyle valueCellStyle)
```
    The cell styling options for the totals of value cells.
    
    Parameters:
    
    valueCellStyle - The cell styling options for the totals of value cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricHeaderCellStyle
```
public void setMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)
```
    The cell styling options for the total of header cells.
    
    Parameters:
    
    metricHeaderCellStyle - The cell styling options for the total of header cells.
  - getMetricHeaderCellStyle
```
public TableCellStyle getMetricHeaderCellStyle()
```
    The cell styling options for the total of header cells.
    
    Returns:
    
    The cell styling options for the total of header cells.
  - withMetricHeaderCellStyle
```
public PivotTotalOptions withMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)
```
    The cell styling options for the total of header cells.
    
    Parameters:
    
    metricHeaderCellStyle - The cell styling options for the total of header cells.
    
    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 PivotTotalOptions 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.

Did this page help you?

Class PivotTotalOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PivotTotalOptions

Method Detail

setTotalsVisibility

getTotalsVisibility

withTotalsVisibility

withTotalsVisibility

setPlacement

getPlacement

withPlacement

withPlacement

setScrollStatus

getScrollStatus

withScrollStatus

withScrollStatus

setCustomLabel

getCustomLabel

withCustomLabel

setTotalCellStyle

getTotalCellStyle

withTotalCellStyle

setValueCellStyle

getValueCellStyle

withValueCellStyle

setMetricHeaderCellStyle

getMetricHeaderCellStyle

withMetricHeaderCellStyle

toString

equals

hashCode

clone

marshall