GridFilterAppliedInfo

View as Markdown

Payload of the GridFilterApplied event.

Fires when the Grid Filter on the current Layout is set, cleared, suspended or unsuspended.

Extends , so adaptableApi is included.

TypeScript
export interface GridFilterAppliedInfo extends
Extends

BaseContext

Properties

PropertyTypeDescription
gridFilterGridFilter | undefinedGrid Filter on the current Layout after this change.

undefined when the Layout has no Grid Filter (including after it is cleared).
gridFilterExpressionASTanyAST of gridFilter.Expression.

null when the Layout has no Grid Filter.
adaptableContextanyCustom application Context provided in AdaptableOptions.adaptableContext

Property Details

gridFilter

Grid Filter on the current Layout after this change.

undefined when the Layout has no Grid Filter (including after it is cleared).

TypeScript
gridFilter: GridFilter | undefined;
Property Value

GridFilter | undefined

gridFilterExpressionAST

AST of gridFilter.Expression.

null when the Layout has no Grid Filter.

TypeScript
gridFilterExpressionAST: any;
Property Value

any

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any