interface PivotFieldSortOptionsProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnAnalysisPropsMixin.PivotFieldSortOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnAnalysisPropsMixin_PivotFieldSortOptionsProperty
Java	software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnAnalysisPropsMixin.PivotFieldSortOptionsProperty
Python	aws_cdk.mixins_preview.aws_quicksight.mixins.CfnAnalysisPropsMixin.PivotFieldSortOptionsProperty
TypeScript	@aws-cdk/mixins-preview » aws_quicksight » mixins » CfnAnalysisPropsMixin » PivotFieldSortOptionsProperty

The field sort options for a pivot table sort configuration.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const pivotFieldSortOptionsProperty: quicksight_mixins.CfnAnalysisPropsMixin.PivotFieldSortOptionsProperty = {
  fieldId: 'fieldId',
  sortBy: {
    column: {
      aggregationFunction: {
        attributeAggregationFunction: {
          simpleAttributeAggregation: 'simpleAttributeAggregation',
          valueForMultipleValues: 'valueForMultipleValues',
        },
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
      direction: 'direction',
      sortBy: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
    },
    dataPath: {
      direction: 'direction',
      sortPaths: [{
        dataPathType: {
          pivotTableDataPathType: 'pivotTableDataPathType',
        },
        fieldId: 'fieldId',
        fieldValue: 'fieldValue',
      }],
    },
    field: {
      direction: 'direction',
      fieldId: 'fieldId',
    },
  },
};

Properties

Name	Type	Description
fieldId?	string	The field ID for the field sort options.
sortBy?	IResolvable | PivotTableSortByProperty	The sort by field for the field sort options.

---

fieldId?

Type: string (optional)

The field ID for the field sort options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivotfieldsortoptions.html#cfn-quicksight-analysis-pivotfieldsortoptions-fieldid

---

sortBy?

Type: IResolvable | PivotTableSortByProperty (optional)

The sort by field for the field sort options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivotfieldsortoptions.html#cfn-quicksight-analysis-pivotfieldsortoptions-sortby