The Filter component for Retool Apps

An interface to define filters for Table components.

Version: Cloud and 3.188 Edge

Filter connects to a Table component to dynamically filter its displayed data.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	filter1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

linkedTableId

The ID of the linked table.

Type	string
Mutability	Read-only

---

linkToTable

Whether to link with a table.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

value

A list of table filters.

Type	object
Mutability	Read-only

Object Properties

filters

A list of filters applied to the table.

Type	array
Array values	object
Mutability	Read-only

Array Object Properties

columnId

The column on which to filter.

Type	string
Mutability	Read-only

---

disabled

Whether the filter is disabled.

Type	boolean
Mutability	Read-only

---

operator

The operator.

Type	string
Mutability	Read-only

---

value

The filter value.

Type	string
Mutability	Read-only

---

---

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

filter.clearValue()

Clear the current values.

Definition

filter.clearValue()

Examples

Clear the current value of filter.

filter.clearValue();

---

filter.resetValue()

Reset the current value to the default value.

Definition

filter.resetValue()

Examples

Reset the current value of filter.

filter.resetValue();

---

filter.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

filter.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring filter into view.

filter.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

filter.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

filter.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide filter.

filter.setHidden(true);

Unhide filter.

filter.setHidden(false);

---

filter.setValue()

Set the current value.

Definition

filter.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of filter to userValue.

filter.setValue(userValue);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description