Customization
Documentation
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 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.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<dx-filter-builder
[fields]="fields"
[(value)]="filter"
[groupOperations]="groupOperations"
[customOperations]="customOperations"
(onInitialized)="updateTexts($event)"
(onValueChanged)="updateTexts($event)"
>
<dx-tag-box
*dxTemplate="let condition of 'tagBoxTemplate'"
[value]="condition.value"
[items]="categories"
(onValueChanged)="condition.setValue($event.value)"
width="auto"
>
</dx-tag-box>
</dx-filter-builder>
<div class="results">
<div>
<b>Value</b>
<pre>{{ filterText }}</pre>
</div>
<div>
<b>DataSource's filter expression</b>
<pre>{{ dataSourceText }}</pre>
</div>
</div>
import {
NgModule, Component, ViewChild, enableProdMode,
} from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import {
DxListModule,
DxButtonModule,
DxTagBoxModule,
DxFilterBuilderModule,
} from 'devextreme-angular';
import { Service } from './app.service';
if (!/localhost/.test(document.location.host)) {
enableProdMode();
}
const anyOfOperation = {
name: 'anyof',
caption: 'Is any of',
icon: 'check',
editorTemplate: 'tagBoxTemplate',
calculateFilterExpression(filterValue: any, field: any) {
return filterValue && filterValue.length
&& Array.prototype.concat.apply([], filterValue.map((value) => [[field.dataField, '=', value], 'or'])).slice(0, -1);
},
};
@Component({
selector: 'demo-app',
providers: [Service],
templateUrl: 'app/app.component.html',
styleUrls: ['app/app.component.css'],
})
export class AppComponent {
filterText: any;
dataSourceText: any;
fields: Array<any>;
customOperations: Array<any>;
filter: any;
categories: string[];
groupOperations: string[] = ['and', 'or'];
constructor(service: Service) {
this.fields = service.getFields();
this.filter = service.getFilter();
this.categories = service.getCategories();
this.customOperations = [anyOfOperation];
}
updateTexts(e) {
this.filterText = AppComponent.formatValue(e.component.option('value'));
this.dataSourceText = AppComponent.formatValue(e.component.getFilterExpression());
}
private static formatValue(value, spaces = 0) {
if (value && Array.isArray(value[0])) {
const TAB_SIZE = 4;
spaces = spaces || TAB_SIZE;
return `[${AppComponent.getLineBreak(spaces)}${value.map((item) => (Array.isArray(item[0]) ? AppComponent.formatValue(item, spaces + TAB_SIZE) : JSON.stringify(item))).join(`,${AppComponent.getLineBreak(spaces)}`)}${AppComponent.getLineBreak(spaces - TAB_SIZE)}]`;
}
return JSON.stringify(value);
}
private static getLineBreak(spaces) {
return `\r\n${new Array(spaces + 1).join(' ')}`;
}
}
@NgModule({
imports: [
BrowserModule,
DxListModule,
DxButtonModule,
DxTagBoxModule,
DxFilterBuilderModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep .results {
margin-top: 50px;
display: flex;
justify-content: space-between;
}
::ng-deep .results > div {
flex-basis: 49%;
max-width: 50%;
background-color: rgba(191, 191, 191, 0.15);
position: relative;
}
::ng-deep .results b {
position: absolute;
top: -25px;
}
::ng-deep .results pre {
padding: 10px 20px;
height: 100%;
font-size: 13px;
overflow: auto;
box-sizing: border-box;
}
::ng-deep .dx-tagbox {
min-width: 150px;
}
::ng-deep .dx-filterbuilder .dx-numberbox {
width: 80px;
}
import { Injectable } from '@angular/core';
export class Product {
ID: number;
Name: string;
Price: number;
Current_Inventory: number;
Backorder: number;
Manufacturing: number;
Category: string;
ImageSrc: string;
}
const filter: Array<any> = [
['Category', 'anyof', ['Automation', 'Monitors']],
'or',
[
['Category', '=', 'Televisions'],
'and',
['Price', 'between', [2000, 4000]],
],
];
const categories: string[] = [
'Video Players',
'Televisions',
'Monitors',
'Projectors',
'Automation',
];
const fields: Array<any> = [{
dataField: 'Name',
}, {
dataField: 'Price',
dataType: 'number',
format: 'currency',
}, {
dataField: 'Current_Inventory',
dataType: 'number',
caption: 'Inventory',
}, {
dataField: 'Category',
filterOperations: ['=', 'anyof'],
lookup: {
dataSource: categories,
},
},
];
@Injectable()
export class Service {
getFields(): Array<any> {
return fields;
}
getCategories(): string[] {
return categories;
}
getFilter(): Array<any> {
return filter;
}
}
// In real applications, you should not transpile code in the browser.
// You can see how to create your own application with Angular and DevExtreme here:
// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/
window.config = {
transpiler: 'ts',
typescriptOptions: {
module: 'system',
emitDecoratorMetadata: true,
experimentalDecorators: true,
},
meta: {
'typescript': {
'exports': 'ts',
},
'devextreme/localization.js': {
'esModule': true,
},
},
paths: {
'npm:': 'https://unpkg.com/',
},
map: {
'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js',
'typescript': 'npm:typescript@4.2.4/lib/typescript.js',
'@angular/core': 'npm:@angular/core@12.2.17',
'@angular/platform-browser': 'npm:@angular/platform-browser@12.2.17',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.17',
'@angular/forms': 'npm:@angular/forms@12.2.17',
'@angular/common': 'npm:@angular/common@12.2.17',
'@angular/compiler': 'npm:@angular/compiler@12.2.17',
'tslib': 'npm:tslib@2.3.1/tslib.js',
'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js',
'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js',
'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@22.2.6/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@22.2.6/bundles/dx.all.js',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.5.20/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.1.72',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.43',
'devextreme-angular': 'npm:devextreme-angular@22.2.6',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11',
'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js',
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts',
},
'devextreme': {
defaultExtension: 'js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/events': {
main: 'index',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
'rxjs': {
defaultExtension: 'js',
},
'rxjs/operators': {
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
'npm:@devextreme/runtime@3.0.11/inferno/package.json',
'npm:@angular/*/package.json',
'npm:@angular/common@12.2.17/*/package.json',
'npm:rxjs@7.5.3/package.json',
'npm:rxjs@7.5.3/operators/package.json',
'npm:devextreme-angular@22.2.6/*/package.json',
'npm:devextreme-angular@22.2.6/ui/*/package.json',
'npm:devextreme-angular@22.2.6/package.json',
'npm:devexpress-diagram@2.1.72/package.json',
'npm:devexpress-gantt@4.1.43/package.json',
],
};
System.config(window.config);
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<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=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/22.2.6/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="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script>
<script src="https://unpkg.com/zone.js@0.13.0/dist/zone.js"></script>
<script src="https://unpkg.com/reflect-metadata@0.1.13/Reflect.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script src="config.js"></script>
<script>
System.import("app").catch(console.error.bind(console));
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<demo-app>Loading...</demo-app>
</div>
</body>
</html>