interface ColumnSortProperty

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

The sort configuration for a column that is not used in a field well.

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 columnSortProperty: quicksight.CfnDashboard.ColumnSortProperty = {
  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',
    },
  },
};

Properties

Name	Type	Description
direction	`string`	The sort direction.
sortBy	`IResolvable` `\|` `ColumnIdentifierProperty`
aggregationFunction?	`IResolvable` `\|` `AggregationFunctionProperty`	The aggregation function that is defined in the column sort.

direction

Type: string

The sort direction.

sortBy

Type: IResolvable | ColumnIdentifierProperty

aggregationFunction?

Type: IResolvable | AggregationFunctionProperty (optional)

The aggregation function that is defined in the column sort.