# NumericEqualityFilterProperty

A `NumericEqualityFilter` filters values that are equal to the specified value.

- Source: Generated code
- Type last changed: v2.140.0 · 2 May 2024

## Example

```ts
// 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',

    // the properties below are optional
    dataSetIdentifier: 'dataSetIdentifier',
    topicIdentifier: 'topicIdentifier',
  },
  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: {
          dateIconVisibility: 'dateIconVisibility',
          dateTimeFormat: 'dateTimeFormat',
          helperTextVisibility: 'helperTextVisibility',
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
    },
    title: 'title',
  },
  parameterName: 'parameterName',
  selectAllOptions: 'selectAllOptions',
  value: 123,
};
```

## Properties

- `aggregationFunction`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDashboard.AggregationFunctionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnDashboard.AggregationFunctionProperty.html) — The aggregation function of the filter.

- `column`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDashboard.ColumnIdentifierProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnDashboard.ColumnIdentifierProperty.html) (required) — The column that the filter is applied to.

- `defaultFilterControlConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDashboard.DefaultFilterControlConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty.html) — The default configurations for the associated controls.

  This applies only for filters that are scoped to multiple sheets.

- `filterId`: string (required) — An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

- `matchOperator`: string (required) — The match operator that is used to determine if a filter should be applied.

- `nullOption`: string (required) — 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.

- `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.

  - `FILTER_ALL_VALUES`

- `value`: number — The input value.