CreatedFilterFn

Defined in: features/column-filtering/columnFilteringFeature.types.ts:126

The shape returned by constructFilterFn: a FilterFn with its definition attached, so variants can be built by spreading it into another constructFilterFn call.

The call signature is generic so a created filter function can be used with any table's rows, regardless of the feature set it was defined against.

Extends

• FilterFnDef<TFeatures, TData>

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

CreatedFilterFn<TRowFeatures, TRowData>(
   row,
   columnId,
   filterValue,
   addMeta?): boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:130

The shape returned by constructFilterFn: a FilterFn with its definition attached, so variants can be built by spreading it into another constructFilterFn call.

The call signature is generic so a created filter function can be used with any table's rows, regardless of the feature set it was defined against.

Type Parameters

TRowFeatures

TRowFeatures extends TableFeatures

TRowData

TRowData extends RowData

Parameters

row

Row<TRowFeatures, TRowData>

columnId

string

filterValue

any

addMeta?

(meta) => void

Returns

boolean

Properties

autoRemove?

optional autoRemove?: (filterValue) => boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:113

Parameters

filterValue

any

Returns

boolean

Inherited from

FilterFnDef.autoRemove

filter

filter: (dataValue, filterValue, row, columnId, addMeta?) => boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:106

Parameters

dataValue

any

filterValue

any

row

Row<TFeatures, TData>

columnId

string

addMeta?

(meta) => void

Returns

boolean

Inherited from

FilterFnDef.filter

resolveDataValue?

optional resolveDataValue?: TransformDataValueFn;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:115

Inherited from

FilterFnDef.resolveDataValue

resolveFilterValue?

optional resolveFilterValue?: (filterValue) => any;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:114

Parameters

filterValue

any

Returns

any

Inherited from

FilterFnDef.resolveFilterValue