Filtering in Aurelia Grid

23 Jun 202224 minutes to read

Filtering helps to view particular or related records from dataSource which meets a given filtering criteria. To enable filter, set e-allow-filtering as true.

The Grid supports three types of filter, they are

1. Filter bar
2. Menu
3. Excel

And also four types of filter menu is available in all filter types, they are

1. String
2. Numeric
3. Date
4. Boolean

The corresponding filter menu is opened based on the column type.

NOTE

1. Need to specify the e-type of column, when first record data value is empty or null otherwise the filter menu is not opened.
2. The default filter type is Filter bar, when e-allow-filtering is enabled and filterType is not set.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true>
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        }
}

The following output is displayed as a result of the above code example.

Menu filter

You can enable menu filter by setting filterType of [e-filter-settings] as menu.

There is an option to show or hide the additional filter options in the menu by setting showPredicate of [e-filter-settings] as true or false respectively.

NOTE

For filterType property you can assign either string value (“menu”) or enum value (ej.Grid.FilterType.Menu).

We can also filter a specified range of values by using the between operator for the column type number, date and datetime.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="OrderDate" e-format="{0:MM/dd/yyyy}"></ej-column>
    <ej-column e-field="Verified"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = { filterType: "menu" };
        }
}

The following output is displayed as a result of the above code example.

Numeric Filter

String Filter

Date Filter

Boolean Filter

Excel-like filter

You can enable excel menu by setting of filterType of [e-filter-settings] as excel. The excel menu contains an option such as Sorting, Clear filter, submenu for advanced filtering.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = { filterType: "excel" };
        }
}

The following output is displayed as a result of the above code example.

Checkbox list generation:

By default, the checkbox list is generated from distinct values of the filter column from dataSource which gives an option to search and select the required items.

Also on checkbox list generation, if the number of distinct values are greater than 1000, then the excel filter will display only first 1000 values to ensure the best performance on rendering and searching. However this limit has been customized according to your requirement by setting maxFilterChoices of [e-filter-settings] with required limit in integer.

NOTE

1. Using excel filter events you can change the dataSource of the checkbox list.
2. ej.Query of checkbox list can also be changed using excel filter events.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = { filterType: "excel", maxFilterChoices : 4 };
        }
}

The following output is displayed as a result of the above code example.

Add current selection to filter checkbox:

When filtering is done multiple times on the same column then the previously filtered values on the column will be cleared. So, to retain the old values Add current selection to filter checkbox can be used which is displayed when data is searched in the search bar.

The following image describes the above mentioned behavior.

Case Sensitivity

To perform filter operation with case sensitive in excel styled filter menu mode by setting enableCaseSensitivity as true.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = { filterType: "excel", enableCaseSensitivity: true };
        }
}

The following output is displayed as a result of the above code example.

Filter bar

Filter bar row is located next to column header of grid. You can filter the records with different expressions depending upon the column type. To show the filter bar row, set the filterType as filterbar.

List of Filter bar Expressions:

You can enter the below filter expressions manually in the filter bar.

>

Expression	Example	Description	Column Type
=	= value	Equal	Numeric
!=	!= value	Not equal
>	> value	Greater than
<	< value	Less than
>=	>= value	Greater than or equal
<=	<= value	Less than or equal
N/A	N/A	Always `startswith` operator will be used for string filter	String
N/A	N/A	Always `equal` operator will be used for Date filter	Date
N/A	N/A	Always `equal` operator will be used for Boolean filter	Boolean

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = { filterType: "filterbar" };
        }
}

The following output is displayed as a result of the above code example.

Filter bar modes:

This specifies the grid to start the filter action while typing in the filter bar or after pressing the enter key based on filterBarMode.There are two types of filterBarMode, they are

1. OnEnter
2. Immediate

NOTE

For filterBarMode property you can assign either string value (onenter) or enum value (ej.Grid.FilterBarMode.OnEnter).

Filter bar message:

The filter bar message is supported only for the filterType as filterbar. The filtered data with column name is displayed in the grid pager itself. By default showFilterBarStatus is true.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true e-filter-settings.bind="filterType">
    <ej-column e-field="OrderID"></ej-column>
    <ej-column e-field="EmployeeID"></ej-column>
    <ej-column e-field="CustomerID"></ej-column>
    <ej-column e-field="ShipCountry"></ej-column>
    <ej-column e-field="Freight"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterType = {showFilterBarStatus: true };
        }
}

The following output is displayed as a result of the above code example.

Filter Operators

The grid controls uses filter operators from ej.DataManager, which are used at the time of filtering.

List of Column type and Filter operators

Column Type	Filter Operators
Number	ej.FilterOperators.greaterThan
	ej.FilterOperators.greaterThanOrEqual
	ej.FilterOperators.lessThan
	ej.FilterOperators.lessThanOrEqual
	ej.FilterOperators.equal
	ej.FilterOperators.notEqual
String	ej.FilterOperators.startsWith
	ej.FilterOperators.endsWith
	ej.FilterOperators.contains
	ej.FilterOperators.equal
	ej.FilterOperators.notEqual
Boolean	ej.FilterOperators.equal
	ej.FilterOperators.notEqual
Date	ej.FilterOperators.greaterThan
	ej.FilterOperators.greaterThanOrEqual
	ej.FilterOperators.lessThan
	ej.FilterOperators.lessThanOrEqual
	ej.FilterOperators.equal
	ej.FilterOperators.notEqual

FilterBar Template

Usually enabling e-allow-filtering, will create default textbox in Grid FilterBar. So, Using [e-filter-bar-template] property of ej-column we can render any other controls like AutoComplete, DropDownList etc in filter bar to filter the grid data for the particular column.
It has three functions. They are

1. create - It is used to create the control at time of initialize.
2. read - It is used to read the Filter value selected.
3. write - It is used to render the control and assign the value selected for filtering.

The following code example describes the above behavior.

HTML

<ej-grid e-data-source.bind="data" e-allow-paging=true e-allow-filtering=true>
    <ej-column e-field="OrderID" e-header-text="Order ID" e-text-align="right" e-width="90"></ej-column>
    <ej-column e-field="CustomerID" e-header-text="CustomerID" e-text-align="left" e-width="90" e-filter-bar-template.bind="filterCustomer"></ej-column>
    <ej-column e-field="EmployeeID" e-header-text="EmployeeID" e-text-align="left" e-width="90" e-filter-bar-template.bind="filterEmployee"></ej-column>
    <ej-column e-field="Freight" e-header-text="Freight" e-text-align="left" e-format="{0:C2}" e-width="90" e-filter-bar-template.bind="filterFreight"></ej-column>
    <ej-column e-field="ShipCountry" e-header-text="Ship Country" e-text-align="left" e-width="90"></ej-column>
    <ej-column e-field="Verified" e-headertext="Verified" e-width="90"></ej-column>
</ej-grid>

JAVASCRIPT

import 'http://js.syncfusion.com/demos/web/scripts/jsondata.min.js';
export class Grid {
    
    constructor() {
        this.data = window.gridData;
        this.filterFreight = {
            write: function (args) {
                args.element.ejNumericTextbox({ width: "100%", decimalPlaces: 2, focusOut: ej.proxy(args.column.filterBarTemplate.read, this, args) });
            },
            read: function (args) {
                this.filterColumn(args.column.field, "equal", args.element.val(), "and", true)
            },
        }
        this.filterCustomer = {
            create: function (args) {
                return "<input>"
            },
            write: function (args) {
                var data = ej.DataManager(window.gridData).executeLocal(new ej.Query().select("CustomerID"));
                args.element.ejAutocomplete({ width: "100%", dataSource: data, enableDistinct: true, focusOut: ej.proxy(args.column.filterBarTemplate.read, this, args) });
            },
            read: function (args) {
                this.filterColumn(args.column.field, "equal", args.element.val(), "and", true)
            },
        }
        this.filterEmployee = {
            write: function (args) {
                var data = [{ text: "clear", value: "clear" }, { text: "1", value: 1 }, { text: "2", value: 2 }, { text: "3", value: 3 }, { text: "4", value: 4 },
                    { text: "5", value: 5 }, { text: "6", value: 6 }, { text: "7", value: 7 }, { text: "8", value: 8 }, { text: "9", value: 9 }
                ]
                args.element.ejDropDownList({ width: "100%", dataSource: data, change: ej.proxy(args.column.filterBarTemplate.read, this, args) })
            },
            read: function (args) {
                if (args.element.val() == "clear") {
                    this.clearFiltering(args.column.field);
                    args.element.val("")
                }
                this.filterColumn(args.column.field, "equal", args.element.val(), "and", true)
            },
        }
    }    
}

The following output is displayed as a result of the above code example.

After Filtering