JavaScript/jQuery FilterBuilder API
The FilterBuilder UI component allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI.
See Also
jQuery
Angular
Vue
React
Options
An object defining the FilterBuilder UI component's configuration properties.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled | Specifies whether the UI component changes its visual state as a result of user interaction. |
| allowHierarchicalFields | Specifies whether the UI component can display hierarchical data fields. |
| customOperations | Configures custom filter operations. |
| disabled | Specifies whether the UI component responds to user interaction. |
| elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
| fields | Configures fields. |
| filterOperationDescriptions | Specifies filter operation descriptions. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| groupOperationDescriptions | Specifies group operation descriptions. |
| groupOperations | Specifies a set of available group operations. |
| height | Specifies the UI component's height. |
| hint | Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled | Specifies whether the UI component changes its state when a user pauses on it. |
| maxGroupLevel | Specifies groups' maximum nesting level. |
| onContentReady | A function that is executed when the UI component is rendered and each time the component is repainted. |
| onDisposing | A function that is executed before the UI component 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 UI component instance. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onValueChanged | A function that is executed after the UI component's value is changed. |
| rtlEnabled | Switches the UI component 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 UI component is visible. |
| width | Specifies the UI component's width. |
See Also
Methods
This section describes methods that control the FilterBuilder UI component.
| Name | Description |
|---|---|
| beginUpdate() | Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the FilterBuilder instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getFilterExpression() | Gets a filter expression that contains only operations supported by the DataSource. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| 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 UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) | Resets a property to its default value. |
See Also
Events
This section describes the events this UI component raises.
| Name | Description |
|---|---|
| contentReady | Raised when the UI component is rendered and each time the component is repainted. |
| disposing | Raised before the UI component is disposed of. |
| editorPrepared | Raised after an editor is created. |
| editorPreparing | Raised before an editor is created. |
| initialized | Raised only once, after the UI component is initialized. |
| optionChanged | Raised after a UI component property is changed. |
| valueChanged | Raised after the UI component's value is changed. |
See Also
Types
| Name | Description |
|---|---|
| ContentReadyEvent | The type of the contentReady event handler's argument. |
| DisposingEvent | The type of the disposing event handler's argument. |
| EditorPreparedEvent | The type of the editorPrepared event handler's argument. |
| EditorPreparingEvent | The type of the editorPreparing event handler's argument. |
| FieldInfo | Information about a FilterBuilder field. |
| FilterBuilderOperation | Specifies a set of available filter operations. |
| GroupOperation | Specifies a set of available group operations. |
| InitializedEvent | The type of the initialized event handler's argument. |
| OptionChangedEvent | The type of the optionChanged event handler's argument. |
| ValueChangedEvent | The type of the valueChanged event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.