aws-cdk-lib.aws_quicksight.CfnTemplate.BarChartSortConfigurationProperty

BarChartSortConfigurationProperty Struct

sort-configuration-description.

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 barChartSortConfigurationProperty: quicksight.CfnTemplate.BarChartSortConfigurationProperty = {
  categoryItemsLimit: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  categorySort: [{
    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',
    },
  }],
  colorItemsLimit: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  colorSort: [{
    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',
    },
  }],
  smallMultiplesLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  smallMultiplesSort: [{
    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

categoryItemsLimit?optionalIResolvable | CfnTemplate.ItemsLimitConfigurationPropertycategory_items_limit?optionaltyping.Union[IResolvable, ItemsLimitConfigurationProperty]categoryItemsLimit?optionalIResolvableCategoryItemsLimit?optionalIResolvableCategoryItemsLimit?optionalinterface{}#

The limit on the number of categories displayed in a bar chart.

categorySort?optionalIResolvable | IResolvable | CfnTemplate.FieldSortOptionsProperty[]category_sort?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]categorySort?optionalIResolvableCategorySort?optionalIResolvableCategorySort?optionalinterface{}#

The sort configuration of category fields.

colorItemsLimit?optionalIResolvable | CfnTemplate.ItemsLimitConfigurationPropertycolor_items_limit?optionaltyping.Union[IResolvable, ItemsLimitConfigurationProperty]colorItemsLimit?optionalIResolvableColorItemsLimit?optionalIResolvableColorItemsLimit?optionalinterface{}#

The limit on the number of values displayed in a bar chart.

colorSort?optionalIResolvable | IResolvable | CfnTemplate.FieldSortOptionsProperty[]color_sort?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]colorSort?optionalIResolvableColorSort?optionalIResolvableColorSort?optionalinterface{}#

The sort configuration of color fields in a bar chart.

smallMultiplesLimitConfiguration?optionalIResolvable | CfnTemplate.ItemsLimitConfigurationPropertysmall_multiples_limit_configuration?optionaltyping.Union[IResolvable, ItemsLimitConfigurationProperty]smallMultiplesLimitConfiguration?optionalIResolvableSmallMultiplesLimitConfiguration?optionalIResolvableSmallMultiplesLimitConfiguration?optionalinterface{}#

The limit on the number of small multiples panels that are displayed.

smallMultiplesSort?optionalIResolvable | IResolvable | CfnTemplate.FieldSortOptionsProperty[]small_multiples_sort?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSortOptionsProperty]]]smallMultiplesSort?optionalIResolvableSmallMultiplesSort?optionalIResolvableSmallMultiplesSort?optionalinterface{}#

The sort configuration of the small multiples field.