Interface CfnTemplate.FilterDropDownControlProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.FilterDropDownControlProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.FilterDropDownControlProperty
extends software.amazon.jsii.JsiiSerializable
A control to display a dropdown list with buttons that are used to select a single value.
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.*;
FilterDropDownControlProperty filterDropDownControlProperty = FilterDropDownControlProperty.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())
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTemplate.FilterDropDownControlPropertystatic final classAn implementation forCfnTemplate.FilterDropDownControlProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe 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 StringThe visibility configuration of the Apply button on aFilterDropDownControl.default ObjectThe display options of theFilterDropDownControl.The ID of theFilterDropDownControl.default ObjectA list of selectable values that are used in a control.The source filter ID of theFilterDropDownControl.getTitle()The title of theFilterDropDownControl.default StringgetType()The type of theFilterDropDownControl.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFilterControlId
The ID of theFilterDropDownControl.- See Also:
-
getSourceFilterId
The source filter ID of theFilterDropDownControl.- See Also:
-
getTitle
The title of theFilterDropDownControl.- 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.Returns union: either
IResolvableorCfnTemplate.CascadingControlConfigurationProperty- See Also:
-
getCommitMode
The visibility configuration of the Apply button on aFilterDropDownControl.- See Also:
-
getDisplayOptions
The display options of theFilterDropDownControl.Returns union: either
IResolvableorCfnTemplate.DropDownControlDisplayOptionsProperty- See Also:
-
getSelectableValues
A list of selectable values that are used in a control.Returns union: either
IResolvableorCfnTemplate.FilterSelectableValuesProperty- See Also:
-
getType
The type of theFilterDropDownControl. Choose one of the following options:.MULTI_SELECT: The user can select multiple entries from a dropdown menu.SINGLE_SELECT: The user can select a single entry from a dropdown menu.
- See Also:
-
builder
-