API REFERENCE

externalFilter

Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.

Markdown source Features

What does this API do?

Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.

Exact input and result types

typescript

externalFilter: | GridExternalFilterCallbacks<GridData>
    | GridExternalFilterInstance<GridData, unknown>

Item	Value
JavaScript name	externalFilter
HTML attribute	external-filter
Default	undefined
Input type	\| GridExternalFilterCallbacks<GridData> \| GridExternalFilterInstance<GridData, unknown>

Usage flow

Set this on a property of the Grid element. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

Read related types

Feature explanations and examples

Filter by business conditions
Connect business conditions outside the Grid through a row predicate. Use this when external UI choices, such as incomplete items or items assigned to you, control the table.