Filter

Configure rules to filter data. Filter can connect to a Table component and dynamically filter displayed data.

Properties

Available properties for Filter with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionvalueobject | null

The current value.

hiddenboolean

Whether the component is visible.

linkToTableboolean

Whether the component is linked to a Table component.

linkedTableIdstring

The ID of the table to which this component is linked.

maintainSpaceWhenHiddenboolean

Whether the component takes up space on the canvas if hidden is true.

marginstring

The amount of margin to render outside of the component.

showInEditorboolean

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

tooltipTextstring

The text to display in a tooltip on hover or focus.

Methods

Methods for interacting with Filter. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionclearValue()

Clear the current value.

scrollIntoView(options: any)

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

setHidden(hidden: boolean)

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

resetValue()

Reset value to the default value.

setValue(value: any, shouldUpdateModel: any, shouldUpdateLinkedTable: any)

Set the current value.