Merge pull request #12907 from IgniteUI/dpetev/grid-public-api-take-two

refactor(grids): convert groupsRecords to getter, remove filteredData setter

Author: kdinev

projects/igniteui-angular/src/lib/grids/common/grid.interface.ts

@@ -49,7 +49,7 @@ export interface IPathSegment {
 
 export interface IGridDataBindable {
     data: any[] | null;
-    filteredData: any[];
+    get filteredData(): any[];
 }
 
 export interface CellType {
@@ -565,7 +565,7 @@ export interface GridType extends IGridDataBindable {
     groupingExpressions?: IGroupingExpression[];
     groupingExpressionsChange?: EventEmitter<IGroupingExpression[]>;
     groupsExpanded?: boolean;
-    groupsRecords?: IGroupByRecord[];
+    readonly groupsRecords?: IGroupByRecord[];
     groupingFlatResult?: any[];
     groupingResult?: any[];
     groupingMetadata?: any[];

projects/igniteui-angular/src/lib/grids/grid-base.directive.ts

@@ -1766,7 +1766,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
 
             if (this.filteringService.isFilteringExpressionsTreeEmpty(this._filteringExpressionsTree) &&
                 this.filteringService.isFilteringExpressionsTreeEmpty(this._advancedFilteringExpressionsTree)) {
-                this.filteredData = null;
+                this._filteredData = null;
             }
 
             this.filteringService.refreshExpressions();
@@ -1803,7 +1803,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
 
         if (this.filteringService.isFilteringExpressionsTreeEmpty(this._filteringExpressionsTree) &&
             this.filteringService.isFilteringExpressionsTreeEmpty(this._advancedFilteringExpressionsTree)) {
-            this.filteredData = null;
+            this._filteredData = null;
         }
 
         this.selectionService.clearHeaderCBState();
@@ -3114,6 +3114,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     private _rowEditable = false;
     private _currentRowState: any;
     private _filteredSortedData = null;
+    private _filteredData = null;
 
     private _customDragIndicatorIconTemplate: TemplateRef<IgxGridEmptyTemplateContext>;
     private _excelStyleHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
@@ -3216,7 +3217,19 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
      */
     public abstract id: string;
     public abstract data: any[] | null;
-    public abstract filteredData: any[];
+
+    /**
+     * Returns an array of objects containing the filtered data.
+     *
+     * @example
+     * ```typescript
+     * let filteredData = this.grid.filteredData;
+     * ```
+     */
+    public get filteredData() {
+        return this._filteredData;
+    }
+
     /**
      * Returns an array containing the filtered sorted data.
      *
@@ -3730,11 +3743,11 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
             this._filteredPinnedData = data || [];
             const filteredUnpinned = this._filteredUnpinnedData || [];
             const filteredData = [... this._filteredPinnedData, ...filteredUnpinned];
-            this.filteredData = filteredData.length > 0 ? filteredData : this._filteredUnpinnedData;
+            this._filteredData = filteredData.length > 0 ? filteredData : this._filteredUnpinnedData;
         } else if (this.hasPinnedRecords && !pinned) {
             this._filteredUnpinnedData = data;
         } else {
-            this.filteredData = data;
+            this._filteredData = data;
         }
     }
 

projects/igniteui-angular/src/lib/grids/grid/grid.component.ts

@@ -242,6 +242,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
     @ViewChildren(IgxGridGroupByRowComponent, { read: IgxGridGroupByRowComponent })
     private _groupsRowList: QueryList<IgxGridGroupByRowComponent>;
 
+    private _groupsRecords: IGroupByRecord[] = [];
     /**
      * Gets the hierarchical representation of the group by records.
      *
@@ -250,7 +251,9 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
      * let groupRecords = this.grid.groupsRecords;
      * ```
      */
-    public groupsRecords: IGroupByRecord[] = [];
+    public get groupsRecords(): IGroupByRecord[] {
+        return this._groupsRecords;
+    }
 
     /**
      * @hidden @internal
@@ -331,23 +334,6 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
         }
     }
 
-    /**
-     * Gets/Sets an array of objects containing the filtered data.
-     *
-     * @example
-     * ```typescript
-     * let filteredData = this.grid.filteredData;
-     * this.grid.filteredData = [...];
-     * ```
-     */
-    public get filteredData() {
-        return this._filteredData;
-    }
-
-    public set filteredData(value) {
-        this._filteredData = value;
-    }
-
     /**
      * Gets/Sets the total number of records in the data source.
      *
@@ -371,7 +357,6 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
     private get _gridAPI(): IgxGridAPIService {
         return this.gridAPI as IgxGridAPIService;
     }
-    private _filteredData = null;
 
     private childDetailTemplates: Map<any, any> = new Map();
 

projects/igniteui-angular/src/lib/grids/hierarchical-grid/hierarchical-grid.component.ts

@@ -95,7 +95,7 @@ export class IgxChildGridRowComponent implements AfterViewInit, OnInit {
     @Input()
     public index: number;
 
-    @ViewChild('container', {read: ViewContainerRef, static: true}) 
+    @ViewChild('container', {read: ViewContainerRef, static: true})
     public container: ViewContainerRef;
 
     /**
@@ -337,7 +337,6 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti
     public childRow: IgxChildGridRowComponent;
 
     private _data;
-    private _filteredData = null;
     private h_id = `igx-hierarchical-grid-${NEXT_ID++}`;
     private childGridTemplates: Map<any, any> = new Map();
     private scrollTop = 0;
@@ -411,33 +410,6 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti
             super.excelStyleFilteringComponent;
     }
 
-    /**
-     * Sets an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.
-     * ```typescript
-     * this.grid.filteredData = [{
-     *       ID: 1,
-     *       Name: "A"
-     * }];
-     * ```
-     *
-     * @memberof IgxHierarchicalGridComponent
-     */
-    public set filteredData(value) {
-        this._filteredData = value;
-    }
-
-    /**
-     * Returns an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.
-     * ```typescript
-     * let filteredData = this.grid.filteredData;
-     * ```
-     *
-     * @memberof IgxHierarchicalGridComponent
-     */
-    public get filteredData() {
-        return this._filteredData;
-    }
-
     /**
      * Gets/Sets the total number of records in the data source.
      *

projects/igniteui-angular/src/lib/grids/hierarchical-grid/row-island.component.ts

@@ -144,7 +144,6 @@ export class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective
      */
     public rootGrid: GridType = null;
     public readonly data: any[] | null;
-    public readonly filteredData: any[];
 
     private ri_columnListDiffer;
     private layout_id = `igx-row-island-`;

projects/igniteui-angular/src/lib/grids/pivot-grid/pivot-grid.component.ts

@@ -547,7 +547,6 @@ export class IgxPivotGridComponent extends IgxGridBaseDirective implements OnIni
     protected override _defaultExpandState = false;
     protected override _filterStrategy: IFilteringStrategy = new DimensionValuesFilteringStrategy();
     private _data;
-    private _filteredData;
     private _pivotConfiguration: IPivotConfiguration = { rows: null, columns: null, values: null, filters: null };
     private p_id = `igx-pivot-grid-${NEXT_ID++}`;
     private _superCompactMode = false;
@@ -1089,31 +1088,6 @@ export class IgxPivotGridComponent extends IgxGridBaseDirective implements OnIni
     public get data(): any[] | null {
         return this._data;
     }
-    /**
-     * Sets an array of objects containing the filtered data.
-     * ```typescript
-     * this.grid.filteredData = [{
-     *       ID: 1,
-     *       Name: "A"
-     * }];
-     * ```
-     */
-    public set filteredData(value) {
-        this._filteredData = value;
-    }
-
-    /**
-     * Returns an array of objects containing the filtered data.
-     * ```typescript
-     * let filteredData = this.grid.filteredData;
-     * ```
-     *
-     * @memberof IgxHierarchicalGridComponent
-     */
-    public get filteredData() {
-        return this._filteredData;
-    }
-
 
     /**
      * @hidden

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

@@ -271,7 +271,6 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy
     private _data;
     private _rowLoadingIndicatorTemplate: TemplateRef<void>;
     private _expansionDepth = Infinity;
-    private _filteredData = null;
 
     /**
      * An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.
@@ -295,33 +294,6 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy
         this.cdr.markForCheck();
     }
 
-    /**
-     * Returns an array of objects containing the filtered data in the `IgxGridComponent`.
-     * ```typescript
-     * let filteredData = this.grid.filteredData;
-     * ```
-     *
-     * @memberof IgxTreeGridComponent
-     */
-    public get filteredData() {
-        return this._filteredData;
-    }
-
-    /**
-     * Sets an array of objects containing the filtered data in the `IgxGridComponent`.
-     * ```typescript
-     * this.grid.filteredData = [{
-     *       ID: 1,
-     *       Name: "A"
-     * }];
-     * ```
-     *
-     * @memberof IgxTreeGridComponent
-     */
-    public set filteredData(value) {
-        this._filteredData = value;
-    }
-
     /**
      * Get transactions service for the grid.
      *