aws-cdk-lib.aws_quicksight.CfnAnalysis.HeatMapSortConfigurationProperty

HeatMapSortConfigurationProperty Struct

The sort configuration of a heat map.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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.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

heatMapColumnItemsLimitConfigurationIResolvable | CfnAnalysis.ItemsLimitConfigurationPropertyheat_map_column_items_limit_configurationtyping.Union[IResolvable, ItemsLimitConfigurationProperty]heatMapColumnItemsLimitConfigurationIResolvableHeatMapColumnItemsLimitConfigurationIResolvableHeatMapColumnItemsLimitConfigurationinterface{}#

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

heatMapColumnSortIResolvable | IResolvable | CfnAnalysis.FieldSortOptionsProperty[]heat_map_column_sorttyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]heatMapColumnSortIResolvableHeatMapColumnSortIResolvableHeatMapColumnSortinterface{}#

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

heatMapRowItemsLimitConfigurationIResolvable | CfnAnalysis.ItemsLimitConfigurationPropertyheat_map_row_items_limit_configurationtyping.Union[IResolvable, ItemsLimitConfigurationProperty]heatMapRowItemsLimitConfigurationIResolvableHeatMapRowItemsLimitConfigurationIResolvableHeatMapRowItemsLimitConfigurationinterface{}#

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

heatMapRowSortIResolvable | IResolvable | CfnAnalysis.FieldSortOptionsProperty[]heat_map_row_sorttyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]heatMapRowSortIResolvableHeatMapRowSortIResolvableHeatMapRowSortinterface{}#

The field sort configuration of the rows fields.