interface FilterControlProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnTemplate.FilterControlProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_FilterControlProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnTemplate.FilterControlProperty |
![]() | aws_cdk.aws_quicksight.CfnTemplate.FilterControlProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnTemplate » FilterControlProperty |
The control of a filter that is used to interact with a dashboard or an analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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 filterControlProperty: quicksight.CfnTemplate.FilterControlProperty = {
crossSheet: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
// the properties below are optional
cascadingControlConfiguration: {
sourceControls: [{
columnToMatch: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
sourceSheetControlId: 'sourceSheetControlId',
}],
},
},
dateTimePicker: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
commitMode: 'commitMode',
displayOptions: {
dateTimeFormat: 'dateTimeFormat',
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
type: 'type',
},
dropdown: {
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',
},
list: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
cascadingControlConfiguration: {
sourceControls: [{
columnToMatch: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
sourceSheetControlId: 'sourceSheetControlId',
}],
},
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
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: {
values: ['values'],
},
type: 'type',
},
relativeDateTime: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
commitMode: 'commitMode',
displayOptions: {
dateTimeFormat: 'dateTimeFormat',
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
slider: {
filterControlId: 'filterControlId',
maximumValue: 123,
minimumValue: 123,
sourceFilterId: 'sourceFilterId',
stepSize: 123,
title: 'title',
// the properties below are optional
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
type: 'type',
},
textArea: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
delimiter: 'delimiter',
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
placeholderOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
textField: {
filterControlId: 'filterControlId',
sourceFilterId: 'sourceFilterId',
title: 'title',
// the properties below are optional
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
placeholderOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
};
Properties
Name | Type | Description |
---|---|---|
cross | IResolvable | Filter | A control from a filter that is scoped across more than one sheet. |
date | IResolvable | Filter | A control from a date filter that is used to specify date and time. |
dropdown? | IResolvable | Filter | A control to display a dropdown list with buttons that are used to select a single value. |
list? | IResolvable | Filter | A control to display a list of buttons or boxes. |
relative | IResolvable | Filter | A control from a date filter that is used to specify the relative date. |
slider? | IResolvable | Filter | A control to display a horizontal toggle bar. |
text | IResolvable | Filter | A control to display a text box that is used to enter multiple entries. |
text | IResolvable | Filter | A control to display a text box that is used to enter a single entry. |
crossSheet?
Type:
IResolvable
|
Filter
(optional)
A control from a filter that is scoped across more than one sheet.
This represents your filter control on a sheet
dateTimePicker?
Type:
IResolvable
|
Filter
(optional)
A control from a date filter that is used to specify date and time.
dropdown?
Type:
IResolvable
|
Filter
(optional)
A control to display a dropdown list with buttons that are used to select a single value.
list?
Type:
IResolvable
|
Filter
(optional)
A control to display a list of buttons or boxes.
This is used to select either a single value or multiple values.
relativeDateTime?
Type:
IResolvable
|
Filter
(optional)
A control from a date filter that is used to specify the relative date.
slider?
Type:
IResolvable
|
Filter
(optional)
A control to display a horizontal toggle bar.
This is used to change a value by sliding the toggle.
textArea?
Type:
IResolvable
|
Filter
(optional)
A control to display a text box that is used to enter multiple entries.
textField?
Type:
IResolvable
|
Filter
(optional)
A control to display a text box that is used to enter a single entry.