aws-cdk-lib.aws_quicksight.CfnTemplate.ParameterSliderControlProperty

interface ParameterSliderControlProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.ParameterSliderControlProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_ParameterSliderControlProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.ParameterSliderControlProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.ParameterSliderControlProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » ParameterSliderControlProperty

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const parameterSliderControlProperty: quicksight.CfnTemplate.ParameterSliderControlProperty = {
  maximumValue: 123,
  minimumValue: 123,
  parameterControlId: 'parameterControlId',
  sourceParameterName: 'sourceParameterName',
  stepSize: 123,
  title: 'title',

  // the properties below are optional
  displayOptions: {
    titleOptions: {
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      visibility: 'visibility',
    },
  },
};

Properties

NameTypeDescription
maximumValuenumberThe smaller value that is displayed at the left of the slider.
minimumValuenumberThe larger value that is displayed at the right of the slider.
parameterControlIdstringThe ID of the ParameterSliderControl .
sourceParameterNamestringThe source parameter name of the ParameterSliderControl .
stepSizenumberThe number of increments that the slider bar is divided into.
titlestringThe title of the ParameterSliderControl .
displayOptions?IResolvable | SliderControlDisplayOptionsPropertyThe display options of a control.

maximumValue

Type: number

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


minimumValue

Type: number

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


parameterControlId

Type: string

The ID of the ParameterSliderControl .


sourceParameterName

Type: string

The source parameter name of the ParameterSliderControl .


stepSize

Type: number

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


title

Type: string

The title of the ParameterSliderControl .


displayOptions?

Type: IResolvable | SliderControlDisplayOptionsProperty (optional)

The display options of a control.