Merge pull request #10077 from IgniteUI/vkombov/feat-9923-master

feat(tree-grid): adding matching records only filtering strategy

Author: kdinev

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes for each version of this project will be documented in this
 
 ## 12.2.0
 
+### New Features
+- `igxTreeGrid`
+    - Added `TreeGridMatchingRecordsOnlyFilteringStrategy`, which allows you to display only the records matching particular filtering condition without any trace for their parents.
+
+## 12.1.6
+
 ### General
 - `igxGrid`, `igxHierarchicalGrid`, `igxTreeGrid`
     - 'oddRowCSS' and 'evenRowCSS' properties has been deprecated

projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-filtering.spec.ts

@@ -7,7 +7,7 @@ import { TreeGridFunctions } from '../../test-utils/tree-grid-functions.spec';
 import { configureTestSuite } from '../../test-utils/configure-suite';
 import { IgxStringFilteringOperand, IgxNumberFilteringOperand, IgxDateFilteringOperand } from '../../data-operations/filtering-condition';
 import { FilteringStrategy } from '../../data-operations/filtering-strategy';
-import { TreeGridFormattedValuesFilteringStrategy } from './tree-grid.filtering.strategy';
+import { TreeGridFormattedValuesFilteringStrategy, TreeGridMatchingRecordsOnlyFilteringStrategy } from './tree-grid.filtering.strategy';
 import { FilterMode } from '../common/enums';
 import { GridFunctions } from '../../test-utils/grid-functions.spec';
 import { wait } from '../../test-utils/ui-interactions.spec';
@@ -484,6 +484,26 @@ describe('IgxTreeGrid - Filtering actions #tGrid', () => {
                 expect(treeGrid.rowList.length).toBe(4);
                 expect(treeGrid.filteredData.map(rec => rec.ID)).toEqual([ 847, 225, 663, 141]);
             }));
+
+            it('should display only the filtered records when using TreeGridMatchingRecordsOnlyFilteringStrategy', fakeAsync(() => {
+                expect(treeGrid.filterStrategy).toBeUndefined();
+                treeGrid.filter('Name', 'Trevor', IgxStringFilteringOperand.instance().condition('contains'), true);
+                tick(30);
+                fix.detectChanges();
+
+                expect(treeGrid.rowList.length).toBe(3);
+
+                const matchingRecordsOnlyStrategy = new TreeGridMatchingRecordsOnlyFilteringStrategy();
+                treeGrid.filterStrategy = matchingRecordsOnlyStrategy;
+                fix.detectChanges();
+
+                treeGrid.filter('Name', 'Trevor', IgxStringFilteringOperand.instance().condition('contains'), true);
+                tick(30);
+                fix.detectChanges();
+
+                expect(treeGrid.rowList.length).toBe(1);
+                expect(treeGrid.filteredData.map(rec => rec.ID)).toEqual([141]);
+            }));
     });
     class CustomTreeGridFilterStrategy  extends FilteringStrategy {
 

projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid.filtering.strategy.ts

@@ -74,3 +74,46 @@ export class TreeGridFormattedValuesFilteringStrategy extends TreeGridFilteringS
         return value;
     }
 }
+
+export class TreeGridMatchingRecordsOnlyFilteringStrategy extends TreeGridFilteringStrategy {
+    public filter(data: ITreeGridRecord[], expressionsTree: IFilteringExpressionsTree,
+        advancedExpressionsTree?: IFilteringExpressionsTree, grid?: GridType): ITreeGridRecord[] {
+        return this.filterImplementation(data, expressionsTree, advancedExpressionsTree, undefined, grid);
+    }
+
+    private filterImplementation(data: ITreeGridRecord[], expressionsTree: IFilteringExpressionsTree,
+        advancedExpressionsTree: IFilteringExpressionsTree, parent: ITreeGridRecord, grid?: GridType): ITreeGridRecord[] {
+        let i: number;
+        let rec: ITreeGridRecord;
+        const len = data.length;
+        const res: ITreeGridRecord[] = [];
+        if ((FilteringExpressionsTree.empty(expressionsTree) && FilteringExpressionsTree.empty(advancedExpressionsTree)) || !len) {
+            return data;
+        }
+        for (i = 0; i < len; i++) {
+            rec = DataUtil.cloneTreeGridRecord(data[i]);
+            rec.parent = parent;
+            if (rec.children) {
+                const filteredChildren = this.filterImplementation(rec.children, expressionsTree, advancedExpressionsTree, rec, grid);
+                rec.children = filteredChildren.length > 0 ? filteredChildren : null;
+            }
+            if (this.matchRecord(rec, expressionsTree, grid) && this.matchRecord(rec, advancedExpressionsTree, grid)) {
+                res.push(rec);
+            } else if (rec.children && rec.children.length > 0) {
+                rec = this.setCorrectLevelToFilteredRecords(rec);
+                res.push(...rec.children);
+            }
+        }
+        return res;
+    }
+
+    private setCorrectLevelToFilteredRecords(rec: ITreeGridRecord): ITreeGridRecord {
+        if (rec.children && rec.children.length > 0) {
+            rec.children.map(child => {
+                child.level = child.level - 1;
+                return this.setCorrectLevelToFilteredRecords(child);
+            });
+        }
+        return rec;
+    }
+}