JavaScript/jQuery FilterBuilder API

The FilterBuilder widget allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI.

import FilterBuilder from "devextreme/ui/filter_builder"
Type:

Object

View Demo Read Guides

See Also

Options

An object defining the FilterBuilder widget's configuration options.

Name Description
accessKey

Specifies the shortcut key that sets focus on the widget.
activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.
allowHierarchicalFields

Specifies whether the widget can display hierarchical data fields.
customOperations

Configures custom filter operations.
disabled

Specifies whether the widget responds to user interaction.
elementAttr

Specifies the attributes to be attached to the widget's root element.
fields

Configures fields.
filterOperationDescriptions

Specifies filter operation descriptions.
focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.
groupOperationDescriptions

Specifies group operation descriptions.
groupOperations

Specifies a set of available group operations.
height

Specifies the widget's height.
hint

Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.
maxGroupLevel

Specifies groups' maximum nesting level.
onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing

A function that is executed before the widget is disposed of.
onEditorPrepared

A function that is executed after an editor is created.
onEditorPreparing

A function that is executed before an editor is created.
onInitialized

A function used in JavaScript frameworks to save the widget instance.
onOptionChanged

A function that is executed after a widget option is changed.
onValueChanged

A function that is executed after the widget's value is changed.
rtlEnabled

Switches the widget to a right-to-left representation.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
value

Allows you to specify a filter.
visible

Specifies whether the widget is visible.
width

Specifies the widget's width.

See Also

Methods

This section describes methods that control the FilterBuilder widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.
dispose()

Disposes of all the resources allocated to the FilterBuilder instance.
element()

Gets the root widget element.
endUpdate()

Refreshes the widget after a call of the beginUpdate() method.
focus()

Sets focus on the widget.
getFilterExpression()

Gets a filter expression that contains only operations supported by the DataSource.
getInstance(element)

Gets the instance of a widget found using its DOM node.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.
resetOption(optionName)

Resets an option to its default value.

See Also

Events

This section describes the events this widget raises.

Name Description
contentReady

Raised when the widget's content is ready.
disposing

Raised before the widget is disposed of.
editorPrepared

Raised after an editor is created.
editorPreparing

Raised before an editor is created.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.
valueChanged

Raised after the widget's value is changed.

See Also