Skip to content
v2.275.0

PivotTableSortByProperty Struct ​

The sort by field for the field sort options.

Example ​

ts
// 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',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },

    // 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 ​

columnoptionalIResolvable | CfnDashboard.ColumnSortPropertycolumnoptionaltyping.Union[IResolvable, ColumnSortProperty]columnoptionalIResolvableColumnoptionalIResolvableColumnoptionalinterface{}#
The column sort (field id, direction) for the pivot table sort by options.
dataPathoptionalIResolvable | CfnDashboard.DataPathSortPropertydata_pathoptionaltyping.Union[IResolvable, DataPathSortProperty]dataPathoptionalIResolvableDataPathoptionalIResolvableDataPathoptionalinterface{}#
The data path sort (data path value, direction) for the pivot table sort by options.
fieldoptionalIResolvable | CfnDashboard.FieldSortPropertyfieldoptionaltyping.Union[IResolvable, FieldSortProperty]fieldoptionalIResolvableFieldoptionalIResolvableFieldoptionalinterface{}#
The field sort (field id, direction) for the pivot table sort by options.