Interface CfnAnalysis.FilterSliderControlProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAnalysis.FilterSliderControlProperty.Jsii$Proxy
Enclosing class:
CfnAnalysis

@Stability(Stable) public static interface CfnAnalysis.FilterSliderControlProperty extends software.amazon.jsii.JsiiSerializable
A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

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.*;
 FilterSliderControlProperty filterSliderControlProperty = FilterSliderControlProperty.builder()
         .filterControlId("filterControlId")
         .maximumValue(123)
         .minimumValue(123)
         .sourceFilterId("sourceFilterId")
         .stepSize(123)
         .title("title")
         // the properties below are optional
         .displayOptions(SliderControlDisplayOptionsProperty.builder()
                 .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();
 
  • Method Details

    • getFilterControlId

      @Stability(Stable) @NotNull String getFilterControlId()
      The ID of the FilterSliderControl .
    • getMaximumValue

      @Stability(Stable) @NotNull Number getMaximumValue()
      The smaller value that is displayed at the left of the slider.
    • getMinimumValue

      @Stability(Stable) @NotNull Number getMinimumValue()
      The larger value that is displayed at the right of the slider.
    • getSourceFilterId

      @Stability(Stable) @NotNull String getSourceFilterId()
      The source filter ID of the FilterSliderControl .
    • getStepSize

      @Stability(Stable) @NotNull Number getStepSize()
      The number of increments that the slider bar is divided into.
    • getTitle

      @Stability(Stable) @NotNull String getTitle()
      The title of the FilterSliderControl .
    • getDisplayOptions

      @Stability(Stable) @Nullable default Object getDisplayOptions()
      The display options of a control.
    • getType

      @Stability(Stable) @Nullable default String getType()
      The type of FilterSliderControl . Choose one of the following options:.

      • SINGLE_POINT : Filter against(equals) a single data point.
      • RANGE : Filter data that is in a specified range.
    • builder

      @Stability(Stable) static CfnAnalysis.FilterSliderControlProperty.Builder builder()
      Returns:
      a CfnAnalysis.FilterSliderControlProperty.Builder of CfnAnalysis.FilterSliderControlProperty