# HeatMapSortConfigurationProperty

The sort configuration of a heat map.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## 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 heatMapSortConfigurationProperty: quicksight.CfnAnalysis.HeatMapSortConfigurationProperty = {
  heatMapColumnItemsLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  heatMapColumnSort: [{
    columnSort: {
      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',
        },
      },
    },
    fieldSort: {
      direction: 'direction',
      fieldId: 'fieldId',
    },
  }],
  heatMapRowItemsLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  heatMapRowSort: [{
    columnSort: {
      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',
        },
      },
    },
    fieldSort: {
      direction: 'direction',
      fieldId: 'fieldId',
    },
  }],
};
```

## Properties

- `heatMapColumnItemsLimitConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.ItemsLimitConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.ItemsLimitConfigurationProperty.html) — The limit on the number of columns that are displayed in a heat map.

- `heatMapColumnSort`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.FieldSortOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.FieldSortOptionsProperty.html)[] — The column sort configuration for heat map for columns that aren't a part of a field well.

- `heatMapRowItemsLimitConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.ItemsLimitConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.ItemsLimitConfigurationProperty.html) — The limit on the number of rows that are displayed in a heat map.

- `heatMapRowSort`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.FieldSortOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.FieldSortOptionsProperty.html)[] — The field sort configuration of the rows fields.