AWS CDK Reference

Appearance

v2.273.0

SubtotalOptionsProperty Struct ​

The subtotal options.

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 subtotalOptionsProperty: quicksight.CfnAnalysis.SubtotalOptionsProperty = {
  customLabel: 'customLabel',
  fieldLevel: 'fieldLevel',
  fieldLevelOptions: [{
    fieldId: 'fieldId',
  }],
  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',
  },
  styleTargets: [{
    cellType: 'cellType',
  }],
  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 ​

customLabelstringcustom_labelstrcustomLabelStringCustomLabelstringCustomLabel*string#
The custom label string for the subtotal cells.
fieldLevelstringfield_levelstrfieldLevelStringFieldLevelstringFieldLevel*string#
The field level (all, custom, last) for the subtotal cells.
fieldLevelOptionsIResolvable | IResolvable | CfnAnalysis.PivotTableFieldSubtotalOptionsProperty[]field_level_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableFieldSubtotalOptionsProperty]]]fieldLevelOptionsIResolvableFieldLevelOptionsIResolvableFieldLevelOptionsinterface{}#
The optional configuration of subtotal cells.
metricHeaderCellStyleIResolvable | CfnAnalysis.TableCellStylePropertymetric_header_cell_styletyping.Union[IResolvable, TableCellStyleProperty]metricHeaderCellStyleIResolvableMetricHeaderCellStyleIResolvableMetricHeaderCellStyleinterface{}#
The cell styling options for the subtotals of header cells.
styleTargetsIResolvable | IResolvable | CfnAnalysis.TableStyleTargetProperty[]style_targetstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TableStyleTargetProperty]]]styleTargetsIResolvableStyleTargetsIResolvableStyleTargetsinterface{}#
The style targets options for subtotals.
totalCellStyleIResolvable | CfnAnalysis.TableCellStylePropertytotal_cell_styletyping.Union[IResolvable, TableCellStyleProperty]totalCellStyleIResolvableTotalCellStyleIResolvableTotalCellStyleinterface{}#
The cell styling options for the subtotal cells.
totalsVisibilitystringtotals_visibilitystrtotalsVisibilityStringTotalsVisibilitystringTotalsVisibility*string#
The visibility configuration for the subtotal cells.
valueCellStyleIResolvable | CfnAnalysis.TableCellStylePropertyvalue_cell_styletyping.Union[IResolvable, TableCellStyleProperty]valueCellStyleIResolvableValueCellStyleIResolvableValueCellStyleinterface{}#
The cell styling options for the subtotals of value cells.