Function: column_getAutoFilterFn()#

function column_getAutoFilterFn<TFeatures, TData, TValue>(column): 
  | FilterFn<TFeatures, TData>
  | undefined;

Defined in: features/column-filtering/columnFilteringFeature.utils.ts:42

Chooses a built-in filter function from the column's first core row value.

Strings use includesString, numbers use inNumberRange, booleans and objects use equals, dates use inDateRange, arrays use arrIncludes, and unknown values fall back to weakEquals.

The chosen filter function is looked up in the table's filterFns registry. When it is not registered there, this returns undefined and warns in development instead of substituting a different filter function.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column_Internal<TFeatures, TData, TValue>

Returns#

| FilterFn<TFeatures, TData> | undefined

Example#

const filterFn = column_getAutoFilterFn(column)