aws-cdk-lib.aws_quicksight.CfnTemplate.TreeMapSortConfigurationProperty

TreeMapSortConfigurationProperty Struct

The sort configuration of a tree 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 treeMapSortConfigurationProperty: quicksight.CfnTemplate.TreeMapSortConfigurationProperty = {
  treeMapGroupItemsLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  treeMapSort: [{
    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

treeMapGroupItemsLimitConfigurationIResolvable | CfnTemplate.ItemsLimitConfigurationPropertytree_map_group_items_limit_configurationtyping.Union[IResolvable, ItemsLimitConfigurationProperty]treeMapGroupItemsLimitConfigurationIResolvableTreeMapGroupItemsLimitConfigurationIResolvableTreeMapGroupItemsLimitConfigurationinterface{}#

The limit on the number of groups that are displayed.

treeMapSortIResolvable | IResolvable | CfnTemplate.FieldSortOptionsProperty[]tree_map_sorttyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]treeMapSortIResolvableTreeMapSortIResolvableTreeMapSortinterface{}#

The sort configuration of group by fields.