interface NumericEqualityFilterProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.NumericEqualityFilterProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.NumericEqualityFilterProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.NumericEqualityFilterProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » 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 * as quicksight from '@aws-cdk/aws-quicksight';
const numericEqualityFilterProperty: quicksight.CfnTemplate.NumericEqualityFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  matchOperator: 'matchOperator',
  nullOption: 'nullOption',

  // the properties below are optional
  aggregationFunction: {
    categoricalAggregationFunction: 'categoricalAggregationFunction',
    dateAggregationFunction: 'dateAggregationFunction',
    numericalAggregationFunction: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
  },
  parameterName: 'parameterName',
  selectAllOptions: 'selectAllOptions',
  value: 123,
};

Properties

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column that the filter is applied to.
filterId	string	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
matchOperator	string	The match operator that is used to determine if a filter should be applied.
nullOption	string	This option determines how null values should be treated when filtering data.
aggregationFunction?	IResolvable | AggregationFunctionProperty	The aggregation function of the filter.
parameterName?	string	The parameter whose value should be used for the filter value.
selectAllOptions?	string	Select all of the values. Null is not the assigned value of select all.
value?	number	The input value.

---

column

Type: IResolvable | ColumnIdentifierProperty

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 | AggregationFunctionProperty (optional)

The aggregation function of the filter.

---

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.