All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnAnalysis.PivotTotalOptionsProperty.Jsii$Proxy

Enclosing class:: CfnAnalysis

@Stability(Stable) public static interface CfnAnalysis.PivotTotalOptionsProperty extends software.amazon.jsii.JsiiSerializable

The optional configuration of totals cells in a PivotTableVisual .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 PivotTotalOptionsProperty pivotTotalOptionsProperty = PivotTotalOptionsProperty.builder()
         .customLabel("customLabel")
         .metricHeaderCellStyle(TableCellStyleProperty.builder()
                 .backgroundColor("backgroundColor")
                 .border(GlobalTableBorderOptionsProperty.builder()
                         .sideSpecificBorder(TableSideBorderOptionsProperty.builder()
                                 .bottom(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerHorizontal(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerVertical(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .left(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .right(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .top(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .build())
                         .uniformBorder(TableBorderOptionsProperty.builder()
                                 .color("color")
                                 .style("style")
                                 .thickness(123)
                                 .build())
                         .build())
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontFamily("fontFamily")
                         .fontSize(FontSizeProperty.builder()
                                 .absolute("absolute")
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .placement("placement")
         .scrollStatus("scrollStatus")
         .totalAggregationOptions(List.of(TotalAggregationOptionProperty.builder()
                 .fieldId("fieldId")
                 .totalAggregationFunction(TotalAggregationFunctionProperty.builder()
                         .simpleTotalAggregationFunction("simpleTotalAggregationFunction")
                         .build())
                 .build()))
         .totalCellStyle(TableCellStyleProperty.builder()
                 .backgroundColor("backgroundColor")
                 .border(GlobalTableBorderOptionsProperty.builder()
                         .sideSpecificBorder(TableSideBorderOptionsProperty.builder()
                                 .bottom(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerHorizontal(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerVertical(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .left(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .right(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .top(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .build())
                         .uniformBorder(TableBorderOptionsProperty.builder()
                                 .color("color")
                                 .style("style")
                                 .thickness(123)
                                 .build())
                         .build())
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontFamily("fontFamily")
                         .fontSize(FontSizeProperty.builder()
                                 .absolute("absolute")
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .totalsVisibility("totalsVisibility")
         .valueCellStyle(TableCellStyleProperty.builder()
                 .backgroundColor("backgroundColor")
                 .border(GlobalTableBorderOptionsProperty.builder()
                         .sideSpecificBorder(TableSideBorderOptionsProperty.builder()
                                 .bottom(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerHorizontal(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerVertical(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .left(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .right(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .top(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .build())
                         .uniformBorder(TableBorderOptionsProperty.builder()
                                 .color("color")
                                 .style("style")
                                 .thickness(123)
                                 .build())
                         .build())
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontFamily("fontFamily")
                         .fontSize(FontSizeProperty.builder()
                                 .absolute("absolute")
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnAnalysis.PivotTotalOptionsProperty.Builder

A builder for CfnAnalysis.PivotTotalOptionsProperty

static final class

CfnAnalysis.PivotTotalOptionsProperty.Jsii$Proxy

An implementation for CfnAnalysis.PivotTotalOptionsProperty
Method Summary

Modifier and Type

Method

Description

static CfnAnalysis.PivotTotalOptionsProperty.Builder

builder()

default String

getCustomLabel()

The custom label string for the total cells.

default Object

getMetricHeaderCellStyle()

The cell styling options for the total of header cells.

default String

getPlacement()

The placement (start, end) for the total cells.

default String

getScrollStatus()

The scroll status (pinned, scrolled) for the total cells.

default Object

getTotalAggregationOptions()

The total aggregation options for each value field.

default Object

getTotalCellStyle()

The cell styling options for the total cells.

default String

getTotalsVisibility()

The visibility configuration for the total cells.

default Object

getValueCellStyle()

The cell styling options for the totals of value cells.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCustomLabel
  
  @Stability(Stable) @Nullable default String getCustomLabel()
  
  The custom label string for the total cells.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-customlabel
- getMetricHeaderCellStyle
  
  @Stability(Stable) @Nullable default Object getMetricHeaderCellStyle()
  
  The cell styling options for the total of header cells.
  Returns union: either IResolvable or CfnAnalysis.TableCellStyleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-metricheadercellstyle
- getPlacement
  
  @Stability(Stable) @Nullable default String getPlacement()
  
  The placement (start, end) for the total cells.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-placement
- getScrollStatus
  
  @Stability(Stable) @Nullable default String getScrollStatus()
  
  The scroll status (pinned, scrolled) for the total cells.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-scrollstatus
- getTotalAggregationOptions
  
  @Stability(Stable) @Nullable default Object getTotalAggregationOptions()
  
  The total aggregation options for each value field.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.TotalAggregationOptionProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalaggregationoptions
- getTotalCellStyle
  
  @Stability(Stable) @Nullable default Object getTotalCellStyle()
  
  The cell styling options for the total cells.
  Returns union: either IResolvable or CfnAnalysis.TableCellStyleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalcellstyle
- getTotalsVisibility
  
  @Stability(Stable) @Nullable default String getTotalsVisibility()
  
  The visibility configuration for the total cells.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalsvisibility
- getValueCellStyle
  
  @Stability(Stable) @Nullable default Object getValueCellStyle()
  
  The cell styling options for the totals of value cells.
  Returns union: either IResolvable or CfnAnalysis.TableCellStyleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-valuecellstyle
- builder
  
  @Stability(Stable) static CfnAnalysis.PivotTotalOptionsProperty.Builder builder()
  
  Returns:
  
  a CfnAnalysis.PivotTotalOptionsProperty.Builder of CfnAnalysis.PivotTotalOptionsProperty

Interface CfnAnalysis.PivotTotalOptionsProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCustomLabel

getMetricHeaderCellStyle

getPlacement

getScrollStatus

getTotalAggregationOptions

getTotalCellStyle

getTotalsVisibility

getValueCellStyle

builder