interface ParameterListControlProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnAnalysis.ParameterListControlProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnAnalysis.ParameterListControlProperty`
Python	`aws_cdk.aws_quicksight.CfnAnalysis.ParameterListControlProperty`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnAnalysis` » `ParameterListControlProperty`

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

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 parameterListControlProperty: quicksight.CfnAnalysis.ParameterListControlProperty = {
  parameterControlId: 'parameterControlId',
  sourceParameterName: 'sourceParameterName',
  title: 'title',

  // the properties below are optional
  cascadingControlConfiguration: {
    sourceControls: [{
      columnToMatch: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      sourceSheetControlId: 'sourceSheetControlId',
    }],
  },
  displayOptions: {
    searchOptions: {
      visibility: 'visibility',
    },
    selectAllOptions: {
      visibility: 'visibility',
    },
    titleOptions: {
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      visibility: 'visibility',
    },
  },
  selectableValues: {
    linkToDataSetColumn: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    values: ['values'],
  },
  type: 'type',
};

Properties

Name	Type	Description
parameterControlId	`string`	The ID of the `ParameterListControl` .
sourceParameterName	`string`	The source parameter name of the `ParameterListControl` .
title	`string`	The title of the `ParameterListControl` .
cascadingControlConfiguration?	`IResolvable` `\|` `CascadingControlConfigurationProperty`	The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
displayOptions?	`IResolvable` `\|` `ListControlDisplayOptionsProperty`	The display options of a control.
selectableValues?	`IResolvable` `\|` `ParameterSelectableValuesProperty`	A list of selectable values that are used in a control.
type?	`string`	The type of `ParameterListControl` .

parameterControlId

Type: string

The ID of the ParameterListControl .

sourceParameterName

Type: string

The source parameter name of the ParameterListControl .

title

Type: string

The title of the ParameterListControl .

cascadingControlConfiguration?

Type: IResolvable | CascadingControlConfigurationProperty (optional)

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

displayOptions?

Type: IResolvable | ListControlDisplayOptionsProperty (optional)

The display options of a control.

selectableValues?

Type: IResolvable | ParameterSelectableValuesProperty (optional)

A list of selectable values that are used in a control.

type?

Type: string (optional)

The type of ParameterListControl .