Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.LineChartSortConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.LineChartSortConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

The sort configuration of a line chart.

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.*;
 LineChartSortConfigurationProperty lineChartSortConfigurationProperty = LineChartSortConfigurationProperty.builder()
         .categoryItemsLimitConfiguration(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()))
         .colorItemsLimitConfiguration(ItemsLimitConfigurationProperty.builder()
                 .itemsLimit(123)
                 .otherCategories("otherCategories")
                 .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-linechartsortconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.LineChartSortConfigurationProperty.Builder	builder()
default Object	getCategoryItemsLimitConfiguration()	The limit on the number of categories that are displayed in a line chart.
default Object	getCategorySort()	The sort configuration of the category fields.
default Object	getColorItemsLimitConfiguration()	The limit on the number of lines that are displayed in a line 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

getCategoryItemsLimitConfiguration

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

The limit on the number of categories that are displayed in a line chart.

See Also:

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

getCategorySort

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

The sort configuration of the category fields.

See Also:

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

getColorItemsLimitConfiguration

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

The limit on the number of lines that are displayed in a line chart.

See Also:

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

getSmallMultiplesLimitConfiguration

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

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

See Also:

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

getSmallMultiplesSort

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

The sort configuration of the small multiples field.

See Also:

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

builder

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

Returns:

a CfnDashboard.LineChartSortConfigurationProperty.Builder of CfnDashboard.LineChartSortConfigurationProperty