# externalFilter

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

Canonical: https://grid.syidax.com/docs/options/externalFilter/

<a id="meaning"></a>

## What does this API do?

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

<a id="contract"></a>

## 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><br>    \| GridExternalFilterInstance<GridData, unknown> |

<a id="usage"></a>

## 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.

<a id="types"></a>

## Read related types

- [GridExternalFilterCallbacks](https://grid.syidax.com/docs/types/GridExternalFilterCallbacks.md)
- [GridData](https://grid.syidax.com/docs/types/GridData.md)
- [GridExternalFilterInstance](https://grid.syidax.com/docs/types/GridExternalFilterInstance.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Filter by business conditions](https://grid.syidax.com/docs/features/external-filter.md) — 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.