1.204.0

interface FilterSliderControlProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.FilterSliderControlProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.FilterSliderControlProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.FilterSliderControlProperty
TypeScript @aws-cdk/aws-quicksight » CfnTemplate » FilterSliderControlProperty

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 * as quicksight from '@aws-cdk/aws-quicksight';
const filterSliderControlProperty: quicksight.CfnTemplate.FilterSliderControlProperty = {
  filterControlId: 'filterControlId',
  maximumValue: 123,
  minimumValue: 123,
  sourceFilterId: 'sourceFilterId',
  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',
    },
  },
  type: 'type',
};

Properties

NameTypeDescription
filterControlIdstringThe ID of the FilterSliderControl .
maximumValuenumberThe smaller value that is displayed at the left of the slider.
minimumValuenumberThe larger value that is displayed at the right of the slider.
sourceFilterIdstringThe source filter ID of the FilterSliderControl .
stepSizenumberThe number of increments that the slider bar is divided into.
titlestringThe title of the FilterSliderControl .
displayOptions?IResolvable | SliderControlDisplayOptionsPropertyThe display options of a control.
type?stringThe type of FilterSliderControl . Choose one of the following options:.

filterControlId

Type: string

The ID of the FilterSliderControl .

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.

sourceFilterId

Type: string

The source filter ID of the FilterSliderControl .

stepSize

Type: number

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

title

Type: string

The title of the FilterSliderControl .

displayOptions?

Type: IResolvable | SliderControlDisplayOptionsProperty (optional)

The display options of a control.

type?

Type: string (optional)

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.
← PreviousNext →