Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.WaterfallChartSortConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.WaterfallChartSortConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.WaterfallChartSortConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The sort configuration of a waterfall visual.

Example:

 // 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.*;
 WaterfallChartSortConfigurationProperty waterfallChartSortConfigurationProperty = WaterfallChartSortConfigurationProperty.builder()
         .breakdownItemsLimit(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .categorySort(List.of(FieldSortOptionsProperty.builder()
                 .columnSort(ColumnSortProperty.builder()
                         .direction("direction")
                         .sortBy(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.WaterfallChartSortConfigurationProperty.Builder	A builder for CfnTemplate.WaterfallChartSortConfigurationProperty
static final class	CfnTemplate.WaterfallChartSortConfigurationProperty.Jsii$Proxy	An implementation for CfnTemplate.WaterfallChartSortConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.WaterfallChartSortConfigurationProperty.Builder	builder()
default Object	getBreakdownItemsLimit()	The limit on the number of bar groups that are displayed.
default Object	getCategorySort()	The sort configuration of the category fields.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBreakdownItemsLimit

@Stability(Stable)
@Nullable
default Object getBreakdownItemsLimit()

The limit on the number of bar groups that are displayed.

Returns union: either IResolvable or CfnTemplate.ItemsLimitConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-breakdownitemslimit

getCategorySort

@Stability(Stable)
@Nullable
default Object getCategorySort()

The sort configuration of the category fields.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.FieldSortOptionsProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-categorysort

builder

@Stability(Stable)
static CfnTemplate.WaterfallChartSortConfigurationProperty.Builder builder()

Returns:

a CfnTemplate.WaterfallChartSortConfigurationProperty.Builder of CfnTemplate.WaterfallChartSortConfigurationProperty