All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTemplate.PivotTableOptionsProperty.Jsii$Proxy

Enclosing class:: CfnTemplate

@Stability(Stable) public static interface CfnTemplate.PivotTableOptionsProperty extends software.amazon.jsii.JsiiSerializable

The table options for a pivot table visual.

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.*;
 PivotTableOptionsProperty pivotTableOptionsProperty = PivotTableOptionsProperty.builder()
         .cellStyle(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")
                         .fontSize(FontSizeProperty.builder()
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .collapsedRowDimensionsVisibility("collapsedRowDimensionsVisibility")
         .columnHeaderStyle(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")
                         .fontSize(FontSizeProperty.builder()
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .columnNamesVisibility("columnNamesVisibility")
         .defaultCellWidth("defaultCellWidth")
         .metricPlacement("metricPlacement")
         .rowAlternateColorOptions(RowAlternateColorOptionsProperty.builder()
                 .rowAlternateColors(List.of("rowAlternateColors"))
                 .status("status")
                 .usePrimaryBackgroundColor("usePrimaryBackgroundColor")
                 .build())
         .rowFieldNamesStyle(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")
                         .fontSize(FontSizeProperty.builder()
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .rowHeaderStyle(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")
                         .fontSize(FontSizeProperty.builder()
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .rowsLabelOptions(PivotTableRowsLabelOptionsProperty.builder()
                 .customLabel("customLabel")
                 .visibility("visibility")
                 .build())
         .rowsLayout("rowsLayout")
         .singleMetricVisibility("singleMetricVisibility")
         .toggleButtonsVisibility("toggleButtonsVisibility")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnTemplate.PivotTableOptionsProperty.Builder

A builder for CfnTemplate.PivotTableOptionsProperty

static final class

CfnTemplate.PivotTableOptionsProperty.Jsii$Proxy

An implementation for CfnTemplate.PivotTableOptionsProperty
Method Summary

Modifier and Type

Method

Description

static CfnTemplate.PivotTableOptionsProperty.Builder

builder()

default Object

getCellStyle()

The table cell style of cells.

default String

getCollapsedRowDimensionsVisibility()

The visibility setting of a pivot table's collapsed row dimension fields.

default Object

getColumnHeaderStyle()

The table cell style of the column header.

default String

getColumnNamesVisibility()

The visibility of the column names.

default String

getDefaultCellWidth()

The default cell width of the pivot table.

default String

getMetricPlacement()

The metric placement (row, column) options.

default Object

getRowAlternateColorOptions()

The row alternate color options (widget status, row alternate colors).

default Object

getRowFieldNamesStyle()

The table cell style of row field names.

default Object

getRowHeaderStyle()

The table cell style of the row headers.

default Object

getRowsLabelOptions()

The options for the label that is located above the row headers.

default String

getRowsLayout()

The layout for the row dimension headers of a pivot table.

default String

getSingleMetricVisibility()

The visibility of the single metric options.

default String

getToggleButtonsVisibility()

Determines the visibility of the pivot table.

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

Method Details
- getCellStyle
  
  @Stability(Stable) @Nullable default Object getCellStyle()
  
  The table cell style of cells.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-cellstyle
- getCollapsedRowDimensionsVisibility
  
  @Stability(Stable) @Nullable default String getCollapsedRowDimensionsVisibility()
  
  The visibility setting of a pivot table's collapsed row dimension fields.
  If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-collapsedrowdimensionsvisibility
- getColumnHeaderStyle
  
  @Stability(Stable) @Nullable default Object getColumnHeaderStyle()
  
  The table cell style of the column header.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnheaderstyle
- getColumnNamesVisibility
  
  @Stability(Stable) @Nullable default String getColumnNamesVisibility()
  
  The visibility of the column names.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnnamesvisibility
- getDefaultCellWidth
  
  @Stability(Stable) @Nullable default String getDefaultCellWidth()
  
  The default cell width of the pivot table.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-defaultcellwidth
- getMetricPlacement
  
  @Stability(Stable) @Nullable default String getMetricPlacement()
  
  The metric placement (row, column) options.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-metricplacement
- getRowAlternateColorOptions
  
  @Stability(Stable) @Nullable default Object getRowAlternateColorOptions()
  
  The row alternate color options (widget status, row alternate colors).
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowalternatecoloroptions
- getRowFieldNamesStyle
  
  @Stability(Stable) @Nullable default Object getRowFieldNamesStyle()
  
  The table cell style of row field names.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowfieldnamesstyle
- getRowHeaderStyle
  
  @Stability(Stable) @Nullable default Object getRowHeaderStyle()
  
  The table cell style of the row headers.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowheaderstyle
- getRowsLabelOptions
  
  @Stability(Stable) @Nullable default Object getRowsLabelOptions()
  
  The options for the label that is located above the row headers.
  This option is only applicable when RowsLayout is set to HIERARCHY .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslabeloptions
- getRowsLayout
  
  @Stability(Stable) @Nullable default String getRowsLayout()
  The layout for the row dimension headers of a pivot table. Choose one of the following options.
  
  TABULAR : (Default) Each row field is displayed in a separate column.
  
  HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslayout
- getSingleMetricVisibility
  
  @Stability(Stable) @Nullable default String getSingleMetricVisibility()
  
  The visibility of the single metric options.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-singlemetricvisibility
- getToggleButtonsVisibility
  
  @Stability(Stable) @Nullable default String getToggleButtonsVisibility()
  
  Determines the visibility of the pivot table.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-togglebuttonsvisibility
- builder
  
  @Stability(Stable) static CfnTemplate.PivotTableOptionsProperty.Builder builder()
  
  Returns:
  
  a CfnTemplate.PivotTableOptionsProperty.Builder of CfnTemplate.PivotTableOptionsProperty

Interface CfnTemplate.PivotTableOptionsProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCellStyle

getCollapsedRowDimensionsVisibility

getColumnHeaderStyle

getColumnNamesVisibility

getDefaultCellWidth

getMetricPlacement

getRowAlternateColorOptions

getRowFieldNamesStyle

getRowHeaderStyle

getRowsLabelOptions

getRowsLayout

getSingleMetricVisibility

getToggleButtonsVisibility

builder