interface NumericEqualityFilterProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDashboard.NumericEqualityFilterProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_NumericEqualityFilterProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnDashboard.NumericEqualityFilterProperty |
![]() | aws_cdk.aws_quicksight.CfnDashboard.NumericEqualityFilterProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnDashboard » NumericEqualityFilterProperty |
A NumericEqualityFilter
filters values that are equal to the specified 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 numericEqualityFilterProperty: quicksight.CfnDashboard.NumericEqualityFilterProperty = {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
filterId: 'filterId',
matchOperator: 'matchOperator',
nullOption: 'nullOption',
// the properties below are optional
aggregationFunction: {
attributeAggregationFunction: {
simpleAttributeAggregation: 'simpleAttributeAggregation',
valueForMultipleValues: 'valueForMultipleValues',
},
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
defaultFilterControlConfiguration: {
controlOptions: {
defaultDateTimePickerOptions: {
commitMode: 'commitMode',
displayOptions: {
dateTimeFormat: 'dateTimeFormat',
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
type: 'type',
},
defaultDropdownOptions: {
commitMode: 'commitMode',
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
selectAllOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
selectableValues: {
values: ['values'],
},
type: 'type',
},
defaultListOptions: {
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
searchOptions: {
visibility: 'visibility',
},
selectAllOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
selectableValues: {
values: ['values'],
},
type: 'type',
},
defaultRelativeDateTimeOptions: {
commitMode: 'commitMode',
displayOptions: {
dateTimeFormat: 'dateTimeFormat',
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
defaultSliderOptions: {
maximumValue: 123,
minimumValue: 123,
stepSize: 123,
// the properties below are optional
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
type: 'type',
},
defaultTextAreaOptions: {
delimiter: 'delimiter',
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
placeholderOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
defaultTextFieldOptions: {
displayOptions: {
infoIconLabelOptions: {
infoIconText: 'infoIconText',
visibility: 'visibility',
},
placeholderOptions: {
visibility: 'visibility',
},
titleOptions: {
customLabel: 'customLabel',
fontConfiguration: {
fontColor: 'fontColor',
fontDecoration: 'fontDecoration',
fontSize: {
absolute: 'absolute',
relative: 'relative',
},
fontStyle: 'fontStyle',
fontWeight: {
name: 'name',
},
},
visibility: 'visibility',
},
},
},
},
title: 'title',
},
parameterName: 'parameterName',
selectAllOptions: 'selectAllOptions',
value: 123,
};
Properties
Name | Type | Description |
---|---|---|
column | IResolvable | Column | The column that the filter is applied to. |
filter | string | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
match | string | The match operator that is used to determine if a filter should be applied. |
null | string | This option determines how null values should be treated when filtering data. |
aggregation | IResolvable | Aggregation | The aggregation function of the filter. |
default | IResolvable | Default | The default configurations for the associated controls. |
parameter | string | The parameter whose value should be used for the filter value. |
select | string | Select all of the values. Null is not the assigned value of select all. |
value? | number | The input value. |
column
Type:
IResolvable
|
Column
The column that the filter is applied to.
filterId
Type:
string
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
matchOperator
Type:
string
The match operator that is used to determine if a filter should be applied.
nullOption
Type:
string
This option determines how null values should be treated when filtering data.
ALL_VALUES
: Include null values in filtered results.NULLS_ONLY
: Only include null values in filtered results.NON_NULLS_ONLY
: Exclude null values from filtered results.
aggregationFunction?
Type:
IResolvable
|
Aggregation
(optional)
The aggregation function of the filter.
defaultFilterControlConfiguration?
Type:
IResolvable
|
Default
(optional)
The default configurations for the associated controls.
This applies only for filters that are scoped to multiple sheets.
parameterName?
Type:
string
(optional)
The parameter whose value should be used for the filter value.
selectAllOptions?
Type:
string
(optional)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
value?
Type:
number
(optional)
The input value.