Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.TopBottomFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.TopBottomFilterProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.TopBottomFilterProperty
extends software.amazon.jsii.JsiiSerializable

A TopBottomFilter filters values that are at the top or the bottom.

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.*;
 TopBottomFilterProperty topBottomFilterProperty = TopBottomFilterProperty.builder()
         .aggregationSortConfigurations(List.of(AggregationSortConfigurationProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .sortDirection("sortDirection")
                 // 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()))
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         // the properties below are optional
         .defaultFilterControlConfiguration(DefaultFilterControlConfigurationProperty.builder()
                 .controlOptions(DefaultFilterControlOptionsProperty.builder()
                         .defaultDateTimePickerOptions(DefaultDateTimePickerControlOptionsProperty.builder()
                                 .commitMode("commitMode")
                                 .displayOptions(DateTimePickerControlDisplayOptionsProperty.builder()
                                         .dateTimeFormat("dateTimeFormat")
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultDropdownOptions(DefaultFilterDropDownControlOptionsProperty.builder()
                                 .commitMode("commitMode")
                                 .displayOptions(DropDownControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                         .values(List.of("values"))
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultListOptions(DefaultFilterListControlOptionsProperty.builder()
                                 .displayOptions(ListControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .searchOptions(ListControlSearchOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                         .values(List.of("values"))
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultRelativeDateTimeOptions(DefaultRelativeDateTimeControlOptionsProperty.builder()
                                 .commitMode("commitMode")
                                 .displayOptions(RelativeDateTimeControlDisplayOptionsProperty.builder()
                                         .dateTimeFormat("dateTimeFormat")
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .defaultSliderOptions(DefaultSliderControlOptionsProperty.builder()
                                 .maximumValue(123)
                                 .minimumValue(123)
                                 .stepSize(123)
                                 // the properties below are optional
                                 .displayOptions(SliderControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultTextAreaOptions(DefaultTextAreaControlOptionsProperty.builder()
                                 .delimiter("delimiter")
                                 .displayOptions(TextAreaControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .defaultTextFieldOptions(DefaultTextFieldControlOptionsProperty.builder()
                                 .displayOptions(TextFieldControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .title("title")
                 .build())
         .limit(123)
         .parameterName("parameterName")
         .timeGranularity("timeGranularity")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.TopBottomFilterProperty.Builder	builder()
Object	getAggregationSortConfigurations()	The aggregation and sort configuration of the top bottom filter.
Object	getColumn()	The column that the filter is applied to.
default Object	getDefaultFilterControlConfiguration()	The default configurations for the associated controls.
String	getFilterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
default Number	getLimit()	The number of items to include in the top bottom filter results.
default String	getParameterName()	The parameter whose value should be used for the filter value.
default String	getTimeGranularity()	The level of time precision that is used to aggregate DateTime values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationSortConfigurations

@Stability(Stable)
@NotNull
Object getAggregationSortConfigurations()

The aggregation and sort configuration of the top bottom filter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-aggregationsortconfigurations

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-column

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-filterid

getDefaultFilterControlConfiguration

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

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-defaultfiltercontrolconfiguration

getLimit

@Stability(Stable)
@Nullable
default Number getLimit()

The number of items to include in the top bottom filter results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-limit

getParameterName

@Stability(Stable)
@Nullable
default String getParameterName()

The parameter whose value should be used for the filter value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-parametername

getTimeGranularity

@Stability(Stable)
@Nullable
default String getTimeGranularity()

The level of time precision that is used to aggregate DateTime values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-timegranularity

builder

@Stability(Stable)
static CfnAnalysis.TopBottomFilterProperty.Builder builder()

Returns:

a CfnAnalysis.TopBottomFilterProperty.Builder of CfnAnalysis.TopBottomFilterProperty