Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.FilterListControlProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.FilterListControlProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.FilterListControlProperty
extends software.amazon.jsii.JsiiSerializable

A control to display a list of buttons or boxes.

This is used to select either a single value or multiple values.

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.*;
 FilterListControlProperty filterListControlProperty = FilterListControlProperty.builder()
         .filterControlId("filterControlId")
         .sourceFilterId("sourceFilterId")
         .title("title")
         // the properties below are optional
         .cascadingControlConfiguration(CascadingControlConfigurationProperty.builder()
                 .sourceControls(List.of(CascadingControlSourceProperty.builder()
                         .columnToMatch(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .sourceSheetControlId("sourceSheetControlId")
                         .build()))
                 .build())
         .displayOptions(ListControlDisplayOptionsProperty.builder()
                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.FilterListControlProperty.Builder	builder()
default Object	getCascadingControlConfiguration()	The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
default Object	getDisplayOptions()	The display options of a control.
String	getFilterControlId()	The ID of the FilterListControl .
default Object	getSelectableValues()	A list of selectable values that are used in a control.
String	getSourceFilterId()	The source filter ID of the FilterListControl .
String	getTitle()	The title of the FilterListControl .
default String	getType()	The type of FilterListControl .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilterControlId

@Stability(Stable)
@NotNull
String getFilterControlId()

The ID of the FilterListControl .

getSourceFilterId

@Stability(Stable)
@NotNull
String getSourceFilterId()

The source filter ID of the FilterListControl .

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title of the FilterListControl .

getCascadingControlConfiguration

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

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

getDisplayOptions

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

The display options of a control.

getSelectableValues

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

A list of selectable values that are used in a control.

getType

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

The type of FilterListControl . Choose one of the following options:.

• MULTI_SELECT : The user can select multiple entries from the list.
• SINGLE_SELECT : The user can select a single entry from the list.

builder

@Stability(Stable)
static CfnTemplate.FilterListControlProperty.Builder builder()

Returns:

a CfnTemplate.FilterListControlProperty.Builder of CfnTemplate.FilterListControlProperty