ColumnFilterChangedInfo

EventInfo returned by the ColumnFilterChanged event.

Fires for every column-filter editor or state change — including incomplete drafts (e.g. operator chosen, value not yet valid) that are not persisted.

Prefer this over ColumnFilterApplied when you need to observe in-progress edits. Use isApplied to ignore drafts.

export interface ColumnFilterChangedInfo extends

Extends

BaseContext

Properties

Property Details

columnFilters

Currently persisted Column Filters after this change. Unchanged when isApplied is false.

columnFilters: ColumnFilter[];

Property Value

ColumnFilter[]

columnId

Column whose filter changed. Undefined for bulk actions (e.g. clear/suspend all).

columnId?: string;

Property Value

string

expression

Expression for columnId after this change when available. May be omitted for incomplete drafts with nothing persistable yet.

expression?: string;

Property Value

string

isApplied

True when persisted Column Filters were updated (layout state) and grid filtering may change. False when only an in-progress editor draft changed (incomplete expression, or manual-apply pending Apply).

When true, ColumnFilterApplied is also emitted for backward compatibility.

isApplied: boolean;

Property Value

boolean

isComplete

Whether the filter expression for this change is fully specified.

• When isApplied is false: the editor draft is valid (not e.g. an operator with a missing value). False for incomplete drafts.
• When isApplied is true: a complete Expression was written or remains for the column. False when the column filter was cleared/deactivated.

These flags diverge for clear/deactivate (isComplete: false, isApplied: true), incomplete drafts (false/false), manual-apply pending Apply (true/false), and the usual complete apply (true/true).

isComplete: boolean;

Property Value

boolean

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

adaptableContext: any;

Property Value

any