aws-cdk-lib.aws_quicksight.CfnAnalysis.PivotTableSortByProperty

interface PivotTableSortByProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.PivotTableSortByProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_PivotTableSortByProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.PivotTableSortByProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.PivotTableSortByProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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.CfnAnalysis.PivotTableSortByProperty = {
  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
column?IResolvable | ColumnSortPropertyThe column sort (field id, direction) for the pivot table sort by options.
dataPath?IResolvable | DataPathSortPropertyThe data path sort (data path value, direction) for the pivot table sort by options.
field?IResolvable | FieldSortPropertyThe 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.