aws-cdk-lib.aws_quicksight.CfnAnalysis.PivotTotalOptionsProperty

PivotTotalOptionsProperty Struct

The optional configuration of totals cells in a PivotTableVisual .

Source

Generated code

Type last changed

v2.103.0 · 26 Oct 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 pivotTotalOptionsProperty: quicksight.CfnAnalysis.PivotTotalOptionsProperty = {
  customLabel: 'customLabel',
  metricHeaderCellStyle: {
    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',
  },
  placement: 'placement',
  scrollStatus: 'scrollStatus',
  totalAggregationOptions: [{
    fieldId: 'fieldId',
    totalAggregationFunction: {
      simpleTotalAggregationFunction: 'simpleTotalAggregationFunction',
    },
  }],
  totalCellStyle: {
    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',
  },
  totalsVisibility: 'totalsVisibility',
  valueCellStyle: {
    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',
  },
};

Properties

customLabel?optionalstringcustom_label?optionalstrcustomLabel?optionalStringCustomLabel?optionalstringCustomLabel?optional*string#

The custom label string for the total cells.

metricHeaderCellStyle?optionalIResolvable | CfnAnalysis.TableCellStylePropertymetric_header_cell_style?optionaltyping.Union[IResolvable, TableCellStyleProperty]metricHeaderCellStyle?optionalIResolvableMetricHeaderCellStyle?optionalIResolvableMetricHeaderCellStyle?optionalinterface{}#

The cell styling options for the total of header cells.

placement?optionalstringplacement?optionalstrplacement?optionalStringPlacement?optionalstringPlacement?optional*string#

The placement (start, end) for the total cells.

scrollStatus?optionalstringscroll_status?optionalstrscrollStatus?optionalStringScrollStatus?optionalstringScrollStatus?optional*string#

The scroll status (pinned, scrolled) for the total cells.

totalAggregationOptions?optionalIResolvable | IResolvable | CfnAnalysis.TotalAggregationOptionProperty[]total_aggregation_options?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TotalAggregationOptionProperty]]]totalAggregationOptions?optionalIResolvableTotalAggregationOptions?optionalIResolvableTotalAggregationOptions?optionalinterface{}#

The total aggregation options for each value field.

totalCellStyle?optionalIResolvable | CfnAnalysis.TableCellStylePropertytotal_cell_style?optionaltyping.Union[IResolvable, TableCellStyleProperty]totalCellStyle?optionalIResolvableTotalCellStyle?optionalIResolvableTotalCellStyle?optionalinterface{}#

The cell styling options for the total cells.

totalsVisibility?optionalstringtotals_visibility?optionalstrtotalsVisibility?optionalStringTotalsVisibility?optionalstringTotalsVisibility?optional*string#

The visibility configuration for the total cells.

valueCellStyle?optionalIResolvable | CfnAnalysis.TableCellStylePropertyvalue_cell_style?optionaltyping.Union[IResolvable, TableCellStyleProperty]valueCellStyle?optionalIResolvableValueCellStyle?optionalIResolvableValueCellStyle?optionalinterface{}#

The cell styling options for the totals of value cells.