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

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the FilterBuilder widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function () {
    $("#filterBuilder").dxFilterBuilder({
        value: ["Category", "contains", "Tel"],
        fields: [{
            dataField: "Category"
        }, {
            dataField: "Shipped",
            caption: "Shipment Date",
            dataType: "date"
        }, {
            dataField: "UnitPrice",
            dataType: "number"
        }]
    });
});

<div id="filterBuilder"></div>

Angular

HTML

TypeScript

<dx-filter-builder
    [value]='["Category", "contains", "Tel"]'>
    <dxi-field
        dataField="Category">
    </dxi-field>
    <dxi-field
        dataField="Shipped"
        caption="Shipment Date"
        dataType="date">
    </dxi-field>
    <dxi-field
        dataField="UnitPrice"
        dataType="number">
    </dxi-field>
</dx-filter-builder>

import { DxFilterBuilderModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxFilterBuilderModule
    ],
    // ...
})

AngularJS

HTML

<div ng-controller="DemoController">
    <div dx-filter-builder="{
        value: ['Category', 'contains', 'Tel'],
        fields: [{
            dataField: 'Category'
        }, {
            dataField: 'Shipped',
            caption: 'Shipment Date',
            dataType: 'date'
        }, {
            dataField: 'UnitPrice',
            dataType: 'number'
        }]
    }"></div>
</div>

Knockout

HTML

<div data-bind="dxFilterBuilder: {
    value: ['Category', 'contains', 'Tel'],
    fields: [{
        dataField: 'Category'
    }, {
        dataField: 'Shipped',
        caption: 'Shipment Date',
        dataType: 'date'
    }, {
        dataField: 'UnitPrice',
        dataType: 'number'
    }]
}"></div>

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().FilterBuilder()
    .ID("filterBuilder")
    .Value(new object[] { "CompanyName", "contains", "Tel" })
    .Fields(fields => {
        fields.Add().DataField("CompanyName");
        fields.Add().DataField("City")
            .Caption("Shipment Date")
            .DataType(FilterBuilderFieldDataType.Date);
        fields.Add().DataField("State")
            .DataType(FilterBuilderFieldDataType.Number);
    })
)

@(Html.DevExtreme().FilterBuilder() _
    .ID("filterBuilder") _
    .Value(New String() {"CompanyName", "contains", "Tel"}) _
    .Fields(Sub(fields)
        fields.Add().DataField("CompanyName")
        fields.Add().DataField("City") _
            .Caption("Shipment Date") _
            .DataType(FilterBuilderFieldDataType.Date)
        fields.Add().DataField("State") _
            .DataType(FilterBuilderFieldDataType.Number)
    End Sub)
)

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.
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.
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 that is executed only once, after the widget is initialized.
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.

Methods

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.

Events

This section describes the events this widget raises.

Name	Description
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.

Field

The FilterBuilder's field structure.

Type:

Object

View Demo

JavaScript/jQuery FilterBuilder API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Options

Methods

Events

See Also

Field