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() .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.FilterListControlProperty
static final class
An implementation forCfnTemplate.FilterListControlProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
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
The display options of a control.The ID of theFilterListControl
.default Object
A list of selectable values that are used in a control.The source filter ID of theFilterListControl
.getTitle()
The title of theFilterListControl
.default String
getType()
The type of theFilterListControl
.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFilterControlId
The ID of theFilterListControl
.- See Also:
-
getSourceFilterId
The source filter ID of theFilterListControl
.- See Also:
-
getTitle
The title of theFilterListControl
.- See Also:
-
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.- See Also:
-
getDisplayOptions
The display options of a control.- See Also:
-
getSelectableValues
A list of selectable values that are used in a control.- See Also:
-
getType
The type of theFilterListControl
. 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.
- See Also:
-
builder
-