CustomInFilterValuesContext
Context used when providing values for the IN Column Filter
export interface CustomInFilterValuesContext<TData = any> extendsExtends
Properties
| Property | Type | Description | Default |
|---|---|---|---|
| currentSearchValue | string | Current text in the IN Filter search box. | |
| defaultValues | Required<InFilterValueInfo>[] | Distinct Column values in natural (unsorted) row iteration order. | |
| limit | number | Suggested page size. Consumers may return fewer or more items. Useful when hasMore is true on the return object (lazy pagination). | 1000 |
| offset | number | Zero-based index of the first value to return. Reset to 0 when the dropdown opens or currentSearchValue changes. Increased when loading the next page (hasMore is true on the return object - this means lazy pagination is enabled). | 0 |
| orderedValues | Required<InFilterValueInfo>[] | Distinct Column values in the order they appear in the grid from top to bottom. | |
| previousFilterResult | InFilterValueResult | The result returned by the previous invocation of FilterOptions.customInFilterValues, if any. | |
| selectedValues | InFilterValue[] | Values currently selected in the IN (or NOT IN) Column Filter. | |
| sortedValues | Required<InFilterValueInfo>[] | Distinct Column values sorted by the Column's own sort direction (Asc / Desc). | |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Property Details
currentSearchValue
Current text in the IN Filter search box.
Useful when implementing server-side filtering of the value list.
currentSearchValue: string;Property Value
string
defaultValues
Distinct Column values in natural (unsorted) row iteration order.
When the Column uses a Tree Filter, items have a hierarchical structure.
Computed lazily on first access.
defaultValues: Required<InFilterValueInfo>[];Property Value
Required<InFilterValueInfo>[]
limit
Suggested page size. Consumers may return fewer or more items. Useful when hasMore is true on the return object (lazy pagination).
limit: number;Default Value
1000
Property Value
number
offset
Zero-based index of the first value to return. Reset to 0 when the dropdown opens or currentSearchValue changes. Increased when loading the next page (hasMore is true on the return object - this means lazy pagination is enabled).
offset: number;Default Value
0
Property Value
number
orderedValues
Distinct Column values in the order they appear in the grid from top to bottom.
Always a flat list, even when the Column uses a Tree Filter.
Computed lazily on first access.
orderedValues: Required<InFilterValueInfo>[];Property Value
Required<InFilterValueInfo>[]
previousFilterResult
The result returned by the previous invocation of FilterOptions.customInFilterValues, if any.
Useful for avoiding expensive recomputations (e.g. when filtering is async or server-side). Opaque pagination cursors may also be stashed on this object and read on the next call.
previousFilterResult?: InFilterValueResult;Property Value
selectedValues
Values currently selected in the IN (or NOT IN) Column Filter.
Labels are resolved from previously loaded In Filter items when available.
Useful with lazy pagination or server-side search: selected items may not be in the current page.
selectedValues: InFilterValue[];Property Value
sortedValues
Distinct Column values sorted by the Column's own sort direction (Asc / Desc).
If the Column has no active sort, values are returned in the same order as defaultValues.
When the Column uses a Tree Filter, items have a hierarchical structure.
Computed lazily on first access.
sortedValues: Required<InFilterValueInfo>[];Property Value
Required<InFilterValueInfo>[]
adaptableContext
Inherited from BaseContext
Custom application Context provided in AdaptableOptions.adaptableContext
adaptableContext: any;Property Value
any