CustomInFilterValuesContext

Context used when providing values for the IN Column Filter

TypeScript
export interface CustomInFilterValuesContext<TData = any> extends
Extends

AdaptableColumnContext

Properties

PropertyDescription
currentSearchValueSearch text in the IN Filter component - used when filtering on server
defaultValuesDefault list of values that will be displayed
orderedValuesDefault values in order which currently listed in the grid
previousFilterResultLast filter result; avoids expensive recomputations (eg if async or server-side filtering)
sortedValuesDefault values but sorted (if Column is sorted)
adaptableContextCustom application Context provided in AdaptableOptions.adaptableContext

Property Details

currentSearchValue

Search text in the IN Filter component - used when filtering on server

TypeScript
currentSearchValue: string;
Property Value

string

defaultValues

Default list of values that will be displayed

TypeScript
defaultValues: Required<InFilterValueInfo>[];
Property Value

Required<InFilterValueInfo>[]

orderedValues

Default values in order which currently listed in the grid

TypeScript
orderedValues: Required<InFilterValueInfo>[];
Property Value

Required<InFilterValueInfo>[]

previousFilterResult

Last filter result; avoids expensive recomputations (eg if async or server-side filtering)

TypeScript
previousFilterResult?: InFilterValueResult;
Property Value

InFilterValueResult

sortedValues

Default values but sorted (if Column is sorted)

TypeScript
sortedValues: Required<InFilterValueInfo>[];
Property Value

Required<InFilterValueInfo>[]

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any