# PivotTableOptionsProperty

The table options for a pivot table visual.

- Source: Generated code
- Type last changed: v2.95.0 · 7 Sep 2023

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const pivotTableOptionsProperty: quicksight.CfnAnalysis.PivotTableOptionsProperty = {
  cellStyle: {
    backgroundColor: 'backgroundColor',
    border: {
      sideSpecificBorder: {
        bottom: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerHorizontal: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerVertical: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        left: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        right: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        top: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
      },
      uniformBorder: {
        color: 'color',
        style: 'style',
        thickness: 123,
      },
    },
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    height: 123,
    horizontalTextAlignment: 'horizontalTextAlignment',
    textWrap: 'textWrap',
    verticalTextAlignment: 'verticalTextAlignment',
    visibility: 'visibility',
  },
  collapsedRowDimensionsVisibility: 'collapsedRowDimensionsVisibility',
  columnHeaderStyle: {
    backgroundColor: 'backgroundColor',
    border: {
      sideSpecificBorder: {
        bottom: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerHorizontal: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerVertical: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        left: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        right: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        top: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
      },
      uniformBorder: {
        color: 'color',
        style: 'style',
        thickness: 123,
      },
    },
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    height: 123,
    horizontalTextAlignment: 'horizontalTextAlignment',
    textWrap: 'textWrap',
    verticalTextAlignment: 'verticalTextAlignment',
    visibility: 'visibility',
  },
  columnNamesVisibility: 'columnNamesVisibility',
  defaultCellWidth: 'defaultCellWidth',
  metricPlacement: 'metricPlacement',
  rowAlternateColorOptions: {
    rowAlternateColors: ['rowAlternateColors'],
    status: 'status',
    usePrimaryBackgroundColor: 'usePrimaryBackgroundColor',
  },
  rowFieldNamesStyle: {
    backgroundColor: 'backgroundColor',
    border: {
      sideSpecificBorder: {
        bottom: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerHorizontal: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerVertical: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        left: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        right: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        top: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
      },
      uniformBorder: {
        color: 'color',
        style: 'style',
        thickness: 123,
      },
    },
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    height: 123,
    horizontalTextAlignment: 'horizontalTextAlignment',
    textWrap: 'textWrap',
    verticalTextAlignment: 'verticalTextAlignment',
    visibility: 'visibility',
  },
  rowHeaderStyle: {
    backgroundColor: 'backgroundColor',
    border: {
      sideSpecificBorder: {
        bottom: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerHorizontal: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        innerVertical: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        left: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        right: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
        top: {
          color: 'color',
          style: 'style',
          thickness: 123,
        },
      },
      uniformBorder: {
        color: 'color',
        style: 'style',
        thickness: 123,
      },
    },
    fontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontFamily: 'fontFamily',
      fontSize: {
        absolute: 'absolute',
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    height: 123,
    horizontalTextAlignment: 'horizontalTextAlignment',
    textWrap: 'textWrap',
    verticalTextAlignment: 'verticalTextAlignment',
    visibility: 'visibility',
  },
  rowsLabelOptions: {
    customLabel: 'customLabel',
    visibility: 'visibility',
  },
  rowsLayout: 'rowsLayout',
  singleMetricVisibility: 'singleMetricVisibility',
  toggleButtonsVisibility: 'toggleButtonsVisibility',
};
```

## Properties

- `cellStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.TableCellStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.TableCellStyleProperty.html) — The table cell style of cells.

- `collapsedRowDimensionsVisibility`: string — 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` .

- `columnHeaderStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.TableCellStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.TableCellStyleProperty.html) — The table cell style of the column header.

- `columnNamesVisibility`: string — The visibility of the column names.

- `defaultCellWidth`: string — The default cell width of the pivot table.

- `metricPlacement`: string — The metric placement (row, column) options.

- `rowAlternateColorOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.RowAlternateColorOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.RowAlternateColorOptionsProperty.html) — The row alternate color options (widget status, row alternate colors).

- `rowFieldNamesStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.TableCellStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.TableCellStyleProperty.html) — The table cell style of row field names.

- `rowHeaderStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.TableCellStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.TableCellStyleProperty.html) — The table cell style of the row headers.

- `rowsLabelOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.PivotTableRowsLabelOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.PivotTableRowsLabelOptionsProperty.html) — The options for the label that is located above the row headers.

  This option is only applicable when `RowsLayout` is set to `HIERARCHY` .

- `rowsLayout`: string — 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.

- `singleMetricVisibility`: string — The visibility of the single metric options.

- `toggleButtonsVisibility`: string — Determines the visibility of the pivot table.
