Interface CfnTemplate.NumericRangeFilterProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.NumericRangeFilterProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.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() .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() .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() .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()) .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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.NumericRangeFilterProperty
static final class
An implementation forCfnTemplate.NumericRangeFilterProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The aggregation function of the filter.The column that the filter is applied to.default Object
The default configurations for the associated controls.An identifier that uniquely identifies a filter within a dashboard, analysis, or template.default Object
Determines whether the maximum value in the filter value range should be included in the filtered results.default Object
Determines whether the minimum value in the filter value range should be included in the filtered results.This option determines how null values should be treated when filtering data.default Object
The maximum value for the filter value range.default Object
The minimum value for the filter value range.default String
Select all of the values.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getColumn
The column that the filter is applied to.- See Also:
-
getFilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.- See Also:
-
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:
-
getAggregationFunction
The aggregation function of the filter.- See Also:
-
getDefaultFilterControlConfiguration
The default configurations for the associated controls.This applies only for filters that are scoped to multiple sheets.
- See Also:
-
getIncludeMaximum
Determines whether the maximum value in the filter value range should be included in the filtered results.- See Also:
-
getIncludeMinimum
Determines whether the minimum value in the filter value range should be included in the filtered results.- See Also:
-
getRangeMaximum
The maximum value for the filter value range.- See Also:
-
getRangeMinimum
The minimum value for the filter value range.- See Also:
-
getSelectAllOptions
Select all of the values. Null is not the assigned value of select all.FILTER_ALL_VALUES
- See Also:
-
builder
-