React FilterBuilder Methods

This section describes methods that control the FilterBuilder UI component.

See Also

beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the FilterBuilder UI component in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxFilterBuilder.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the FilterBuilder properties
    }
});
Angular
TypeScript
import FilterBuilder, { Properties } from "devextreme/ui/filter_builder";
// ...
export class AppComponent {
    constructor () {
        FilterBuilder.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the FilterBuilder properties
            }
        });
    }
}
Vue
<template>
    <div>
        <DxFilterBuilder id="filterBuilder1" />
        <DxFilterBuilder id="filterBuilder2" />
    </div>
</template>
<script>
import DxFilterBuilder from "devextreme-vue/filter-builder";
import FilterBuilder from "devextreme/ui/filter_builder";

FilterBuilder.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the FilterBuilder properties
    }
});

export default {
    components: {
        DxFilterBuilder
    }
}
</script>
React
import dxFilterBuilder from "devextreme/ui/filter_builder";
import FilterBuilder from "devextreme-react/filter-builder";

dxFilterBuilder.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the FilterBuilder properties
    }
});

export default function App() {
    return (
        <div>
            <FilterBuilder id="filterBuilder1" />
            <FilterBuilder id="filterBuilder2" />
        </div>
    )
}

You can also set rules for multiple device types:

jQuery
JavaScript
const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxFilterBuilder.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the FilterBuilder properties
        }
    });
});
Angular
TypeScript
import FilterBuilder, { Properties } from "devextreme/ui/filter_builder";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            FilterBuilder.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the FilterBuilder properties
                }
            });
        });
    }
}
Vue
<template>
    <div>
        <DxFilterBuilder />
    </div>
</template>
<script>
import DxFilterBuilder from "devextreme-vue/filter-builder";
import FilterBuilder from "devextreme/ui/filter_builder";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    FilterBuilder.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the FilterBuilder properties
        }
    });
});

export default {
    components: {
        DxFilterBuilder
    }
}
</script>
React
import dxFilterBuilder from "devextreme/ui/filter_builder";
import FilterBuilder from "devextreme-react/filter-builder";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxFilterBuilder.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the FilterBuilder properties
        }
    });
});

export default function App() {
    return (
        <div>
            <FilterBuilder />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the FilterBuilder instance.

jQuery

After calling this method, remove the DOM element associated with the UI component:

JavaScript
$("#myFilterBuilder").dxFilterBuilder("dispose");
$("#myFilterBuilder").remove();
Angular

Use conditional rendering instead of this method:

app.component.html
<dx-filter-builder ...
    *ngIf="condition">
</dx-filter-builder>
Vue

Use conditional rendering instead of this method:

App.vue
<template>
    <DxFilterBuilder ...
        v-if="condition">
    </DxFilterBuilder>
</template>

<script>
import DxFilterBuilder from 'devextreme-vue/filter-builder';

export default {
    components: {
        DxFilterBuilder
    }
}
</script>
React

Use conditional rendering instead of this method:

App.js
import React from 'react';

import FilterBuilder from 'devextreme-react/filter-builder';

function DxFilterBuilder(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <FilterBuilder ... >    
        </FilterBuilder>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxFilterBuilder shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

See Also

focus()

Sets focus on the UI component.

See Also

getFilterExpression()

Gets a filter expression that contains only operations supported by the DataSource.

Return Value:

Filter Expression

A DataSource-compatible filter expression.

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the FilterBuilder instance found in an element with the myFilterBuilder ID:

// Modular approach
import FilterBuilder from "devextreme/ui/filter_builder";
...
let element = document.getElementById("myFilterBuilder");
let instance = FilterBuilder.getInstance(element) as FilterBuilder;

// Non-modular approach
let element = document.getElementById("myFilterBuilder");
let instance = DevExpress.ui.dxFilterBuilder.getInstance(element);
See Also

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

FilterBuilder

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

FilterBuilder

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FilterBuilder

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

FilterBuilder

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

FilterBuilder

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Return Value:

Object

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

registerKeyHandler(key, handler)

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

Parameters:
key:

String

A key.

handler:

Function

A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.

The key argument accepts one of the following values:

  • "backspace"
  • "tab"
  • "enter"
  • "escape"
  • "pageUp"
  • "pageDown"
  • "end"
  • "home"
  • "leftArrow"
  • "upArrow"
  • "rightArrow"
  • "downArrow"
  • "del"
  • "space"
  • "F"
  • "A"
  • "asterisk"
  • "minus"

A custom handler for a key cancels the default handler for this key.

See Also

repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

The repaint() method re-initializes the component with new settings, resetting its state and history.

View on GitHub

See Also

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also