Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.BarChartSortConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.BarChartSortConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

sort-configuration-description.

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.*;
 BarChartSortConfigurationProperty barChartSortConfigurationProperty = BarChartSortConfigurationProperty.builder()
         .categoryItemsLimit(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()))
         .colorItemsLimit(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .colorSort(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()))
         .smallMultiplesLimitConfiguration(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .build())
         .smallMultiplesSort(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-barchartsortconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.BarChartSortConfigurationProperty.Builder	builder()
default Object	getCategoryItemsLimit()	The limit on the number of categories displayed in a bar chart.
default Object	getCategorySort()	The sort configuration of category fields.
default Object	getColorItemsLimit()	The limit on the number of values displayed in a bar chart.
default Object	getColorSort()	The sort configuration of color fields in a bar chart.
default Object	getSmallMultiplesLimitConfiguration()	The limit on the number of small multiples panels that are displayed.
default Object	getSmallMultiplesSort()	The sort configuration of the small multiples field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategoryItemsLimit

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

The limit on the number of categories displayed in a bar chart.

Returns union: either IResolvable or CfnDashboard.ItemsLimitConfigurationProperty

See Also:

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

getCategorySort

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

The sort configuration of category fields.

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

See Also:

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

getColorItemsLimit

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

The limit on the number of values displayed in a bar chart.

Returns union: either IResolvable or CfnDashboard.ItemsLimitConfigurationProperty

See Also:

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

getColorSort

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

The sort configuration of color fields in a bar chart.

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

See Also:

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

getSmallMultiplesLimitConfiguration

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

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

Returns union: either IResolvable or CfnDashboard.ItemsLimitConfigurationProperty

See Also:

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

getSmallMultiplesSort

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

The sort configuration of the small multiples field.

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

See Also:

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

builder

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

Returns:

a CfnDashboard.BarChartSortConfigurationProperty.Builder of CfnDashboard.BarChartSortConfigurationProperty