Skip to content

PivotTableOptions

Source code in docs_src/capo_quicksight/types/pivot_table_options.py
class PivotTableOptions(TypedDict, closed=True):
    metric_placement: NotRequired[
        "capo_quicksight.types.pivot_table_metric_placement.PivotTableMetricPlacement"
    ]
    """<p>The metric placement (row, column) options.</p>"""
    single_metric_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>The visibility of the single metric options.</p>"""
    column_names_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>The visibility of the column names.</p>"""
    toggle_buttons_visibility: NotRequired[
        "capo_quicksight.types.visibility.Visibility"
    ]
    """<p>Determines the visibility of the pivot table.</p>"""
    column_header_style: NotRequired[
        "capo_quicksight.types.table_cell_style.TableCellStyle"
    ]
    """<p>The table cell style of the column header.</p>"""
    row_header_style: NotRequired[
        "capo_quicksight.types.table_cell_style.TableCellStyle"
    ]
    """<p>The table cell style of the row headers.</p>"""
    cell_style: NotRequired["capo_quicksight.types.table_cell_style.TableCellStyle"]
    """<p>The table cell style of cells.</p>"""
    row_field_names_style: NotRequired[
        "capo_quicksight.types.table_cell_style.TableCellStyle"
    ]
    """<p>The table cell style of row field names.</p>"""
    row_alternate_color_options: NotRequired[
        "capo_quicksight.types.row_alternate_color_options.RowAlternateColorOptions"
    ]
    """<p>The row alternate color options (widget status, row alternate colors).</p>"""
    collapsed_row_dimensions_visibility: NotRequired[
        "capo_quicksight.types.visibility.Visibility"
    ]
    """<p>The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is <code>HIDDEN</code>, all collapsed columns in a pivot table are automatically hidden. The default value is <code>VISIBLE</code>.</p>"""
    rows_layout: NotRequired[
        "capo_quicksight.types.pivot_table_rows_layout.PivotTableRowsLayout"
    ]
    """<p>The layout for the row dimension headers of a pivot table. Choose one of the following options.</p> <ul> <li> <p> <code>TABULAR</code>: (Default) Each row field is displayed in a separate column.</p> </li> <li> <p> <code>HIERARCHY</code>: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.</p> </li> </ul>"""
    rows_label_options: NotRequired[
        "capo_quicksight.types.pivot_table_rows_label_options.PivotTableRowsLabelOptions"
    ]
    """<p>The options for the label that is located above the row headers. This option is only applicable when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>"""
    default_cell_width: NotRequired["capo_quicksight.types.pixel_length.PixelLength"]
    """<p>The default cell width of the pivot table.</p>"""

cell_style instance-attribute

cell_style: NotRequired[TableCellStyle]

The table cell style of cells.

collapsed_row_dimensions_visibility instance-attribute

collapsed_row_dimensions_visibility: NotRequired[Visibility]

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.

column_header_style instance-attribute

column_header_style: NotRequired[TableCellStyle]

The table cell style of the column header.

column_names_visibility instance-attribute

column_names_visibility: NotRequired[Visibility]

The visibility of the column names.

default_cell_width instance-attribute

default_cell_width: NotRequired[PixelLength]

The default cell width of the pivot table.

metric_placement instance-attribute

metric_placement: NotRequired[PivotTableMetricPlacement]

The metric placement (row, column) options.

row_alternate_color_options instance-attribute

row_alternate_color_options: NotRequired[RowAlternateColorOptions]

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

row_field_names_style instance-attribute

row_field_names_style: NotRequired[TableCellStyle]

The table cell style of row field names.

row_header_style instance-attribute

row_header_style: NotRequired[TableCellStyle]

The table cell style of the row headers.

rows_label_options instance-attribute

rows_label_options: NotRequired[PivotTableRowsLabelOptions]

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

rows_layout instance-attribute

rows_layout: NotRequired[PivotTableRowsLayout]

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.

single_metric_visibility instance-attribute

single_metric_visibility: NotRequired[Visibility]

The visibility of the single metric options.

toggle_buttons_visibility instance-attribute

toggle_buttons_visibility: NotRequired[Visibility]

Determines the visibility of the pivot table.