Interface CfnTemplate.CategoryFilterProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.CategoryFilterProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.CategoryFilterProperty
extends software.amazon.jsii.JsiiSerializable
A
CategoryFilter
filters text values.
For more information, see Adding text filters in the Amazon QuickSight 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() .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()) .defaultDropdownOptions(DefaultFilterDropDownControlOptionsProperty.builder() .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()) .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") .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()) .defaultRelativeDateTimeOptions(DefaultRelativeDateTimeControlOptionsProperty.builder() .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()) .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") .fontSize(FontSizeProperty.builder() .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") .fontSize(FontSizeProperty.builder() .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") .fontSize(FontSizeProperty.builder() .relative("relative") .build()) .fontStyle("fontStyle") .fontWeight(FontWeightProperty.builder() .name("name") .build()) .build()) .visibility("visibility") .build()) .build()) .build()) .build()) .title("title") .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.CategoryFilterProperty
static final class
An implementation forCfnTemplate.CategoryFilterProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getColumn
The column that the filter is applied to.- See Also:
-
getConfiguration
The configuration for aCategoryFilter
.- See Also:
-
getFilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.- See Also:
-
getDefaultFilterControlConfiguration
The default configurations for the associated controls.This applies only for filters that are scoped to multiple sheets.
- See Also:
-
builder
-