AWS::QuickSight::Template PivotTableOptions

The table options for a pivot table visual.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CellStyle" : TableCellStyle,
  "CollapsedRowDimensionsVisibility" : String,
  "ColumnHeaderStyle" : TableCellStyle,
  "ColumnNamesVisibility" : String,
  "DefaultCellWidth" : String,
  "MetricPlacement" : String,
  "RowAlternateColorOptions" : RowAlternateColorOptions,
  "RowFieldNamesStyle" : TableCellStyle,
  "RowHeaderStyle" : TableCellStyle,
  "RowsLabelOptions" : PivotTableRowsLabelOptions,
  "RowsLayout" : String,
  "SingleMetricVisibility" : String,
  "ToggleButtonsVisibility" : String
}

YAML

  CellStyle: 
    TableCellStyle
  CollapsedRowDimensionsVisibility: String
  ColumnHeaderStyle: 
    TableCellStyle
  ColumnNamesVisibility: String
  DefaultCellWidth: String
  MetricPlacement: String
  RowAlternateColorOptions: 
    RowAlternateColorOptions
  RowFieldNamesStyle: 
    TableCellStyle
  RowHeaderStyle: 
    TableCellStyle
  RowsLabelOptions: 
    PivotTableRowsLabelOptions
  RowsLayout: String
  SingleMetricVisibility: String
  ToggleButtonsVisibility: String

Properties

CellStyle

The table cell style of cells.

Required: No

Type: TableCellStyle

Update requires: No interruption

CollapsedRowDimensionsVisibility

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.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

ColumnHeaderStyle

The table cell style of the column header.

Required: No

Type: TableCellStyle

Update requires: No interruption

ColumnNamesVisibility

The visibility of the column names.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

DefaultCellWidth

The default cell width of the pivot table.

Required: No

Type: String

Update requires: No interruption

MetricPlacement

The metric placement (row, column) options.

Required: No

Type: String

Allowed values: ROW | COLUMN

Update requires: No interruption

RowAlternateColorOptions

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

Required: No

Type: RowAlternateColorOptions

Update requires: No interruption

RowFieldNamesStyle

The table cell style of row field names.

Required: No

Type: TableCellStyle

Update requires: No interruption

RowHeaderStyle

The table cell style of the row headers.

Required: No

Type: TableCellStyle

Update requires: No interruption

RowsLabelOptions

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

Required: No

Type: PivotTableRowsLabelOptions

Update requires: No interruption

RowsLayout

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.

Required: No

Type: String

Allowed values: TABULAR | HIERARCHY

Update requires: No interruption

SingleMetricVisibility

The visibility of the single metric options.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

ToggleButtonsVisibility

Determines the visibility of the pivot table.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption