Interface CfnDashboard.FilterControlProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDashboard.FilterControlProperty.Jsii$Proxy
- Enclosing class:
CfnDashboard
@Stability(Stable)
public static interface CfnDashboard.FilterControlProperty
extends software.amazon.jsii.JsiiSerializable
The control of a filter that is used to interact with a dashboard or an analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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.*; FilterControlProperty filterControlProperty = FilterControlProperty.builder() .crossSheet(FilterCrossSheetControlProperty.builder() .filterControlId("filterControlId") .sourceFilterId("sourceFilterId") // 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()) .build()) .dateTimePicker(FilterDateTimePickerControlProperty.builder() .filterControlId("filterControlId") .sourceFilterId("sourceFilterId") .title("title") // the properties below are optional .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()) .dropdown(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()) .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()) .list(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()) .relativeDateTime(FilterRelativeDateTimeControlProperty.builder() .filterControlId("filterControlId") .sourceFilterId("sourceFilterId") .title("title") // the properties below are optional .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()) .slider(FilterSliderControlProperty.builder() .filterControlId("filterControlId") .maximumValue(123) .minimumValue(123) .sourceFilterId("sourceFilterId") .stepSize(123) .title("title") // 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()) .textArea(FilterTextAreaControlProperty.builder() .filterControlId("filterControlId") .sourceFilterId("sourceFilterId") .title("title") // the properties below are optional .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()) .textField(FilterTextFieldControlProperty.builder() .filterControlId("filterControlId") .sourceFilterId("sourceFilterId") .title("title") // the properties below are optional .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDashboard.FilterControlProperty
static final class
An implementation forCfnDashboard.FilterControlProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
A control from a filter that is scoped across more than one sheet.default Object
A control from a date filter that is used to specify date and time.default Object
A control to display a dropdown list with buttons that are used to select a single value.default Object
getList()
A control to display a list of buttons or boxes.default Object
A control from a date filter that is used to specify the relative date.default Object
A control to display a horizontal toggle bar.default Object
A control to display a text box that is used to enter multiple entries.default Object
A control to display a text box that is used to enter a single entry.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCrossSheet
A control from a filter that is scoped across more than one sheet.This represents your filter control on a sheet
- See Also:
-
getDateTimePicker
A control from a date filter that is used to specify date and time.- See Also:
-
getDropdown
A control to display a dropdown list with buttons that are used to select a single value.- See Also:
-
getList
A control to display a list of buttons or boxes.This is used to select either a single value or multiple values.
- See Also:
-
getRelativeDateTime
A control from a date filter that is used to specify the relative date.- See Also:
-
getSlider
A control to display a horizontal toggle bar.This is used to change a value by sliding the toggle.
- See Also:
-
getTextArea
A control to display a text box that is used to enter multiple entries.- See Also:
-
getTextField
A control to display a text box that is used to enter a single entry.- See Also:
-
builder
-