interface FilterDropDownControlProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.QuickSight.CfnAnalysis.FilterDropDownControlProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_FilterDropDownControlProperty |
Java | software.amazon.awscdk.services.quicksight.CfnAnalysis.FilterDropDownControlProperty |
Python | aws_cdk.aws_quicksight.CfnAnalysis.FilterDropDownControlProperty |
TypeScript | aws-cdk-lib » aws_quicksight » CfnAnalysis » FilterDropDownControlProperty |
A control to display a dropdown list with buttons that are used to select a single value.
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 filterDropDownControlProperty: quicksight.CfnAnalysis.FilterDropDownControlProperty = {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
cascadingControlConfiguration: {
sourceControls: [{
columnToMatch: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
sourceSheetControlId: 'sourceSheetControlId',
}],
},
commitMode: 'commitMode',
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
selectAllOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
selectableValues: {
values: ['values'],
},
type: 'type',
};
Properties
Name | Type | Description |
---|---|---|
filter | string | The ID of the FilterDropDownControl . |
source | string | The source filter ID of the FilterDropDownControl . |
title | string | The title of the FilterDropDownControl . |
cascading | IResolvable | Cascading | 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. |
commit | string | The visibility configuration of the Apply button on a FilterDropDownControl . |
display | IResolvable | Drop | The display options of the FilterDropDownControl . |
selectable | IResolvable | Filter | A list of selectable values that are used in a control. |
type? | string | The type of the FilterDropDownControl . Choose one of the following options:. |
filterControlId
Type:
string
The ID of the FilterDropDownControl
.
sourceFilterId
Type:
string
The source filter ID of the FilterDropDownControl
.
title
Type:
string
The title of the FilterDropDownControl
.
cascadingControlConfiguration?
Type:
IResolvable
|
Cascading
(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.
commitMode?
Type:
string
(optional)
The visibility configuration of the Apply button on a FilterDropDownControl
.
displayOptions?
Type:
IResolvable
|
Drop
(optional)
The display options of the FilterDropDownControl
.
selectableValues?
Type:
IResolvable
|
Filter
(optional)
A list of selectable values that are used in a control.
type?
Type:
string
(optional)
The type of the FilterDropDownControl
. Choose one of the following options:.
MULTI_SELECT
: The user can select multiple entries from a dropdown menu.SINGLE_SELECT
: The user can select a single entry from a dropdown menu.