Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.CategoryFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.CategoryFilterProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon Quick Suite User Guide .

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.*;
 CategoryFilterProperty categoryFilterProperty = CategoryFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .configuration(CategoryFilterConfigurationProperty.builder()
                 .customFilterConfiguration(CustomFilterConfigurationProperty.builder()
                         .matchOperator("matchOperator")
                         .nullOption("nullOption")
                         // the properties below are optional
                         .categoryValue("categoryValue")
                         .parameterName("parameterName")
                         .selectAllOptions("selectAllOptions")
                         .build())
                 .customFilterListConfiguration(CustomFilterListConfigurationProperty.builder()
                         .matchOperator("matchOperator")
                         .nullOption("nullOption")
                         // the properties below are optional
                         .categoryValues(List.of("categoryValues"))
                         .selectAllOptions("selectAllOptions")
                         .build())
                 .filterListConfiguration(FilterListConfigurationProperty.builder()
                         .matchOperator("matchOperator")
                         // the properties below are optional
                         .categoryValues(List.of("categoryValues"))
                         .nullOption("nullOption")
                         .selectAllOptions("selectAllOptions")
                         .build())
                 .build())
         .filterId("filterId")
         // the properties below are optional
         .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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.CategoryFilterProperty.Builder	builder()
Object	getColumn()	The column that the filter is applied to.
Object	getConfiguration()	The configuration for a CategoryFilter .
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.

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.

Returns union: either IResolvable or CfnDashboard.ColumnIdentifierProperty

See Also:

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

getConfiguration

@Stability(Stable)
@NotNull
Object getConfiguration()

The configuration for a CategoryFilter .

Returns union: either IResolvable or CfnDashboard.CategoryFilterConfigurationProperty

See Also:

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

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-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-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.

Returns union: either IResolvable or CfnDashboard.DefaultFilterControlConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnDashboard.CategoryFilterProperty.Builder of CfnDashboard.CategoryFilterProperty