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:277
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/widgets/base.ts:275
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
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:280
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:273
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:281
props	public	any	undefined	-	Widget.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	Widget.subs	js-api/src/widgets/base.ts:279
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:270

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Returns

string | null

Set Signature

set aiDescription(x): void

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

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

Widget.aiDescription

---

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:362

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

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

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

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(r): void

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

Parameters

Parameter	Type
r	HTMLElement

Returns

void

Inherited from

Widget.root

---

type

Get Signature

get type(): string

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

Returns

string

Inherited from

Widget.type

Methods

apply()

apply(properties): Widget

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

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

---

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

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

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:329

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

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:415

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:353

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

---

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

---

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:351

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

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

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:303

Returns

any

Inherited from

Widget.toDart

---

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

fromRoot()

static fromRoot(root): Widget

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

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:294

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll