interface PivotFieldSortOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.PivotFieldSortOptionsProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.PivotFieldSortOptionsProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.PivotFieldSortOptionsProperty
TypeScript	@aws-cdk/aws-quicksight » CfnAnalysis » PivotFieldSortOptionsProperty

The field sort options for a pivot table sort configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const pivotFieldSortOptionsProperty: quicksight.CfnAnalysis.PivotFieldSortOptionsProperty = {
  fieldId: 'fieldId',
  sortBy: {
    column: {
      direction: 'direction',
      sortBy: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },

      // the properties below are optional
      aggregationFunction: {
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
    },
    dataPath: {
      direction: 'direction',
      sortPaths: [{
        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

The field ID for the field sort options.

---

sortBy

Type: IResolvable | PivotTableSortByProperty

The sort by field for the field sort options.