aws-cdk-lib.aws_quicksight.CfnTemplate.HeatMapSortConfigurationProperty

interface HeatMapSortConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.HeatMapSortConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_HeatMapSortConfigurationProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.HeatMapSortConfigurationProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.HeatMapSortConfigurationProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » HeatMapSortConfigurationProperty

The sort configuration of a heat map.

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 heatMapSortConfigurationProperty: quicksight.CfnTemplate.HeatMapSortConfigurationProperty = {
  heatMapColumnItemsLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  heatMapColumnSort: [{
    columnSort: {
      direction: 'direction',
      sortBy: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },

      // the properties below are optional
      aggregationFunction: {
        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',
        dataSetIdentifier: 'dataSetIdentifier',
      },

      // the properties below are optional
      aggregationFunction: {
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
    },
    fieldSort: {
      direction: 'direction',
      fieldId: 'fieldId',
    },
  }],
};

Properties

NameTypeDescription
heatMapColumnItemsLimitConfiguration?IResolvable | ItemsLimitConfigurationPropertyThe limit on the number of columns that are displayed in a heat map.
heatMapColumnSort?IResolvable | IResolvable | FieldSortOptionsProperty[]The column sort configuration for heat map for columns that aren't a part of a field well.
heatMapRowItemsLimitConfiguration?IResolvable | ItemsLimitConfigurationPropertyThe limit on the number of rows that are displayed in a heat map.
heatMapRowSort?IResolvable | IResolvable | FieldSortOptionsProperty[]The field sort configuration of the rows fields.

heatMapColumnItemsLimitConfiguration?

Type: IResolvable | ItemsLimitConfigurationProperty (optional)

The limit on the number of columns that are displayed in a heat map.


heatMapColumnSort?

Type: IResolvable | IResolvable | FieldSortOptionsProperty[] (optional)

The column sort configuration for heat map for columns that aren't a part of a field well.


heatMapRowItemsLimitConfiguration?

Type: IResolvable | ItemsLimitConfigurationProperty (optional)

The limit on the number of rows that are displayed in a heat map.


heatMapRowSort?

Type: IResolvable | IResolvable | FieldSortOptionsProperty[] (optional)

The field sort configuration of the rows fields.