Skip to content
v2.273.0

PivotTableFieldOptionsProperty Struct ​

The field options for a pivot table visual.

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 pivotTableFieldOptionsProperty: quicksight.CfnAnalysis.PivotTableFieldOptionsProperty = {
  collapseStateOptions: [{
    target: {
      fieldDataPathValues: [{
        dataPathType: {
          pivotTableDataPathType: 'pivotTableDataPathType',
        },
        fieldId: 'fieldId',
        fieldValue: 'fieldValue',
      }],
      fieldId: 'fieldId',
    },

    // the properties below are optional
    state: 'state',
  }],
  dataPathOptions: [{
    dataPathList: [{
      dataPathType: {
        pivotTableDataPathType: 'pivotTableDataPathType',
      },
      fieldId: 'fieldId',
      fieldValue: 'fieldValue',
    }],

    // the properties below are optional
    width: 'width',
  }],
  selectedFieldOptions: [{
    fieldId: 'fieldId',

    // the properties below are optional
    customLabel: 'customLabel',
    visibility: 'visibility',
  }],
};

Properties ​

collapseStateOptionsIResolvable | IResolvable | CfnAnalysis.PivotTableFieldCollapseStateOptionProperty[]collapse_state_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableFieldCollapseStateOptionProperty]]]collapseStateOptionsIResolvableCollapseStateOptionsIResolvableCollapseStateOptionsinterface{}#
The collapse state options for the pivot table field options.
dataPathOptionsIResolvable | IResolvable | CfnAnalysis.PivotTableDataPathOptionProperty[]data_path_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableDataPathOptionProperty]]]dataPathOptionsIResolvableDataPathOptionsIResolvableDataPathOptionsinterface{}#
The data path options for the pivot table field options.
selectedFieldOptionsIResolvable | IResolvable | CfnAnalysis.PivotTableFieldOptionProperty[]selected_field_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableFieldOptionProperty]]]selectedFieldOptionsIResolvableSelectedFieldOptionsIResolvableSelectedFieldOptionsinterface{}#
The selected field options for the pivot table field options.