All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDashboard.NumericRangeFilterProperty.Jsii$Proxy

Enclosing class:: CfnDashboard

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

A NumericRangeFilter filters values that are within the value range.

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.*;
 NumericRangeFilterProperty numericRangeFilterProperty = NumericRangeFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .nullOption("nullOption")
         // 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())
         .defaultFilterControlConfiguration(DefaultFilterControlConfigurationProperty.builder()
                 .controlOptions(DefaultFilterControlOptionsProperty.builder()
                         .defaultDateTimePickerOptions(DefaultDateTimePickerControlOptionsProperty.builder()
                                 .commitMode("commitMode")
                                 .displayOptions(DateTimePickerControlDisplayOptionsProperty.builder()
                                         .dateIconVisibility("dateIconVisibility")
                                         .dateTimeFormat("dateTimeFormat")
                                         .helperTextVisibility("helperTextVisibility")
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .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")
                                                         .fontFamily("fontFamily")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .absolute("absolute")
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .title("title")
                 .build())
         .includeMaximum(false)
         .includeMinimum(false)
         .rangeMaximum(NumericRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .staticValue(123)
                 .build())
         .rangeMinimum(NumericRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .staticValue(123)
                 .build())
         .selectAllOptions("selectAllOptions")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDashboard.NumericRangeFilterProperty.Builder

A builder for CfnDashboard.NumericRangeFilterProperty

static final class

CfnDashboard.NumericRangeFilterProperty.Jsii$Proxy

An implementation for CfnDashboard.NumericRangeFilterProperty
Method Summary

Modifier and Type

Method

Description

static CfnDashboard.NumericRangeFilterProperty.Builder

builder()

default Object

getAggregationFunction()

The aggregation function of the 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 Object

getIncludeMaximum()

Determines whether the maximum value in the filter value range should be included in the filtered results.

default Object

getIncludeMinimum()

Determines whether the minimum value in the filter value range should be included in the filtered results.

String

getNullOption()

This option determines how null values should be treated when filtering data.

default Object

getRangeMaximum()

The maximum value for the filter value range.

default Object

getRangeMinimum()

The minimum value for the filter value range.

default String

getSelectAllOptions()

Select all of the values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- 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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-filterid
- getNullOption
  
  @Stability(Stable) @NotNull String getNullOption()
  This option determines how null values should be treated when filtering data.
  
  ALL_VALUES : Include null values in filtered results.
  
  NULLS_ONLY : Only include null values in filtered results.
  
  NON_NULLS_ONLY : Exclude null values from filtered results.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-nulloption
- getAggregationFunction
  
  @Stability(Stable) @Nullable default Object getAggregationFunction()
  
  The aggregation function of the filter.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-aggregationfunction
- 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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-defaultfiltercontrolconfiguration
- getIncludeMaximum
  
  @Stability(Stable) @Nullable default Object getIncludeMaximum()
  
  Determines whether the maximum value in the filter value range should be included in the filtered results.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-includemaximum
- getIncludeMinimum
  
  @Stability(Stable) @Nullable default Object getIncludeMinimum()
  
  Determines whether the minimum value in the filter value range should be included in the filtered results.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-includeminimum
- getRangeMaximum
  
  @Stability(Stable) @Nullable default Object getRangeMaximum()
  
  The maximum value for the filter value range.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-rangemaximum
- getRangeMinimum
  
  @Stability(Stable) @Nullable default Object getRangeMinimum()
  
  The minimum value for the filter value range.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-rangeminimum
- getSelectAllOptions
  
  @Stability(Stable) @Nullable default String getSelectAllOptions()
  Select all of the values. Null is not the assigned value of select all.
  
  FILTER_ALL_VALUES
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-selectalloptions
- builder
  
  @Stability(Stable) static CfnDashboard.NumericRangeFilterProperty.Builder builder()
  
  Returns:
  
  a CfnDashboard.NumericRangeFilterProperty.Builder of CfnDashboard.NumericRangeFilterProperty

Interface CfnDashboard.NumericRangeFilterProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getColumn

getFilterId

getNullOption

getAggregationFunction

getDefaultFilterControlConfiguration

getIncludeMaximum

getIncludeMinimum

getRangeMaximum

getRangeMinimum

getSelectAllOptions

builder