Filter by business conditions
Connect conditions selected outside the Grid to row filtering.
For example, add an app switch hiding completed orders. The current preview does not include this external switch.
View code
Sample data included in the code · 6 rows
Usage guide
#Filter rows through business conditions outside the table, such as a Show incomplete orders switch.
Integration steps
- Define a business condition
For example, add an app switch hiding completed orders. The current preview does not include this external switch.
- Connect a row predicate
Connect externalFilter to code determining whether it is active and whether each row passes. Compare source status values rather than cell text.
- Notify condition changes
Call refreshExternalFilter() when users change the switch. Recalculate even when only conditions inside the same filter object change.
The external app switch and displayed Grid rows update together.
External conditions can combine with column filters and order search. Decide which conditions to clear when returning to the full view.
Useful terms
- externalFilter
- A filter deciding row visibility from app business rules.
- refreshExternalFilter
- A call notifying the Grid to recalculate changed external conditions.
API reference
#Other properties1
| Attribute / Property | Type / Default | Description |
|---|---|---|
| externalFilter | | GridExternalFilterCallbacks<GridData>
| GridExternalFilterInstance<GridData, unknown>Default: undefined | Optional client-side external filter callbacks or lifecycle instance. |
Methods1
| Method / Arguments | Return type | Description |
|---|---|---|
Promise<boolean> | Re-run a same-identity external filter's async refresh contract. |
Explore each feature
Learn when to use each feature and how to configure it. Each guide identifies live examples and features you connect in your app.