Search results

FilterModel API in JavaScript Pivot Table API control

Interface for a class Filter

Properties

condition

Operators

Allows you to choose the operator type such as equals, greater than, less than, etc. for conditional-based filtering.

It is applicable only for label and value filtering.

items

string[]

Allows you to specify the field members that used to be displayed based on the filter type provided in the pivot table.

levelCount

number

Allows to set level of the field to fetch data from the cube for filtering.

This option is applicable only for user-defined hierarchies in OLAP data source.

measure

string

Allows to set value field for evaluation using conditions and operands for filtering.

It is applicable only for label and value filtering.

name

string

Allows you to set the field name that used to display the selective or conditional-based filter members that used to be displayed in the pivot table.

selectedField

string

Allows to set level name of a specified field, where the filtering settings to be applied.

This option is applicable only for user-defined hierarchies in OLAP data source.

type

FilterType

Allows you to set the specific filter type to display the filter members in the pivot table. They are:

  • Include - Specifies the filter type as include for member filter.
  • Exclude - Specifies the filter type as exclude for member filter.
  • Label - Specifies the filter type as label for header filter.
  • Date - Specifies the filter type as date for date based filter.
  • Number - Specifies the filter type as number for number based filter.
  • Value - Specifies the filter type as value for value based filter.

value1

string | Date

Allows you to set the start value to display the filter items in the pivot table based on the condition applied.

It is applicable only for label and value filtering.

value2

string | Date

Allows you to set the end value to display the filter items in the pivot table based on the condition applied.

This option will be used by default when the operator Between and NotBetween is chosen to apply. Also, it is applicable only for label and value filtering.