ColumnFilterApi

Provides run-time access to Filter section of Adaptable State.

TypeScript

export interface

Methods

Method	Returns	Description
addBlanksToInFilterValues(columnDistinctValues)	`InFilterValueInfo[]`	Adds the Blanks Predicate if any value is null, undefined or an empty string
clearAndSetColumnFilters(columnFilters)	`void`	Clears existing Column Filters and sets new ones
clearColumnFilter(columnFilter)	`void`	Clears given Column Filter in the current Layout
clearColumnFilterForColumn(columnId)	`void`	Clears Column Filter for given Column
clearColumnFilters()	`void`	Clears all Column Filters in the Current Layout
clearColumnFiltersForColumns(columns)	`void`	Clears Column Filters for given set of Columns
columnFiltersToString(columnFilters)	`string`	Retrieves descriptions of given Column Filters
columnFilterToString(columnFilter)	`string`	Retrieves description of given Column Filter
getActiveColumnFilters()	`ColumnFilter[]`	Retrieves all active/no-suspended Column Filters in currently applied Layout
getColumnFilterDefs()	`ColumnFilterDef[]`	Retrieves the Column Filter definitions for all available Column Filters
getColumnFilterForColumn(columnId)	`ColumnFilter` `\| undefined`	Retrieves the Column Filter for the specified Column.
getColumnFilters()	`ColumnFilter[]`	Retrieves all Column Filters in currently applied Layout
getColumnFiltersForLayout(layoutName)	`ColumnFilter[]`	Retrieves all Column Filters in a given Layout
getFilterPredicateDefsForColumn(column)	`AdaptablePredicateDef[]`	Gets all Filter Predicates available for a given Column
getFilterPredicateDefsForColumnId(columnId)	`AdaptablePredicateDef[] \| undefined`	Gets all Filter Predicates available for a given ColumnId
hideColumnFilterMenu()	`void`	Hides Column Filter Menu
hideQuickFilterBar()	`void`	Hides Quick Filter bar
isColumnFilterActive(columnFilter)	`boolean`	Checks if a Column Filter is active (i.e. Predicate has no inputs or has inputs with values)
isColumnFilterActiveForColumn(columnId)	`boolean`	Checks if the given Coumn has an active Column Filter
isQuickFilterAvailable()	`boolean`	Whether Quick Filter is available for use
isQuickFilterVisible()	`boolean`	Whether Quick Filter Form is currently visible
refreshAllFilterValues()	`Promise<Record<string,InFilterValueResult>>`	Refreshes (reloads) the filter values for ALL Columns (for `IN` Filter).
refreshFilterValues(columnId)	`Promise<InFilterValueResult>`	Refresh(reload) the filter values for a given Column (for `IN` Filter).
resetAllFilterValues()	`void`	Reset(clear cache) the filter values for ALL Columns (for `IN` Filter).
resetFilterValues(columnId)	`void`	Reset(clear cache) the filter values for a given Column (for `IN` Filter).
setColumnFilterForColumn(columnId, predicate)	`void`	Sets the Column Filter for a given Column (clears any existing)
setColumnFilters(columnFilters)	`ColumnFilter[] \| null`	Sets Column Filters in current Layout; replaces filters for existing column, leaving other column filters in place
showQuickFilterBar()	`void`	Makes Quick Filter Bar appear
suspendAllColumnFilters()	`void`	Suspends all Column Filters
suspendColumnFilter(columnFilter)	`void`	Suspends a Column Filter
unSuspendAllColumnFilters()	`void`	Unsuspend all Column Filters
unSuspendColumnFilter(columnFilter)	`void`	Unsuspend a Column Filter

Method Details

addBlanksToInFilterValues

Adds the Blanks Predicate if any value is null, undefined or an empty string

TypeScript

addBlanksToInFilterValues(columnDistinctValues: InFilterValueInfo[]): InFilterValueInfo[];

Parameters

Parameter	Type	Description
columnDistinctValues	`InFilterValueInfo[]`	list to check for empty values

Returns

InFilterValueInfo[]

clearAndSetColumnFilters

Clears existing Column Filters and sets new ones

TypeScript

clearAndSetColumnFilters(columnFilters: ColumnFilter[]): void;

Parameters

Parameter	Type	Description
columnFilters	`ColumnFilter[]`	Column Filters to set

Returns

void

clearColumnFilter

Clears given Column Filter in the current Layout

TypeScript

clearColumnFilter(columnFilter: ColumnFilter): void;

Parameters

Parameter	Type	Description
columnFilter	`ColumnFilter`	Column Filter to clear

Returns

void

clearColumnFilterForColumn

Clears Column Filter for given Column

TypeScript

clearColumnFilterForColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	Column for which Column Filter should be cleared

Returns

void

clearColumnFilters

Clears all Column Filters in the Current Layout

TypeScript

clearColumnFilters(): void;

Returns

void

clearColumnFiltersForColumns

Clears Column Filters for given set of Columns

TypeScript

clearColumnFiltersForColumns(columns: string[]): void;

Parameters

Parameter	Type	Description
columns	`string[]`	Columns for which Column Filter should be cleared

Returns

void

columnFiltersToString

Retrieves descriptions of given Column Filters

TypeScript

columnFiltersToString(columnFilters: ColumnFilter[]): string;

Parameters

Parameter	Type	Description
columnFilters	`ColumnFilter[]`	Column Filters to use

Returns

string

columnFilterToString

Retrieves description of given Column Filter

TypeScript

columnFilterToString(columnFilter: ColumnFilter): string;

Parameters

Parameter	Type	Description
columnFilter	`ColumnFilter`	Column Filter to use

Returns

string

getActiveColumnFilters

Retrieves all active/no-suspended Column Filters in currently applied Layout

TypeScript

getActiveColumnFilters(): ColumnFilter[];

Returns

ColumnFilter[]

getColumnFilterDefs

Retrieves the Column Filter definitions for all available Column Filters

TypeScript

getColumnFilterDefs(): ColumnFilterDef[];

Returns

ColumnFilterDef[]

getColumnFilterForColumn

Retrieves the Column Filter for the specified Column.

TypeScript

getColumnFilterForColumn(columnId: string): ColumnFilter | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	Column ID to lookup

Returns

ColumnFilter | undefined

getColumnFilters

Retrieves all Column Filters in currently applied Layout

TypeScript

getColumnFilters(): ColumnFilter[];

Returns

ColumnFilter[]

getColumnFiltersForLayout

Retrieves all Column Filters in a given Layout

TypeScript

getColumnFiltersForLayout(layoutName: string): ColumnFilter[];

Parameters

Parameter	Type	Description
layoutName	`string`	Layout to retrieve Column Filters for

Returns

ColumnFilter[]

getFilterPredicateDefsForColumn

Gets all Filter Predicates available for a given Column

TypeScript

getFilterPredicateDefsForColumn(column: AdaptableColumn): AdaptablePredicateDef[];

Parameters

Parameter	Type	Description
column	`AdaptableColumn`	Column to lookup

Returns

AdaptablePredicateDef[]

getFilterPredicateDefsForColumnId

Gets all Filter Predicates available for a given ColumnId

TypeScript

getFilterPredicateDefsForColumnId(columnId: string): AdaptablePredicateDef[] | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column to lookup

Returns

AdaptablePredicateDef[] | undefined

hideColumnFilterMenu

Hides Column Filter Menu

TypeScript

hideColumnFilterMenu(): void;

Returns

void

hideQuickFilterBar

Hides Quick Filter bar

TypeScript

hideQuickFilterBar(): void;

Returns

void

isColumnFilterActive

Checks if a Column Filter is active (i.e. Predicate has no inputs or has inputs with values)

TypeScript

isColumnFilterActive(columnFilter: ColumnFilter): boolean;

Parameters

Parameter	Type
columnFilter	`ColumnFilter`

Returns

boolean

isColumnFilterActiveForColumn

Checks if the given Coumn has an active Column Filter

TypeScript

isColumnFilterActiveForColumn(columnId: string): boolean;

Parameters

Parameter	Type	Description
columnId	`string`	Column ID to check

Returns

boolean

isQuickFilterAvailable

Whether Quick Filter is available for use

TypeScript

isQuickFilterAvailable(): boolean;

Returns

boolean

isQuickFilterVisible

Whether Quick Filter Form is currently visible

TypeScript

isQuickFilterVisible(): boolean;

Returns

boolean

refreshAllFilterValues

Refreshes (reloads) the filter values for ALL Columns (for IN Filter).

TypeScript

refreshAllFilterValues(): Promise<Record<string, InFilterValueResult>>;

Returns

Promise<Record<string,InFilterValueResult>>

refreshFilterValues

Refresh(reload) the filter values for a given Column (for IN Filter).

TypeScript

refreshFilterValues(columnId: string): Promise<InFilterValueResult>;

Parameters

Parameter	Type	Description
columnId	`string`	the ID of the Column for which to refresh filter values. a Promise that resolves to the list of filter values, each represented as an object with `value` and `label` properties.

Returns

Promise<InFilterValueResult>

resetAllFilterValues

Reset(clear cache) the filter values for ALL Columns (for IN Filter).

TypeScript

resetAllFilterValues(): void;

Returns

void

resetFilterValues

Reset(clear cache) the filter values for a given Column (for IN Filter).

TypeScript

resetFilterValues(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	the ID of the Column for which to reset filter values.

Returns

void

setColumnFilterForColumn

Sets the Column Filter for a given Column (clears any existing)

TypeScript

setColumnFilterForColumn(columnId: string, predicate: ColumnFilterPredicate): void;

Parameters

Parameter	Type	Description
columnId	`string`	Column ID to set Column Filter for
predicate	`ColumnFilterPredicate`	Column Filter to set

Returns

void

setColumnFilters

Sets Column Filters in current Layout; replaces filters for existing column, leaving other column filters in place

TypeScript

setColumnFilters(columnFilters: ColumnFilter[]): ColumnFilter[] | null;

Parameters

Parameter	Type	Description
columnFilters	`ColumnFilter[]`	Column Filters to set

Returns

ColumnFilter[] | null

showQuickFilterBar

Makes Quick Filter Bar appear

TypeScript

showQuickFilterBar(): void;

Returns

void

suspendAllColumnFilters

Suspends all Column Filters

TypeScript

suspendAllColumnFilters(): void;

Returns

void

suspendColumnFilter

Suspends a Column Filter

TypeScript

suspendColumnFilter(columnFilter: ColumnFilter): void;

Parameters

Parameter	Type	Description
columnFilter	`ColumnFilter`	Column Filter to Suspend

Returns

void

unSuspendAllColumnFilters

Unsuspend all Column Filters

TypeScript

unSuspendAllColumnFilters(): void;

Returns

void

unSuspendColumnFilter

Unsuspend a Column Filter

TypeScript

unSuspendColumnFilter(columnFilter: ColumnFilter): void;

Parameters

Parameter	Type	Description
columnFilter	`ColumnFilter`	Column Filter to UnSuspend

Returns

void

PreviousColumnFilter NextColumnFilterAppliedInfo