Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.PivotTableFieldOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.PivotTableFieldOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.PivotTableFieldOptionsProperty
extends software.amazon.jsii.JsiiSerializable

The field options for a pivot table visual.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.PivotTableFieldOptionsProperty.Builder	A builder for CfnDashboard.PivotTableFieldOptionsProperty
static final class	CfnDashboard.PivotTableFieldOptionsProperty.Jsii$Proxy	An implementation for CfnDashboard.PivotTableFieldOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.PivotTableFieldOptionsProperty.Builder	builder()
default Object	getCollapseStateOptions()	The collapse state options for the pivot table field options.
default Object	getDataPathOptions()	The data path options for the pivot table field options.
default Object	getSelectedFieldOptions()	The selected field options for the pivot table field options.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollapseStateOptions

@Stability(Stable)
@Nullable
default Object getCollapseStateOptions()

The collapse state options for the pivot table field options.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.PivotTableFieldCollapseStateOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-collapsestateoptions

getDataPathOptions

@Stability(Stable)
@Nullable
default Object getDataPathOptions()

The data path options for the pivot table field options.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.PivotTableDataPathOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-datapathoptions

getSelectedFieldOptions

@Stability(Stable)
@Nullable
default Object getSelectedFieldOptions()

The selected field options for the pivot table field options.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.PivotTableFieldOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-selectedfieldoptions

builder

@Stability(Stable)
static CfnDashboard.PivotTableFieldOptionsProperty.Builder builder()

Returns:

a CfnDashboard.PivotTableFieldOptionsProperty.Builder of CfnDashboard.PivotTableFieldOptionsProperty