interface NumericRangeFilterProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnTemplate.NumericRangeFilterProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnTemplate.NumericRangeFilterProperty`
Python	`aws_cdk.aws_quicksight.CfnTemplate.NumericRangeFilterProperty`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnTemplate` » `NumericRangeFilterProperty`

A NumericRangeFilter filters values that are within the value range.

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 numericRangeFilterProperty: quicksight.CfnTemplate.NumericRangeFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  nullOption: 'nullOption',

  // the properties below are optional
  aggregationFunction: {
    categoricalAggregationFunction: 'categoricalAggregationFunction',
    dateAggregationFunction: 'dateAggregationFunction',
    numericalAggregationFunction: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
  },
  includeMaximum: false,
  includeMinimum: false,
  rangeMaximum: {
    parameter: 'parameter',
    staticValue: 123,
  },
  rangeMinimum: {
    parameter: 'parameter',
    staticValue: 123,
  },
  selectAllOptions: 'selectAllOptions',
};

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.
nullOption	`string`	This option determines how null values should be treated when filtering data.
aggregationFunction?	`IResolvable` `\|` `AggregationFunctionProperty`	The aggregation function of the filter.
includeMaximum?	`boolean \|` `IResolvable`	Determines whether the maximum value in the filter value range should be included in the filtered results.
includeMinimum?	`boolean \|` `IResolvable`	Determines whether the minimum value in the filter value range should be included in the filtered results.
rangeMaximum?	`IResolvable` `\|` `NumericRangeFilterValueProperty`	The maximum value for the filter value range.
rangeMinimum?	`IResolvable` `\|` `NumericRangeFilterValueProperty`	The minimum value for the filter value range.
selectAllOptions?	`string`	Select all of the values. Null is not the assigned value of select all.

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.

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.

includeMaximum?

Type: boolean | IResolvable (optional)

Determines whether the maximum value in the filter value range should be included in the filtered results.

includeMinimum?

Type: boolean | IResolvable (optional)

Determines whether the minimum value in the filter value range should be included in the filtered results.

rangeMaximum?

Type: IResolvable | NumericRangeFilterValueProperty (optional)

The maximum value for the filter value range.

rangeMinimum?

Type: IResolvable | NumericRangeFilterValueProperty (optional)

The minimum value for the filter value range.

selectAllOptions?

Type: string (optional)

Select all of the values. Null is not the assigned value of select all.

FILTER_ALL_VALUES