interface NumericRangeFilterProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.NumericRangeFilterProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_NumericRangeFilterProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.NumericRangeFilterProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.NumericRangeFilterProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnAnalysis » NumericRangeFilterProperty

A NumericRangeFilter filters values that are within the value range.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html

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 numericRangeFilterProperty: quicksight.CfnAnalysis.NumericRangeFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  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: {
                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: {
                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: {
                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: {
                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: {
                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: {
                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: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
    },
    title: 'title',
  },
  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.
defaultFilterControlConfiguration?	IResolvable | DefaultFilterControlConfigurationProperty	The default configurations for the associated controls.
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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-column

---

filterId

Type: string

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-filterid

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-nulloption

---

aggregationFunction?

Type: IResolvable | AggregationFunctionProperty (optional)

The aggregation function of the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-aggregationfunction

---

defaultFilterControlConfiguration?

Type: IResolvable | DefaultFilterControlConfigurationProperty (optional)

The default configurations for the associated controls.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-defaultfiltercontrolconfiguration

---

includeMaximum?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includemaximum

---

includeMinimum?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includeminimum

---

rangeMaximum?

Type: IResolvable | NumericRangeFilterValueProperty (optional)

The maximum value for the filter value range.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangemaximum

---

rangeMinimum?

Type: IResolvable | NumericRangeFilterValueProperty (optional)

The minimum value for the filter value range.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangeminimum

---

selectAllOptions?

Type: string (optional)

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

• FILTER_ALL_VALUES

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-selectalloptions