Choose values from a list PRO
Select which distinct column values to display.
Choose a column with repeated choices, such as Region. This differs from the default preview's text filter.
View code
Sample data included in the code · 6 rows
Usage guide
#Use this for columns with known values such as APAC, EMEA, and AMER, allowing users to check the values they want.
Integration steps
- Choose a target column
Choose a column with repeated choices, such as Region. This differs from the default preview's text filter.
- Configure a value-list filter
Set filter: 'set' on Region and provide header filters or a column menu for access.
- Inspect selected-value results
Select only APAC in your app and verify that only APAC orders remain. Selecting all values clears the region restriction.
Filter orders by choosing list values without typing a search term.
This is a Pro feature. With remote data, decide whether the provider must include values that have not yet loaded.
Useful terms
- Set filter
- A filter selecting included values from a distinct-value list.
- Distinct values
- A list retaining each value only once.
Key API examples
Application code that references the registered Grid element as grid.
grid.columnDefs = grid.columnDefs.map(col => col.field==='region' ? {...col,filter:'set'} : col);Using this feature in your product requires the Pro runtime and a valid license.
API reference
#ColumnDef1
| ColumnDef | Type / Required | Description |
|---|---|---|
PRO OPTION | | ColumnFilterDecl
| string
| GridFilterDefinition<TData, TValue, unknown, TContext>Optional | Filter type. `true` enables the built-in text filter; `false` disables it. an ordered array stacks several kinds on this column in one dropdown, AND-combined — see . |
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.