PivotTableOptions - Amazon QuickSight
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PivotTableOptions

The table options for a pivot table visual.

Contents

Note

In the following list, the required parameters are described first.

CellStyle

The table cell style of cells.

Type: TableCellStyle object

Required: No

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.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

ColumnHeaderStyle

The table cell style of the column header.

Type: TableCellStyle object

Required: No

ColumnNamesVisibility

The visibility of the column names.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

DefaultCellWidth

The default cell width of the pivot table.

Type: String

Required: No

MetricPlacement

The metric placement (row, column) options.

Type: String

Valid Values: ROW | COLUMN

Required: No

RowAlternateColorOptions

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

Type: RowAlternateColorOptions object

Required: No

RowFieldNamesStyle

The table cell style of row field names.

Type: TableCellStyle object

Required: No

RowHeaderStyle

The table cell style of the row headers.

Type: TableCellStyle object

Required: No

RowsLabelOptions

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

Type: PivotTableRowsLabelOptions object

Required: No

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.

Type: String

Valid Values: TABULAR | HIERARCHY

Required: No

SingleMetricVisibility

The visibility of the single metric options.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

ToggleButtonsVisibility

Determines the visibility of the pivot table.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: