aws-cdk-lib.aws_quicksight.CfnAnalysis.FunnelChartSortConfigurationProperty

FunnelChartSortConfigurationProperty Struct

The sort configuration of a FunnelChartVisual .

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 funnelChartSortConfigurationProperty: quicksight.CfnAnalysis.FunnelChartSortConfigurationProperty = {
  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',
    },
  }],
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

funnel_chart_sort_configuration_property = quicksight.CfnAnalysis.FunnelChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnAnalysis.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnAnalysis.FieldSortOptionsProperty(
        column_sort=quicksight.CfnAnalysis.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnAnalysis.ColumnIdentifierProperty(
                column_name="columnName",

                # the properties below are optional
                data_set_identifier="dataSetIdentifier",
                topic_identifier="topicIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnAnalysis.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnAnalysis.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnAnalysis.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnAnalysis.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnAnalysis.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

FunnelChartSortConfigurationProperty funnelChartSortConfigurationProperty = FunnelChartSortConfigurationProperty.builder()
        .categoryItemsLimit(ItemsLimitConfigurationProperty.builder()
                .itemsLimit(123)
                .otherCategories("otherCategories")
                .build())
        .categorySort(List.of(FieldSortOptionsProperty.builder()
                .columnSort(ColumnSortProperty.builder()
                        .direction("direction")
                        .sortBy(ColumnIdentifierProperty.builder()
                                .columnName("columnName")

                                // the properties below are optional
                                .dataSetIdentifier("dataSetIdentifier")
                                .topicIdentifier("topicIdentifier")
                                .build())

                        // the properties below are optional
                        .aggregationFunction(AggregationFunctionProperty.builder()
                                .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                        .simpleAttributeAggregation("simpleAttributeAggregation")
                                        .valueForMultipleValues("valueForMultipleValues")
                                        .build())
                                .categoricalAggregationFunction("categoricalAggregationFunction")
                                .dateAggregationFunction("dateAggregationFunction")
                                .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                        .percentileAggregation(PercentileAggregationProperty.builder()
                                                .percentileValue(123)
                                                .build())
                                        .simpleNumericalAggregation("simpleNumericalAggregation")
                                        .build())
                                .build())
                        .build())
                .fieldSort(FieldSortProperty.builder()
                        .direction("direction")
                        .fieldId("fieldId")
                        .build())
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var funnelChartSortConfigurationProperty = new FunnelChartSortConfigurationProperty {
    CategoryItemsLimit = new ItemsLimitConfigurationProperty {
        ItemsLimit = 123,
        OtherCategories = "otherCategories"
    },
    CategorySort = new [] { new FieldSortOptionsProperty {
        ColumnSort = new ColumnSortProperty {
            Direction = "direction",
            SortBy = new ColumnIdentifierProperty {
                ColumnName = "columnName",

                // the properties below are optional
                DataSetIdentifier = "dataSetIdentifier",
                TopicIdentifier = "topicIdentifier"
            },

            // the properties below are optional
            AggregationFunction = new AggregationFunctionProperty {
                AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                    SimpleAttributeAggregation = "simpleAttributeAggregation",
                    ValueForMultipleValues = "valueForMultipleValues"
                },
                CategoricalAggregationFunction = "categoricalAggregationFunction",
                DateAggregationFunction = "dateAggregationFunction",
                NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                    PercentileAggregation = new PercentileAggregationProperty {
                        PercentileValue = 123
                    },
                    SimpleNumericalAggregation = "simpleNumericalAggregation"
                }
            }
        },
        FieldSort = new FieldSortProperty {
            Direction = "direction",
            FieldId = "fieldId"
        }
    } }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

funnelChartSortConfigurationProperty := &FunnelChartSortConfigurationProperty{
	CategoryItemsLimit: &ItemsLimitConfigurationProperty{
		ItemsLimit: jsii.Number(123),
		OtherCategories: jsii.String("otherCategories"),
	},
	CategorySort: []interface{}{
		&FieldSortOptionsProperty{
			ColumnSort: &ColumnSortProperty{
				Direction: jsii.String("direction"),
				SortBy: &ColumnIdentifierProperty{
					ColumnName: jsii.String("columnName"),

					// the properties below are optional
					DataSetIdentifier: jsii.String("dataSetIdentifier"),
					TopicIdentifier: jsii.String("topicIdentifier"),
				},

				// the properties below are optional
				AggregationFunction: &AggregationFunctionProperty{
					AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
						SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
						ValueForMultipleValues: jsii.String("valueForMultipleValues"),
					},
					CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
					DateAggregationFunction: jsii.String("dateAggregationFunction"),
					NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
						PercentileAggregation: &PercentileAggregationProperty{
							PercentileValue: jsii.Number(123),
						},
						SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
					},
				},
			},
			FieldSort: &FieldSortProperty{
				Direction: jsii.String("direction"),
				FieldId: jsii.String("fieldId"),
			},
		},
	},
}

Properties

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

The limit on the number of categories displayed.

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

The sort configuration of the category fields.