Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.ParameterSliderControlProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.ParameterSliderControlProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.ParameterSliderControlProperty
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.*;
 ParameterSliderControlProperty parameterSliderControlProperty = ParameterSliderControlProperty.builder()
         .maximumValue(123)
         .minimumValue(123)
         .parameterControlId("parameterControlId")
         .sourceParameterName("sourceParameterName")
         .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")
                                 .fontFamily("fontFamily")
                                 .fontSize(FontSizeProperty.builder()
                                         .absolute("absolute")
                                         .relative("relative")
                                         .build())
                                 .fontStyle("fontStyle")
                                 .fontWeight(FontWeightProperty.builder()
                                         .name("name")
                                         .build())
                                 .build())
                         .visibility("visibility")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.ParameterSliderControlProperty.Builder	A builder for CfnDashboard.ParameterSliderControlProperty
static final class	CfnDashboard.ParameterSliderControlProperty.Jsii$Proxy	An implementation for CfnDashboard.ParameterSliderControlProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.ParameterSliderControlProperty.Builder	builder()
default Object	getDisplayOptions()	The display options of a control.
Number	getMaximumValue()	The larger value that is displayed at the right of the slider.
Number	getMinimumValue()	The smaller value that is displayed at the left of the slider.
String	getParameterControlId()	The ID of the ParameterSliderControl .
String	getSourceParameterName()	The source parameter name of the ParameterSliderControl .
Number	getStepSize()	The number of increments that the slider bar is divided into.
String	getTitle()	The title of the ParameterSliderControl .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaximumValue

@Stability(Stable)
@NotNull
Number getMaximumValue()

The larger value that is displayed at the right of the slider.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-maximumvalue

getMinimumValue

@Stability(Stable)
@NotNull
Number getMinimumValue()

The smaller value that is displayed at the left of the slider.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-minimumvalue

getParameterControlId

@Stability(Stable)
@NotNull
String getParameterControlId()

The ID of the ParameterSliderControl .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-parametercontrolid

getSourceParameterName

@Stability(Stable)
@NotNull
String getSourceParameterName()

The source parameter name of the ParameterSliderControl .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-sourceparametername

getStepSize

@Stability(Stable)
@NotNull
Number getStepSize()

The number of increments that the slider bar is divided into.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-stepsize

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title of the ParameterSliderControl .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-title

getDisplayOptions

@Stability(Stable)
@Nullable
default Object getDisplayOptions()

The display options of a control.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-displayoptions

builder

@Stability(Stable)
static CfnDashboard.ParameterSliderControlProperty.Builder builder()

Returns:

a CfnDashboard.ParameterSliderControlProperty.Builder of CfnDashboard.ParameterSliderControlProperty