chore(*): Apply review comments.

Author: MKirova

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

@@ -3,29 +3,55 @@ import { FilteringExpressionsTree } from '../../data-operations/filtering-expres
 import { SortingDirection } from '../../data-operations/sorting-strategy';
 import { ColumnType } from '../common/grid.interface';
 
+
+/**
+* Default pivot keys used for data processing in the pivot pipes.
+*/
 export const DEFAULT_PIVOT_KEYS = {
     aggregations: 'aggregations', records: 'records', children: 'children', level: 'level',
     rowDimensionSeparator: '_', columnDimensionSeparator: '-'
 };
 
+
+/**
+ * Event emitted when dimension collection for rows, columns of filters is changed.
+ */
 export interface IDimensionsChange {
+    /** The new list of dimensions. */
     dimensions: IPivotDimension[],
+    /** The dimension list type - Row, Column or Filter. */
     dimensionCollectionType: PivotDimensionType
 }
 
+ /**
+ * Event emitted when values list is changed.
+ */
 export interface IValuesChange {
+    /** The new list of values. */
     values: IPivotValue[]
 }
 
+ /**
+ * Interface describing Pivot data processing for dimensions.
+ * Should contain a process method and return records hierarchy based on the provided dimensions.
+ */
 export interface IPivotDimensionStrategy {
     process(collection: any,
         dimensions: IPivotDimension[],
         values: IPivotValue[],
         pivotKeys?: IPivotKeys): any[];
 }
 
+ /**
+ * Interface describing a PivotAggregation function. 
+ * Accepts an array of extracted data members and a array of the original data records.
+ */
 export type PivotAggregation = (members: any[], data: any[]) => any;
 
+ /**
+ * Interface describing a IPivotAggregator class.
+ * Used for specifying custom aggregator lists.
+ */
 export interface IPivotAggregator {
     /** Aggregation unique key. */
     key: string;
@@ -38,7 +64,7 @@ export interface IPivotAggregator {
     aggregator: (members: any[], data?: any[]) => any;
 }
 
-/**
+ /**
  * Configuration of the pivot grid.
  */
 export interface IPivotConfiguration {
@@ -54,9 +80,13 @@ export interface IPivotConfiguration {
     values: IPivotValue[] | null;
     /** Dimensions to be displayed in the filter area. */
     filters?: IPivotDimension[] | null;
+    /** Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. */
     pivotKeys?: IPivotKeys;
 }
 
+ /**
+ * Configuration of a pivot dimension.
+ */
 export interface IPivotDimension {
     /** Allows defining a hierarchy when multiple sub groups need to be extracted from single member. */
     childLevel?: IPivotDimension;
@@ -70,15 +100,24 @@ export interface IPivotDimension {
      * A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
      * */
     filter?: FilteringExpressionsTree | null;
+    /**
+     * The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.
+     */
     sortDirection?: SortingDirection;
+    /**
+     * The dataType of the related data field.
+     */
     dataType?: GridColumnDataType;
-    // The width of the dimension cells to be rendered.Can be pixel or %.
-    width? : string;
+    /** The width of the dimension cells to be rendered.Can be pixel or %. */
+    width?: string;
 }
-
+ /**
+ * Configuration of a pivot value aggregation.
+ */
 export interface IPivotValue {
+    /** Field name to use in order to extract value. */
     member: string;
-    // display name if present shows instead of member for the column header of this value
+    /** Display name to show instead of member for the column header of this value. **/
     displayName?: string;
     /**
      * Active aggregator definition with key, label and aggregator.
@@ -88,34 +127,51 @@ export interface IPivotValue {
      * List of aggregates to show in aggregate drop-down.
      */
     aggregateList?: IPivotAggregator[];
-    // Enables/Disables a particular value from pivot aggregation.
+    /** Enables/Disables a particular value from pivot aggregation. */
     enabled: boolean;
-    // Allow conditionally styling of the IgxPivotGrid cells
+    /**  Allow conditionally styling of the IgxPivotGrid cells. */
     styles?: any;
-    // Enables a data type specific template of the cells
+    /** Enables a data type specific template of the cells */
     dataType?: GridColumnDataType;
-    // Applies display format to cell values.
+    /** Applies display format to cell values. */
     formatter?: (value: any, rowData?: any) => any;
 }
 
+/** Interface describing the Pivot data keys used for data generation.
+*  Can be used for custom remote scenarios where the data is pre-populated.
+*/
 export interface IPivotKeys {
+    /** Field that stores children for hierarchy building. */
     children: string;
+    /** Field that stores reference to the original data records. */
     records: string;
+    /** Field that stores aggregation values. */
     aggregations: string;
+    /** Field that stores dimension level based on its hierarchy. */
     level: string;
+    /** Separator used when generating the unique column field values. */
     columnDimensionSeparator: string;
+    /** Separator used when generating the unique row field values. */
     rowDimensionSeparator: string;
 }
 
+/** The dimension types - Row, Column or Filter. */
 export enum PivotDimensionType {
     Row,
     Column,
     Filter
 }
 
+/** Interface describing the pivot dimension data.
+* Contains additional information needed to render dimension headers.
+*/
 export interface IPivotDimensionData {
+    /** Associated column definition. */
     column: ColumnType;
+    /** Associated dimension definition. */
     dimension: IPivotDimension;
+    /** List of previous dimension groups. */
     prevDimensions: IPivotDimension[];
+    /** Whether this a child dimension. */
     isChild?: boolean;
 }

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

@@ -61,9 +61,17 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         super(ref, cdr);
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     @ViewChildren('notifyChip')
     public notificationChips: QueryList<IgxChipComponent>;
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onDimDragStart(event, area) {
         this.cdr.detectChanges();
         for (let chip of this.notificationChips) {
@@ -76,17 +84,29 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onDimDragEnd() {
         for (let chip of this.notificationChips) {
             chip.nativeElement.hidden = true;
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public getAreaHeight(area: IgxChipsAreaComponent) {
         const chips =  area.chipsList;
         return chips && chips.length > 0 ? chips.first.nativeElement.clientHeight : 0;
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public getAggregateList(val: IPivotValue): IPivotAggregator[] {
         if (!val.aggregateList) {
             let defaultAggr = this.getAggregatorsForValue(val);
@@ -106,6 +126,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         return val.aggregateList;
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public rowRemoved(event: IBaseChipEventArgs) {
         const row = this.grid.pivotConfiguration.rows.find(x => x.memberName === event.owner.id);
         row.enabled = false;
@@ -114,6 +138,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         this.grid.dimensionsChange.emit({ dimensions: this.grid.pivotConfiguration.rows, dimensionCollectionType: PivotDimensionType.Row });
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public columnRemoved(event: IBaseChipEventArgs) {
         const col = this.grid.pivotConfiguration.columns.find(x => x.memberName === event.owner.id);
         col.enabled = false;
@@ -124,6 +152,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         this.grid.reflow();
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public valueRemoved(event: IBaseChipEventArgs) {
         const value = this.grid.pivotConfiguration.values.find(x => x.member === event.owner.id || x.displayName === event.owner.id);
         value.enabled = false;
@@ -132,6 +164,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         this.grid.valuesChange.emit({ values: this.grid.pivotConfiguration.values });
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public filterRemoved(event: IBaseChipEventArgs) {
         const filter = this.grid.pivotConfiguration.filters.find(x => x.memberName === event.owner.id);
         filter.enabled = false;
@@ -140,11 +176,19 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         this.grid.dimensionsChange.emit({ dimensions: this.grid.pivotConfiguration.filters, dimensionCollectionType: PivotDimensionType.Filter });
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onFilteringIconPointerDown(event) {
         event.stopPropagation();
         event.preventDefault();
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onFilteringIconClick(event, dimension) {
         event.stopPropagation();
         event.preventDefault();
@@ -161,6 +205,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         this.grid.filteringService.toggleFilterDropdown(event.target, col);
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onSummaryClick(eventArgs, value: IPivotValue, dropdown: IgxDropDownComponent, chip: IgxChipComponent) {
         this._subMenuOverlaySettings.target = eventArgs.currentTarget;
         if (dropdown.collapsed) {
@@ -174,17 +222,29 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onAggregationChange(event: ISelectionEventArgs) {
         if (!this.isSelected(event.newSelection.value)) {
             this.value.aggregate = event.newSelection.value;
             this.grid.pipeTrigger++;
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public isSelected(val: IPivotAggregator) {
         return this.value.aggregate.key === val.key;
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onChipSort(event, dimension: IPivotDimension, dimensionType: PivotDimensionType) {
         if (!dimension.sortDirection) {
             dimension.sortDirection = SortingDirection.None;
@@ -203,6 +263,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onDimDragOver(event, dimension?: PivotDimensionType) {
         const typeMismatch = dimension !== undefined ? this.grid.pivotConfiguration.values.find(x => x.member === event.dragChip.id
             || x.displayName === event.dragChip.id) :
@@ -226,12 +290,20 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onDimDragLeave(event) {
         event.owner.nativeElement.previousElementSibling.style.visibility = 'hidden';
         event.owner.nativeElement.nextElementSibling.style.visibility = 'hidden';
         this._dropPos = DropPosition.AfterDropTarget;
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onAreaDragLeave(event, area) {
         const dataChips = area.chipsList.toArray().filter(x => this.notificationChips.toArray().indexOf(x) === -1);
         dataChips.forEach(element => {
@@ -242,6 +314,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         });
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onValueDrop(event, area) {
         //values can only be reordered
         const currentDim = this.grid.pivotConfiguration.values;
@@ -259,6 +335,10 @@ export class IgxPivotHeaderRowComponent extends IgxGridHeaderRowComponent {
         }
     }
 
+    /**
+    * @hidden
+    * @internal
+    */
     public onDimDrop(event, area, dimension: PivotDimensionType) {
         const dragId = event.dragChip?.id || event.dragData?.chip.id;
         const currentDim = this.getDimensionsByType(dimension);

projects/igniteui-angular/src/lib/grids/watch-changes.ts

@@ -82,17 +82,15 @@ export function notifyChanges(repaint = false) {
             if (originalSetter) {
                 originalSetter.call(this, newValue);
                 if (this.grid) {
-                    const shouldRepaint = this.grid.isPivot ? false : repaint;
-                    this.grid.notifyChanges(shouldRepaint);
+                    this.grid.notifyChanges(repaint && !this.grid.isPivot);
                 }
             } else {
                 if (newValue === this[key]) {
                     return;
                 }
                 this[privateKey] = newValue;
                 if (this.grid) {
-                    const shouldRepaint = this.grid.isPivot ? false : repaint;
-                    this.grid.notifyChanges(shouldRepaint);
+                    this.grid.notifyChanges(repaint && !this.grid.isPivot);
                 }
             }
         };