CustomInFilterValuesContext

Context used when providing values for the IN Column Filter

export interface CustomInFilterValuesContext<TData = any> extends

Extends

AdaptableColumnContext

Properties

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>[]

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

previousFilterResult?: InFilterValueResult;

Property Value

InFilterValueResult

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