interface CategoryFilterProperty

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

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide .

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 categoryFilterProperty: quicksight.CfnDashboard.CategoryFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  configuration: {
    customFilterConfiguration: {
      matchOperator: 'matchOperator',
      nullOption: 'nullOption',

      // the properties below are optional
      categoryValue: 'categoryValue',
      parameterName: 'parameterName',
      selectAllOptions: 'selectAllOptions',
    },
    customFilterListConfiguration: {
      matchOperator: 'matchOperator',
      nullOption: 'nullOption',

      // the properties below are optional
      categoryValues: ['categoryValues'],
      selectAllOptions: 'selectAllOptions',
    },
    filterListConfiguration: {
      matchOperator: 'matchOperator',

      // the properties below are optional
      categoryValues: ['categoryValues'],
      selectAllOptions: 'selectAllOptions',
    },
  },
  filterId: 'filterId',
};

Properties

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column that the filter is applied to.
configuration	IResolvable | CategoryFilterConfigurationProperty	The configuration for a CategoryFilter .
filterId	string	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

---

column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.

---

configuration

Type: IResolvable | CategoryFilterConfigurationProperty

The configuration for a CategoryFilter .

---

filterId

Type: string

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