interface FilterProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnTemplate.FilterProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_FilterProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnTemplate.FilterProperty |
 Python | aws_cdk.aws_quicksight.CfnTemplate.FilterProperty |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnTemplate » FilterProperty |
With a Filter , you can remove portions of data from a particular visual or view.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| category | IResolvable | Category | A CategoryFilter filters text values. |
| nested | IResolvable | Nested | A NestedFilter filters data with a subset of data that is defined by the nested inner filter. |
| numeric | IResolvable | Numeric | A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value. |
| numeric | IResolvable | Numeric | A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range. |
| relative | IResolvable | Relative | A RelativeDatesFilter filters date values that are relative to a given date. |
| time | IResolvable | Time | A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value. |
| time | IResolvable | Time | A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range. |
| top | IResolvable | Top | A TopBottomFilter filters data to the top or bottom values for a given column. |
categoryFilter?
Type:
IResolvable | Category
(optional)
A CategoryFilter filters text values.
For more information, see Adding text filters in the Amazon Quick Suite User Guide .
nestedFilter?
Type:
IResolvable | Nested
(optional)
A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
numericEqualityFilter?
Type:
IResolvable | Numeric
(optional)
A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
numericRangeFilter?
Type:
IResolvable | Numeric
(optional)
A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
relativeDatesFilter?
Type:
IResolvable | Relative
(optional)
A RelativeDatesFilter filters date values that are relative to a given date.
timeEqualityFilter?
Type:
IResolvable | Time
(optional)
A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
timeRangeFilter?
Type:
IResolvable | Time
(optional)
A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
topBottomFilter?
Type:
IResolvable | Top
(optional)
A TopBottomFilter filters data to the top or bottom values for a given column.