aws-cdk-lib.aws_quicksight.CfnDashboard.SankeyDiagramSortConfigurationProperty

SankeyDiagramSortConfigurationProperty Struct

The sort configuration of a sankey diagram.

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 sankeyDiagramSortConfigurationProperty: quicksight.CfnDashboard.SankeyDiagramSortConfigurationProperty = {
  destinationItemsLimit: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  sourceItemsLimit: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  weightSort: [{
    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

destinationItemsLimit?optionalIResolvable | CfnDashboard.ItemsLimitConfigurationPropertydestination_items_limit?optionaltyping.Union[IResolvable, ItemsLimitConfigurationProperty]destinationItemsLimit?optionalIResolvableDestinationItemsLimit?optionalIResolvableDestinationItemsLimit?optionalinterface{}#

The limit on the number of destination nodes that are displayed in a sankey diagram.

sourceItemsLimit?optionalIResolvable | CfnDashboard.ItemsLimitConfigurationPropertysource_items_limit?optionaltyping.Union[IResolvable, ItemsLimitConfigurationProperty]sourceItemsLimit?optionalIResolvableSourceItemsLimit?optionalIResolvableSourceItemsLimit?optionalinterface{}#

The limit on the number of source nodes that are displayed in a sankey diagram.

weightSort?optionalIResolvable | IResolvable | CfnDashboard.FieldSortOptionsProperty[]weight_sort?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]weightSort?optionalIResolvableWeightSort?optionalIResolvableWeightSort?optionalinterface{}#

The sort configuration of the weight fields.