aws-cdk-lib.aws_quicksight.CfnTemplate.PivotTableOptionsProperty

PivotTableOptionsProperty Struct

The table options for a pivot table visual.

Source

Generated code

Type last changed

v2.95.0 · 7 Sep 2023

Example

// 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.CfnTemplate.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

cellStyleIResolvable | CfnTemplate.TableCellStylePropertycell_styletyping.Union[IResolvable, TableCellStyleProperty]cellStyleIResolvableCellStyleIResolvableCellStyleinterface{}#

The table cell style of cells.

collapsedRowDimensionsVisibilitystringcollapsed_row_dimensions_visibilitystrcollapsedRowDimensionsVisibilityStringCollapsedRowDimensionsVisibilitystringCollapsedRowDimensionsVisibility*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 .

columnHeaderStyleIResolvable | CfnTemplate.TableCellStylePropertycolumn_header_styletyping.Union[IResolvable, TableCellStyleProperty]columnHeaderStyleIResolvableColumnHeaderStyleIResolvableColumnHeaderStyleinterface{}#

The table cell style of the column header.

columnNamesVisibilitystringcolumn_names_visibilitystrcolumnNamesVisibilityStringColumnNamesVisibilitystringColumnNamesVisibility*string#

The visibility of the column names.

defaultCellWidthstringdefault_cell_widthstrdefaultCellWidthStringDefaultCellWidthstringDefaultCellWidth*string#

The default cell width of the pivot table.

metricPlacementstringmetric_placementstrmetricPlacementStringMetricPlacementstringMetricPlacement*string#

The metric placement (row, column) options.

rowAlternateColorOptionsIResolvable | CfnTemplate.RowAlternateColorOptionsPropertyrow_alternate_color_optionstyping.Union[IResolvable, RowAlternateColorOptionsProperty]rowAlternateColorOptionsIResolvableRowAlternateColorOptionsIResolvableRowAlternateColorOptionsinterface{}#

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

rowFieldNamesStyleIResolvable | CfnTemplate.TableCellStylePropertyrow_field_names_styletyping.Union[IResolvable, TableCellStyleProperty]rowFieldNamesStyleIResolvableRowFieldNamesStyleIResolvableRowFieldNamesStyleinterface{}#

The table cell style of row field names.

rowHeaderStyleIResolvable | CfnTemplate.TableCellStylePropertyrow_header_styletyping.Union[IResolvable, TableCellStyleProperty]rowHeaderStyleIResolvableRowHeaderStyleIResolvableRowHeaderStyleinterface{}#

The table cell style of the row headers.

rowsLabelOptionsIResolvable | CfnTemplate.PivotTableRowsLabelOptionsPropertyrows_label_optionstyping.Union[IResolvable, PivotTableRowsLabelOptionsProperty]rowsLabelOptionsIResolvableRowsLabelOptionsIResolvableRowsLabelOptionsinterface{}#

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

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

rowsLayoutstringrows_layoutstrrowsLayoutStringRowsLayoutstringRowsLayout*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.

singleMetricVisibilitystringsingle_metric_visibilitystrsingleMetricVisibilityStringSingleMetricVisibilitystringSingleMetricVisibility*string#

The visibility of the single metric options.

toggleButtonsVisibilitystringtoggle_buttons_visibilitystrtoggleButtonsVisibilityStringToggleButtonsVisibilitystringToggleButtonsVisibility*string#

Determines the visibility of the pivot table.