IntegratedFiltering Plugin Reference

A plugin that performs built-in data filtering.

Import

Use the following statement to import the plugin:

import { IntegratedFiltering } from '@devexpress/dx-react-grid';

User Reference

Dependencies

Properties

Name Type Default Description
columnExtensions? Array<IntegratedFiltering.ColumnExtension>   Additional column properties that the plugin can handle.

Interfaces

IntegratedFiltering.ColumnExtension

Describes additional column properties that the plugin can handle.

Field Type Description
columnName string The name of a column to extend.
predicate? (value: any, filter: Filter, row: any) => boolean A filter predicate. The filter parameter accepts an object containing the ‘value’ field. Note that you can use the onFilter event to extend this object to the fields your filtering algorithm requires.

FilterExpression

Describes data filtering expressions

Field Type Description
operator ‘and’ | ‘or’ Specifies the Boolean operator
filters Array<FilterExpression | Filter> Specifies filters or filter expressions

Static Fields

Field Type Description
defaultPredicate (value: any, filter: Filter, row: any) => boolean The built-in filter predicate. The filter parameter accepts an object containing the ‘value’ field.

Plugin Developer Reference

Imports

Name Plugin Type Description
rows Getter Array<any> Rows to be filtered.
filterExpression Getter FilterExpression | Filter A filter expression to be applied.
getCellValue Getter (row: any, columnName: string) => any The function used to get a cell value.
isGroupRow? Getter (row: any) => boolean A function used to identify a group row within ordinary rows.
getRowLevelKey? Getter (row: any) => string? A function used to get row level key.
getCollapsedRows Getter (row: any) => Array<any>? A function used to get collapsed rows associated with the given row.

Exports

Name Plugin Type Description
rows Getter Array<any> The filtered rows.
getCollapsedRows Getter (row: any) => Array<any>? A function used to get collapsed rows associated with the given row.