Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TreeMapSortConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TreeMapSortConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.TreeMapSortConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The sort configuration of a tree map.

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.*;
 TreeMapSortConfigurationProperty treeMapSortConfigurationProperty = TreeMapSortConfigurationProperty.builder()
         .treeMapGroupItemsLimitConfiguration(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .treeMapSort(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-dashboard-treemapsortconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TreeMapSortConfigurationProperty.Builder	builder()
default Object	getTreeMapGroupItemsLimitConfiguration()	The limit on the number of groups that are displayed.
default Object	getTreeMapSort()	The sort configuration of group by fields.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTreeMapGroupItemsLimitConfiguration

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

The limit on the number of groups that are displayed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapgroupitemslimitconfiguration

getTreeMapSort

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

The sort configuration of group by fields.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapsort

builder

@Stability(Stable)
static CfnDashboard.TreeMapSortConfigurationProperty.Builder builder()

Returns:

a CfnDashboard.TreeMapSortConfigurationProperty.Builder of CfnDashboard.TreeMapSortConfigurationProperty