interface PivotTableSortByProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.PivotTableSortByProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_PivotTableSortByProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.PivotTableSortByProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.PivotTableSortByProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `PivotTableSortByProperty`

The sort by field for the field sort options.

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 pivotTableSortByProperty: quicksight.CfnDashboard.PivotTableSortByProperty = {
  column: {
    direction: 'direction',
    sortBy: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },

    // the properties below are optional
    aggregationFunction: {
      attributeAggregationFunction: {
        simpleAttributeAggregation: 'simpleAttributeAggregation',
        valueForMultipleValues: 'valueForMultipleValues',
      },
      categoricalAggregationFunction: 'categoricalAggregationFunction',
      dateAggregationFunction: 'dateAggregationFunction',
      numericalAggregationFunction: {
        percentileAggregation: {
          percentileValue: 123,
        },
        simpleNumericalAggregation: 'simpleNumericalAggregation',
      },
    },
  },
  dataPath: {
    direction: 'direction',
    sortPaths: [{
      dataPathType: {
        pivotTableDataPathType: 'pivotTableDataPathType',
      },
      fieldId: 'fieldId',
      fieldValue: 'fieldValue',
    }],
  },
  field: {
    direction: 'direction',
    fieldId: 'fieldId',
  },
};

Properties

Name	Type	Description
column?	`IResolvable` `\|` `ColumnSortProperty`	The column sort (field id, direction) for the pivot table sort by options.
dataPath?	`IResolvable` `\|` `DataPathSortProperty`	The data path sort (data path value, direction) for the pivot table sort by options.
field?	`IResolvable` `\|` `FieldSortProperty`	The field sort (field id, direction) for the pivot table sort by options.

column?

Type: IResolvable | ColumnSortProperty (optional)

The column sort (field id, direction) for the pivot table sort by options.

dataPath?

Type: IResolvable | DataPathSortProperty (optional)

The data path sort (data path value, direction) for the pivot table sort by options.

field?

Type: IResolvable | FieldSortProperty (optional)

The field sort (field id, direction) for the pivot table sort by options.