Filter

Defined in: js-api/src/widgets/filter.ts:15

Base class for DataFrame-bound filtering controls. Supports collaborative filtering by efficiently working together with other filters.

Extends

• Widget

Constructors

Constructor

new Filter(): Filter

Defined in: js-api/src/widgets/filter.ts:36

Returns

Filter

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	js-api/src/widgets/base.ts:214
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:213
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/u2core/component.ts:445
_u2	readonly	ComponentState	undefined	-	Widget._u2	js-api/src/u2core/component.ts:82
column	public	Column<any, any> | null	null	A column this filter is associated with.	-	js-api/src/widgets/filter.ts:29
columnName?	public	string	undefined	-	-	js-api/src/widgets/filter.ts:31
componentMeta?	public	ComponentMetaBase	undefined	The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.	Widget.componentMeta	js-api/src/u2core/component.ts:77
controls	public	HTMLDivElement	undefined	Group of control icons on the right of the filter header, after the name. FilterGroup takes care of its visibility.	-	js-api/src/widgets/filter.ts:23
dart	public	any	undefined	-	Widget.dart	js-api/src/widgets/base.ts:217
dataFrame	public	DataFrame | null	undefined	A DataFrame this filter is associated with.	-	js-api/src/widgets/filter.ts:26
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	js-api/src/widgets/base.ts:211
indicator	public	HTMLDivElement	undefined	An indicator icon on the left of the filter header, before the name. A filter is responsible for hiding or showing it, depending on its state.	-	js-api/src/widgets/filter.ts:19
isDetached	public	boolean	false	-	Widget.isDetached	js-api/src/widgets/base.ts:218
props	public	any	undefined	-	Widget.props	js-api/src/widgets/base.ts:215
specProps?	public	Record<string, unknown>	undefined	The props the registry's create was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a create wrapping a bare element). Construction-time values — a live one always wins.	Widget.specProps	js-api/src/u2core/component.ts:81
subs	public	Subscription[]	undefined	-	Widget.subs	js-api/src/widgets/base.ts:216
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:208

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/u2core/component.ts:152

A short AI-facing briefing, seeded from the registry's usage or description.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/u2core/component.ts:156

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

Widget.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

Defined in: js-api/src/widgets/base.ts:272

A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.

Returns

boolean

Inherited from

Widget.ambientAdoption

---

caption

Get Signature

get caption(): string

Defined in: js-api/src/widgets/filter.ts:34

Caption to be shown in the filter group.

Returns

string

---

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:304

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

filterSummary

Get Signature

get abstract filterSummary(): string

Defined in: js-api/src/widgets/filter.ts:69

Override to provide short filter summary that might be shown on viewers or in the context panel.

Returns

string

---

isFiltering

Get Signature

get isFiltering(): boolean

Defined in: js-api/src/widgets/filter.ts:60

Override to indicate whether the filter actually filters something (most don't in the initial state). This is used to minimize the number of unnecessary computations. Make sure to call super.isFiltering to check whether the filter has been disabled by the user

Returns

boolean

---

isReadyToApplyFilter

Get Signature

get isReadyToApplyFilter(): boolean

Defined in: js-api/src/widgets/filter.ts:66

Whether a filter is ready to apply the filtering mask synchronously.

Returns

boolean

---

name

Get Signature

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:469

A named control carries its name in the DOM: data-u2-name is the stable automation id selectors, tutorials and agents address the control by — the same attribute the spec renderer stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary. Derived names (an input's label fallback) never stamp — see Component.deriveName.

Returns

string | undefined

Set Signature

set name(x): void

Defined in: js-api/src/u2core/component.ts:473

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

Widget.name

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:301

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

propertyTarget

Get Signature

get propertyTarget(): unknown

Defined in: js-api/src/u2core/component.ts:250

What this component's properties are read from and written to — prop.get(target) / prop.set(target, v): the component itself, unless an adoption says otherwise.

Returns

unknown

Inherited from

Widget.propertyTarget

---

propertyTier

Get Signature

get propertyTier(): boolean

Defined in: js-api/src/widgets/base.ts:276

Every property getProperties declares is a bind step, read and written on propertyTarget.

Returns

boolean

Inherited from

Widget.propertyTier

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/u2core/component.ts:455

Returns

HTMLElement

Set Signature

set root(x): void

Defined in: js-api/src/u2core/component.ts:459

Parameters

Parameter	Type
x	HTMLElement

Returns

void

Inherited from

Widget.root

---

scope

Get Signature

get scope(): Scope

Defined in: js-api/src/u2core/component.ts:53

Minted on first use; assigned before _scopeMinted fires, so the hook's own this.scope.own(...) reads the stored scope instead of re-entering the mint.

Returns

Scope

Inherited from

Widget.scope

---

type

Get Signature

get type(): string

Defined in: js-api/src/widgets/base.ts:205

Returns

string

Inherited from

Widget.type

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

Defined in: js-api/src/widgets/base.ts:351

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters

Parameter	Type
p	Property | null

Returns

void

Inherited from

Widget._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:356

Returns

ObservableLike<PropertyChange>

Inherited from

Widget._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

Defined in: js-api/src/widgets/base.ts:320

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters

Parameter	Type
_scope	Scope

Returns

void

Inherited from

Widget._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

Defined in: js-api/src/widgets/base.ts:336

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns

void

Inherited from

Widget._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

Defined in: js-api/src/widgets/base.ts:327

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns

void

Inherited from

Widget._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

Defined in: js-api/src/widgets/base.ts:322

Returns

void

Inherited from

Widget._wireLifecycle

---

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:261

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

applyFilter()

abstract applyFilter(): void

Defined in: js-api/src/widgets/filter.ts:75

Override to filter the dataframe. The method should work with this.dataFrame.filter, should disregard false values (these are filtered out already by other filters), and should filter out corresponding indexes.

Returns

void

---

applyState()

applyState(state): void

Defined in: js-api/src/widgets/filter.ts:86

Override to load filter state.

Parameters

Parameter	Type
state	any

Returns

void

---

attach()

attach(dataFrame): void

Defined in: js-api/src/widgets/filter.ts:94

Gets called when a data frame is attached. Make sure to call super.attach(dataFrame) when overriding.

Parameters

Parameter	Type	Description
dataFrame	DataFrame	-

Returns

void

---

bindProps()

bindProps(): BindProp[]

Defined in: js-api/src/u2core/component.ts:307

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns

BindProp[]

Inherited from

Widget.bindProps

---

bindStep()

bindStep(name): BindSource | Signal<unknown> | null

Defined in: js-api/src/u2core/component.ts:296

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters

Parameter	Type
name	string

Returns

BindSource | Signal<unknown> | null

Inherited from

Widget.bindStep

---

deriveName()

protected deriveName(x): void

Defined in: js-api/src/u2core/component.ts:72

Sets the introspection/form key without claiming an automation id — the label-fallback path: a caption is not a stable identity, so it never reaches data-u2-name.

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

Widget.deriveName

---

detach()

detach(): void

Defined in: js-api/src/widgets/filter.ts:114

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Overrides

Widget.detach

---

dispose()

dispose(): void

Defined in: js-api/src/u2core/component.ts:147

On a never-engaged wrapper the getter mints here and _scopeMinted wires the lifecycle (own(kill) + the platform cleanup for Dart-owned), so dispose still kills it; re-entry from the kill cleanup is a no-op via the scope's disposed flag.

Returns

void

Inherited from

Widget.dispose

---

effect()

effect(fn): this

Defined in: js-api/src/u2core/component.ts:134

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

Widget.effect

---

fireEvent()

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:435

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

Widget.fireEvent

---

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:289

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:283

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

Widget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:279

Returns all properties of this widget: the meta-generated ones plus addProperty's.

Returns

Property[]

Inherited from

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:422

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

link()

link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:268

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters

Parameter	Type
name	string
source	Signal<unknown>
twoWay	boolean

Returns

void

Inherited from

Widget.link

---

onActiveChanged()

onActiveChanged(active): void

Defined in: js-api/src/widgets/filter.ts:107

Called when the filter's enabled state changes (checkbox toggled on the filter panel). Override to react to enable/disable.

Parameters

Parameter	Type
active	boolean

Returns

void

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:419

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:295

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:287

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

Widget.onPropertyChanged

---

own()

own(dispose): this

Defined in: js-api/src/u2core/component.ts:139

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

Widget.own

---

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:366

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns

ObservableLike<PropertyChange>

Inherited from

Widget.propertyChanges

---

refresh()

refresh(): void

Defined in: js-api/src/widgets/filter.ts:112

Gets called when a previously used filter gets moved in the DOM tree. Normally, you don't need to do anything, but this might be handy for the iframe-based filters.

Returns

void

---

registerFunction()

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:431

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

Widget.registerFunction

---

runInScope()

runInScope<T>(fn): T

Defined in: js-api/src/u2core/component.ts:130

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Inherited from

Widget.runInScope

---

saveState()

saveState(): any

Defined in: js-api/src/widgets/filter.ts:78

Override to save filter state.

Returns

any

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:293

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:254

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:246

Returns

any

Inherited from

Widget.toDart

---

build()

static build(builder): Control

Defined in: js-api/src/u2core/component.ts:529

Builds a control out of plain elements: builder runs with the new control's scope ambient, so signal bindings and nested components inside it are owned by the result. The ambient scope only spans the synchronous part of builder — components constructed after an await inside it are adopted by nobody and must be disposed by hand, or constructed before the first await.

Parameters

Parameter	Type
builder	() => HTMLElement | (string | HTMLElement | Control)[]

Returns

Control

Inherited from

Widget.build

---

find()

static find(root): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:236

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

forElement()

static forElement(el): Control | undefined

Defined in: js-api/src/u2core/component.ts:489

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find). Best-effort: the last control constructed on (or assigned) a root wins it.

Parameters

Parameter	Type
el	Element | null

Returns

Control | undefined

Inherited from

Widget.forElement

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:425

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:231

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

init()

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:89

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters

Parameter	Type
self	Component
scope?	Scope

Returns

void

Inherited from

Widget.init

---

is()

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:498

Structural probe by methods only — never .scope: the accessor mints.

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

Widget.is

---

registerCleanup()

static registerCleanup(element, cleanup): void

Defined in: js-api/src/widgets/base.ts:242

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters

Parameter	Type
element	Element
cleanup	Function

Returns

void

Inherited from

Widget.registerCleanup

---

sameValue()

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:111

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters

Parameter	Type
a	unknown
b	unknown

Returns

boolean

Inherited from

Widget.sameValue