GridFilterApi

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

export interface

Methods

Method Details

clearGridFilter

Clears the Grid Filter (for the current Layout)

clearGridFilter(): void;

Returns

void

getCurrentGridFilter

Retrieves the Grid Filter from the current Layout

getCurrentGridFilter(): GridFilter | undefined;

Returns

GridFilter | undefined

getCurrentGridFilterExpression

Retrieves the Grid Filter's Expression from the current layout

getCurrentGridFilterExpression(): string | undefined;

Returns

string | undefined

openUIEditorForGridFilter

Opens the AdapTableQL UI Components (Expression Editor & Query Builder)

openUIEditorForGridFilter(expression?: string): void;

Parameters

Returns

void

reApplyGridFilter

Re-applies the Grid Filter

reApplyGridFilter(): void;

Returns

void

setGridFilterExpression

Sets the Grid Filter (for the current layout)

If expression is null, undefined or a blank string the Grid Filter is cleared (equivalent to calling ). This makes it safe to drive the Grid Filter from form-style controls that emit empty values when the user deselects everything, without having to branch in the caller.

setGridFilterExpression(expression: string | null | undefined): void;

Parameters

Returns

void

setGridFilterExpressionUsingNamedQuery

Sets the Grid Filter (for the current layout)

setGridFilterExpressionUsingNamedQuery(namedQuery: NamedQuery): void;

Parameters

Returns

void

suspendGridFilter

Suspends the Grid Filter

suspendGridFilter(): void;

Returns

void

unSuspendGridFilter

Unsuspends the Grid Filter

unSuspendGridFilter(): void;

Returns

void