aws-cdk-lib.aws_quicksight.CfnTemplate.PivotFieldSortOptionsProperty

interface PivotFieldSortOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.PivotFieldSortOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_PivotFieldSortOptionsProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.PivotFieldSortOptionsProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.PivotFieldSortOptionsProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const pivotFieldSortOptionsProperty: quicksight.CfnTemplate.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

NameTypeDescription
fieldIdstringThe field ID for the field sort options.
sortByIResolvable | PivotTableSortByPropertyThe 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.