1.204.0

interface PieChartSortConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.PieChartSortConfigurationProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.PieChartSortConfigurationProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.PieChartSortConfigurationProperty
TypeScript @aws-cdk/aws-quicksight » CfnTemplate » PieChartSortConfigurationProperty

The sort configuration of a pie chart.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const pieChartSortConfigurationProperty: quicksight.CfnTemplate.PieChartSortConfigurationProperty = {
  categoryItemsLimit: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  categorySort: [{
    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',
    },
  }],
  smallMultiplesLimitConfiguration: {
    itemsLimit: 123,
    otherCategories: 'otherCategories',
  },
  smallMultiplesSort: [{
    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
categoryItemsLimit?IResolvable | ItemsLimitConfigurationPropertyThe limit on the number of categories that are displayed in a pie chart.
categorySort?IResolvable | IResolvable | FieldSortOptionsProperty[]The sort configuration of the category fields.
smallMultiplesLimitConfiguration?IResolvable | ItemsLimitConfigurationPropertyThe limit on the number of small multiples panels that are displayed.
smallMultiplesSort?IResolvable | IResolvable | FieldSortOptionsProperty[]The sort configuration of the small multiples field.

categoryItemsLimit?

Type: IResolvable | ItemsLimitConfigurationProperty (optional)

The limit on the number of categories that are displayed in a pie chart.

categorySort?

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

The sort configuration of the category fields.

smallMultiplesLimitConfiguration?

Type: IResolvable | ItemsLimitConfigurationProperty (optional)

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

smallMultiplesSort?

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

The sort configuration of the small multiples field.

← PreviousNext →