JavaScript/jQuery Filter Builder - Customization

In this demo, a custom filter operation, "anyof", is implemented. The calculateFilterExpression function converts it into DataSource-compatible operations. The compatible and incompatible filter expressions are displayed under the JavaScript FilterBuilder.

The set of available group operations is limited to "and" and "or" using the groupOperations array, and the groups’ maximum nesting level is limited to one using the maxGroupLevel.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

$(() => { $('#filterBuilder').dxFilterBuilder({ fields, value: filter, maxGroupLevel: 1, groupOperations: ['and', 'or'], onValueChanged: updateTexts, onInitialized: updateTexts, customOperations: [{ name: 'anyof', caption: 'Is any of', icon: 'check', editorTemplate(conditionInfo) { return $('<div>').dxTagBox({ value: conditionInfo.value, items: categories, inputAttr: { 'aria-label': 'Category' }, onValueChanged(e) { conditionInfo.setValue(e.value && e.value.length ? e.value : null); }, width: 'auto', }); }, calculateFilterExpression(filterValue, field) { return filterValue && filterValue.length && Array.prototype.concat.apply([], filterValue.map((value) => [[field.dataField, '=', value], 'or'])).slice(0, -1); }, }], }); function updateTexts(e) { $('#filterText').text(formatValue(e.component.option('value'))); $('#dataSourceText').text(formatValue(e.component.getFilterExpression())); } function formatValue(value, spaces = TAB_SIZE) { if (value && Array.isArray(value[0])) { return `[${getLineBreak(spaces)}${value.map((item) => (Array.isArray(item[0]) ? formatValue(item, spaces + TAB_SIZE) : JSON.stringify(item))).join(`,${getLineBreak(spaces)}`)}${getLineBreak(spaces - TAB_SIZE)}]`; } return JSON.stringify(value); } function getLineBreak(spaces) { return `\r\n${new Array(spaces + 1).join(' ')}`; } });

<!DOCTYPE html> <html> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.4.4/cldr.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.4.4/cldr/event.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.4.4/cldr/supplemental.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.4.4/cldr/unresolved.min.js"></script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <script src="js/dx.all.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="data.js"></script> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="filterBuilder"></div> <div class="results"> <div> <b>Value</b> <pre id="filterText"></pre> </div> <div> <b>DataSource's filter expression</b> <pre id="dataSourceText"></pre> </div> </div> </div> </body> </html>

.results { margin-top: 50px; display: flex; justify-content: space-between; } .results > div { flex-basis: 49%; max-width: 50%; background-color: rgba(191, 191, 191, 0.15); position: relative; } .results b { position: absolute; top: -25px; } .results pre { padding: 10px 20px; height: 100%; font-size: 13px; overflow: auto; box-sizing: border-box; } .dx-tagbox { min-width: 150px; } .dx-filterbuilder { background-color: transparent; box-shadow: 0 8px 16px 0 rgba(0, 0, 0, 0.14), 0 0 2px 0 rgba(0, 0, 0, 0.12); border-radius: 6px; padding: 15px; margin: 24px; } .dx-filterbuilder .dx-numberbox { width: 80px; }