interface PivotTableFieldOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.PivotTableFieldOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_PivotTableFieldOptionsProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.PivotTableFieldOptionsProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.PivotTableFieldOptionsProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnTemplate » PivotTableFieldOptionsProperty

The field options for a pivot table visual.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html

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 pivotTableFieldOptionsProperty: quicksight.CfnTemplate.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

Name	Type	Description
collapseStateOptions?	IResolvable | (IResolvable | PivotTableFieldCollapseStateOptionProperty)[]	The collapse state options for the pivot table field options.
dataPathOptions?	IResolvable | (IResolvable | PivotTableDataPathOptionProperty)[]	The data path options for the pivot table field options.
selectedFieldOptions?	IResolvable | (IResolvable | PivotTableFieldOptionProperty)[]	The selected field options for the pivot table field options.

---

collapseStateOptions?

Type: IResolvable | (IResolvable | PivotTableFieldCollapseStateOptionProperty)[] (optional)

The collapse state options for the pivot table field options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-collapsestateoptions

---

dataPathOptions?

Type: IResolvable | (IResolvable | PivotTableDataPathOptionProperty)[] (optional)

The data path options for the pivot table field options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-datapathoptions

---

selectedFieldOptions?

Type: IResolvable | (IResolvable | PivotTableFieldOptionProperty)[] (optional)

The selected field options for the pivot table field options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-selectedfieldoptions