AWS CDK Reference

Appearance

v2.277.0

PivotTableFieldOptionsProperty Struct ​

The field options for a pivot table visual.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 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 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',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

pivot_table_field_options_property = quicksight.CfnAnalysis.PivotTableFieldOptionsProperty(
    collapse_state_options=[quicksight.CfnAnalysis.PivotTableFieldCollapseStateOptionProperty(
        target=quicksight.CfnAnalysis.PivotTableFieldCollapseStateTargetProperty(
            field_data_path_values=[quicksight.CfnAnalysis.DataPathValueProperty(
                data_path_type=quicksight.CfnAnalysis.DataPathTypeProperty(
                    pivot_table_data_path_type="pivotTableDataPathType"
                ),
                field_id="fieldId",
                field_value="fieldValue"
            )],
            field_id="fieldId"
        ),

        # the properties below are optional
        state="state"
    )],
    data_path_options=[quicksight.CfnAnalysis.PivotTableDataPathOptionProperty(
        data_path_list=[quicksight.CfnAnalysis.DataPathValueProperty(
            data_path_type=quicksight.CfnAnalysis.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )],

        # the properties below are optional
        width="width"
    )],
    selected_field_options=[quicksight.CfnAnalysis.PivotTableFieldOptionProperty(
        field_id="fieldId",

        # the properties below are optional
        custom_label="customLabel",
        visibility="visibility"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

PivotTableFieldOptionsProperty pivotTableFieldOptionsProperty = PivotTableFieldOptionsProperty.builder()
        .collapseStateOptions(List.of(PivotTableFieldCollapseStateOptionProperty.builder()
                .target(PivotTableFieldCollapseStateTargetProperty.builder()
                        .fieldDataPathValues(List.of(DataPathValueProperty.builder()
                                .dataPathType(DataPathTypeProperty.builder()
                                        .pivotTableDataPathType("pivotTableDataPathType")
                                        .build())
                                .fieldId("fieldId")
                                .fieldValue("fieldValue")
                                .build()))
                        .fieldId("fieldId")
                        .build())

                // the properties below are optional
                .state("state")
                .build()))
        .dataPathOptions(List.of(PivotTableDataPathOptionProperty.builder()
                .dataPathList(List.of(DataPathValueProperty.builder()
                        .dataPathType(DataPathTypeProperty.builder()
                                .pivotTableDataPathType("pivotTableDataPathType")
                                .build())
                        .fieldId("fieldId")
                        .fieldValue("fieldValue")
                        .build()))

                // the properties below are optional
                .width("width")
                .build()))
        .selectedFieldOptions(List.of(PivotTableFieldOptionProperty.builder()
                .fieldId("fieldId")

                // the properties below are optional
                .customLabel("customLabel")
                .visibility("visibility")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var pivotTableFieldOptionsProperty = new PivotTableFieldOptionsProperty {
    CollapseStateOptions = new [] { new PivotTableFieldCollapseStateOptionProperty {
        Target = new PivotTableFieldCollapseStateTargetProperty {
            FieldDataPathValues = new [] { new DataPathValueProperty {
                DataPathType = new DataPathTypeProperty {
                    PivotTableDataPathType = "pivotTableDataPathType"
                },
                FieldId = "fieldId",
                FieldValue = "fieldValue"
            } },
            FieldId = "fieldId"
        },

        // the properties below are optional
        State = "state"
    } },
    DataPathOptions = new [] { new PivotTableDataPathOptionProperty {
        DataPathList = new [] { new DataPathValueProperty {
            DataPathType = new DataPathTypeProperty {
                PivotTableDataPathType = "pivotTableDataPathType"
            },
            FieldId = "fieldId",
            FieldValue = "fieldValue"
        } },

        // the properties below are optional
        Width = "width"
    } },
    SelectedFieldOptions = new [] { new PivotTableFieldOptionProperty {
        FieldId = "fieldId",

        // the properties below are optional
        CustomLabel = "customLabel",
        Visibility = "visibility"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

pivotTableFieldOptionsProperty := &PivotTableFieldOptionsProperty{
	CollapseStateOptions: []interface{}{
		&PivotTableFieldCollapseStateOptionProperty{
			Target: &PivotTableFieldCollapseStateTargetProperty{
				FieldDataPathValues: []interface{}{
					&DataPathValueProperty{
						DataPathType: &DataPathTypeProperty{
							PivotTableDataPathType: jsii.String("pivotTableDataPathType"),
						},
						FieldId: jsii.String("fieldId"),
						FieldValue: jsii.String("fieldValue"),
					},
				},
				FieldId: jsii.String("fieldId"),
			},

			// the properties below are optional
			State: jsii.String("state"),
		},
	},
	DataPathOptions: []interface{}{
		&PivotTableDataPathOptionProperty{
			DataPathList: []interface{}{
				&DataPathValueProperty{
					DataPathType: &DataPathTypeProperty{
						PivotTableDataPathType: jsii.String("pivotTableDataPathType"),
					},
					FieldId: jsii.String("fieldId"),
					FieldValue: jsii.String("fieldValue"),
				},
			},

			// the properties below are optional
			Width: jsii.String("width"),
		},
	},
	SelectedFieldOptions: []interface{}{
		&PivotTableFieldOptionProperty{
			FieldId: jsii.String("fieldId"),

			// the properties below are optional
			CustomLabel: jsii.String("customLabel"),
			Visibility: jsii.String("visibility"),
		},
	},
}

Properties ​

collapseStateOptionsoptionalIResolvable | IResolvable | CfnAnalysis.PivotTableFieldCollapseStateOptionProperty[]collapse_state_optionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableFieldCollapseStateOptionProperty]]]collapseStateOptionsoptionalIResolvableCollapseStateOptionsoptionalIResolvableCollapseStateOptionsoptionalinterface{}#
The collapse state options for the pivot table field options.
dataPathOptionsoptionalIResolvable | IResolvable | CfnAnalysis.PivotTableDataPathOptionProperty[]data_path_optionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableDataPathOptionProperty]]]dataPathOptionsoptionalIResolvableDataPathOptionsoptionalIResolvableDataPathOptionsoptionalinterface{}#
The data path options for the pivot table field options.
selectedFieldOptionsoptionalIResolvable | IResolvable | CfnAnalysis.PivotTableFieldOptionProperty[]selected_field_optionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotTableFieldOptionProperty]]]selectedFieldOptionsoptionalIResolvableSelectedFieldOptionsoptionalIResolvableSelectedFieldOptionsoptionalinterface{}#
The selected field options for the pivot table field options.