Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.HeatMapSortConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.HeatMapSortConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

The sort configuration of a heat 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.*;
 HeatMapSortConfigurationProperty heatMapSortConfigurationProperty = HeatMapSortConfigurationProperty.builder()
         .heatMapColumnItemsLimitConfiguration(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .heatMapColumnSort(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()
                                 .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()))
         .heatMapRowItemsLimitConfiguration(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .heatMapRowSort(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()
                                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.HeatMapSortConfigurationProperty.Builder	builder()
default Object	getHeatMapColumnItemsLimitConfiguration()	The limit on the number of columns that are displayed in a heat map.
default Object	getHeatMapColumnSort()	The column sort configuration for heat map for columns that aren't a part of a field well.
default Object	getHeatMapRowItemsLimitConfiguration()	The limit on the number of rows that are displayed in a heat map.
default Object	getHeatMapRowSort()	The field sort configuration of the rows fields.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeatMapColumnItemsLimitConfiguration

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

The limit on the number of columns that are displayed in a heat map.

getHeatMapColumnSort

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

The column sort configuration for heat map for columns that aren't a part of a field well.

getHeatMapRowItemsLimitConfiguration

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

The limit on the number of rows that are displayed in a heat map.

getHeatMapRowSort

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

The field sort configuration of the rows fields.

builder

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

Returns:

a CfnTemplate.HeatMapSortConfigurationProperty.Builder of CfnTemplate.HeatMapSortConfigurationProperty