SYIDAX / DATA GRID

Filter by business conditions

Connect conditions selected outside the Grid to row filtering.

Get started
Filter by business conditionsSample order data
120 rows
Loading Grid…
Latest result

For example, add an app switch hiding completed orders. The current preview does not include this external switch.

View code
Current preview

Usage guide

#

Filter rows through business conditions outside the table, such as a Show incomplete orders switch.

Integration steps

  1. Define a business condition

    For example, add an app switch hiding completed orders. The current preview does not include this external switch.

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

  3. Notify condition changes

    Call refreshExternalFilter() when users change the switch. Recalculate even when only conditions inside the same filter object change.

Expected results

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 / PropertyType / DefaultDescription
externalFilter
| GridExternalFilterCallbacks<GridData> | GridExternalFilterInstance<GridData, unknown>Default: undefinedOptional client-side external filter callbacks or lifecycle instance.
Methods1
Method / ArgumentsReturn typeDescription
Promise<boolean>Re-run a same-identity external filter's async refresh contract.