igniteui-angular 22.0.0-rc.1 → 22.0.0

package/fesm2022/igniteui-angular-grids-grid.mjs

@@ -1011,7 +1011,7 @@ class IgxGridBaseDirective {
         this._loadingGridTemplate = template;
     }
     /**
-     * Get/Set IgxSummaryRow height
+     * Get/Set summary row height
      */
     set summaryRowHeight(value) {
         this._summaryRowHeight = value | 0;
@@ -1379,7 +1379,7 @@ class IgxGridBaseDirective {
         return this._resourceStrings || this._defaultResourceStrings;
     }
     /**
-     * Gets/Sets the filtering logic of the `IgxGridComponent`.
+     * Gets/Sets the filtering logic of the grid.
      *
      * @remarks
      * The default is AND.
@@ -1981,7 +1981,7 @@ class IgxGridBaseDirective {
     }
     /* csSuppress */
     /**
-     * A list of `IgxGridRowComponent`.
+     * A list of grid row.
      *
      * @example
      * ```typescript
@@ -2001,7 +2001,7 @@ class IgxGridBaseDirective {
     }
     /* csSuppress */
     /**
-     * A list of currently rendered `IgxGridRowComponent`'s.
+     * A list of currently rendered grid row's.
      *
      * @example
      * ```typescript
@@ -2267,7 +2267,7 @@ class IgxGridBaseDirective {
      *
      * @remarks
      * By default the row selection mode is 'none'
-     * Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple'
+     * Note that in grid and hierarchical grid 'multipleCascade' behaves like 'multiple'
      */
     get rowSelection() {
         return this._rowSelectionMode;
@@ -2614,7 +2614,7 @@ class IgxGridBaseDirective {
          * Emitted when a cell is clicked.
          *
          * @remarks
-         * Returns the `IgxGridCell`.
+         * Returns the grid cell.
          * @example
          * ```html
          * <igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
@@ -2625,7 +2625,7 @@ class IgxGridBaseDirective {
          * Emitted when a row is clicked.
          *
          * @remarks
-         * Returns the `IgxGridRow`.
+         * Returns the grid row.
          * @example
          * ```html
          * <igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
@@ -2654,7 +2654,7 @@ class IgxGridBaseDirective {
          * Emitted when a cell is selected.
          *
          * @remarks
-         *  Returns the `IgxGridCell`.
+         *  Returns the grid cell.
          * @example
          * ```html
          * <igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
@@ -2662,7 +2662,7 @@ class IgxGridBaseDirective {
          */
         this.selected = new EventEmitter();
         /**
-         *  Emitted when `IgxGridRowComponent` is selected.
+         *  Emitted when grid row is selected.
          *
          * @example
          * ```html
@@ -2671,7 +2671,7 @@ class IgxGridBaseDirective {
          */
         this.rowSelectionChanging = new EventEmitter();
         /**
-         *  Emitted when `IgxColumnComponent` is selected.
+         *  Emitted when column is selected.
          *
          * @example
          * ```html
@@ -2680,7 +2680,7 @@ class IgxGridBaseDirective {
          */
         this.columnSelectionChanging = new EventEmitter();
         /**
-         * Emitted before `IgxColumnComponent` is pinned.
+         * Emitted before column is pinned.
          *
          * @remarks
          * The index at which to insert the column may be changed through the `insertAtIndex` property.
@@ -2695,7 +2695,7 @@ class IgxGridBaseDirective {
          */
         this.columnPin = new EventEmitter();
         /**
-         * Emitted after `IgxColumnComponent` is pinned.
+         * Emitted after column is pinned.
          *
          * @remarks
          * The index that the column is inserted at may be changed through the `insertAtIndex` property.
@@ -2873,7 +2873,7 @@ class IgxGridBaseDirective {
          * Emitted when a row is added.
          *
          * @remarks
-         * Returns the data for the new `IgxGridRowComponent` object.
+         * Returns the data for the new grid row object.
          * @example
          * ```html
          * <igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
@@ -2920,7 +2920,7 @@ class IgxGridBaseDirective {
          * Emitted after column is resized.
          *
          * @remarks
-         * Returns the `IgxColumnComponent` object's old and new width.
+         * Returns the column object's old and new width.
          * @example
          * ```html
          * <igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
@@ -2931,7 +2931,7 @@ class IgxGridBaseDirective {
          * Emitted when a cell or row is right clicked.
          *
          * @remarks
-         * Returns the `IgxGridCell` object if the immediate context menu target is a cell or an `IgxGridRow` otherwise.
+         * Returns the grid cell object if the immediate context menu target is a cell or an grid row otherwise.
          * ```html
          * <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
          * ```
@@ -2941,7 +2941,7 @@ class IgxGridBaseDirective {
          * Emitted when a cell is double clicked.
          *
          * @remarks
-         * Returns the `IgxGridCell` object.
+         * Returns the grid cell object.
          * @example
          * ```html
          * <igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
@@ -2974,7 +2974,7 @@ class IgxGridBaseDirective {
          * Emitted when column moving starts.
          *
          * @remarks
-         * Returns the moved `IgxColumnComponent` object.
+         * Returns the moved column object.
          * @example
          * ```html
          * <igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
@@ -2985,7 +2985,7 @@ class IgxGridBaseDirective {
          * Emitted during the column moving operation.
          *
          * @remarks
-         * Returns the source and target `IgxColumnComponent` objects. This event is cancelable.
+         * Returns the source and target column objects. This event is cancelable.
          * @example
          * ```html
          * <igx-grid (columnMoving)="moving($event)"></igx-grid>
@@ -2996,7 +2996,7 @@ class IgxGridBaseDirective {
          * Emitted when column moving ends.
          *
          * @remarks
-         * Returns the source and target `IgxColumnComponent` objects.
+         * Returns the source and target column objects.
          * @example
          * ```html
          * <igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
@@ -4421,7 +4421,7 @@ class IgxGridBaseDirective {
         return this.featureColumnsWidth();
     }
     /**
-     * Gets an array of `IgxColumnComponent`s.
+     * Gets an array of columns.
      *
      * @example
      * ```typescript
@@ -4432,7 +4432,7 @@ class IgxGridBaseDirective {
         return this._columns || [];
     }
     /**
-     * Gets an array of the pinned `IgxColumnComponent`s.
+     * Gets an array of the pinned columns.
      *
      * @example
      * ```typescript
@@ -4447,7 +4447,7 @@ class IgxGridBaseDirective {
         return this._pinnedVisible;
     }
     /**
-     * Gets an array of the pinned to the left `IgxColumnComponent`s.
+     * Gets an array of the pinned to the left columns.
      *
      * @example
      * ```typescript
@@ -4458,7 +4458,7 @@ class IgxGridBaseDirective {
         return this._pinnedStartColumns.filter(col => !col.hidden);
     }
     /**
-     * Gets an array of the pinned to the right `IgxColumnComponent`s.
+     * Gets an array of the pinned to the right columns.
      *
      * @example
      * ```typescript
@@ -4470,7 +4470,7 @@ class IgxGridBaseDirective {
     }
     /* csSuppress */
     /**
-     * Gets an array of the pinned `IgxRowComponent`s.
+     * Gets an array of the pinned rows.
      *
      * @example
      * ```typescript
@@ -4481,7 +4481,7 @@ class IgxGridBaseDirective {
         return this._pinnedRowList.toArray().sort((a, b) => a.index - b.index);
     }
     /**
-     * Gets an array of unpinned `IgxColumnComponent`s.
+     * Gets an array of unpinned columns.
      *
      * @example
      * ```typescript
@@ -4496,7 +4496,7 @@ class IgxGridBaseDirective {
         return this._unpinnedVisible;
     }
     /**
-     * Gets the `width` to be set on `IgxGridHeaderGroupComponent`.
+     * Gets the `width` to be set on grid header group.
      */
     getHeaderGroupWidth(column) {
         return this.hasColumnLayouts
@@ -4504,7 +4504,7 @@ class IgxGridBaseDirective {
             : `${parseFloat(column.calcWidth)}px`;
     }
     /**
-     * Returns the `IgxColumnComponent` by field name.
+     * Returns the column by field name.
      *
      * @example
      * ```typescript
@@ -4537,7 +4537,7 @@ class IgxGridBaseDirective {
         });
     }
     /**
-     * Returns an array of visible `IgxColumnComponent`s.
+     * Returns an array of visible columns.
      *
      * @example
      * ```typescript
@@ -4684,7 +4684,7 @@ class IgxGridBaseDirective {
         this._columnsReordered(column);
     }
     /**
-     * Triggers change detection for the `IgxGridComponent`.
+     * Triggers change detection for the grid.
      * Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed.
      * May degrade performance if used when not needed, or if misused:
      * ```typescript
@@ -4715,7 +4715,7 @@ class IgxGridBaseDirective {
     }
     /* csSuppress */
     /**
-     * Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.
+     * Creates a new grid row and adds the data record to the end of the data source.
      *
      * @example
      * ```typescript
@@ -4733,7 +4733,7 @@ class IgxGridBaseDirective {
     }
     /* blazorCSSuppress */
     /**
-     * Removes the `IgxGridRowComponent` and the corresponding data record by primary key.
+     * Removes the grid row and the corresponding data record by primary key.
      *
      * @remarks
      * Requires that the `primaryKey` property is set.
@@ -4781,7 +4781,7 @@ class IgxGridBaseDirective {
     }
     /* blazorCSSuppress */
     /**
-     * Updates the `IgxGridRowComponent` and the corresponding data record by primary key.
+     * Updates the grid row and the corresponding data record by primary key.
      *
      * @remarks
      * Requires that the `primaryKey` property is set.
@@ -4819,7 +4819,7 @@ class IgxGridBaseDirective {
     }
     /* blazorCSSuppress */
     /**
-     * Updates the `IgxGridRowComponent`
+     * Updates the grid row
      *
      * @remarks
      * The row is specified by
@@ -4871,10 +4871,10 @@ class IgxGridBaseDirective {
         return index < 0 ? {} : data[index];
     }
     /**
-     * Sort a single `IgxColumnComponent`.
+     * Sort a single column.
      *
      * @remarks
-     * Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.
+     * Sort the grid's column based on the provided array of sorting expressions.
      * @example
      * ```typescript
      * this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
@@ -4912,7 +4912,7 @@ class IgxGridBaseDirective {
         requestAnimationFrame(() => this.sortingDone.emit(expression));
     }
     /**
-     * Filters a single `IgxColumnComponent`.
+     * Filters a single column.
      *
      * @example
      * ```typescript
@@ -4929,7 +4929,7 @@ class IgxGridBaseDirective {
         this.filteringService.filter(name, value, conditionOrExpressionTree, ignoreCase);
     }
     /**
-     * Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.
+     * Filters all the column in the grid with the same condition.
      *
      * @example
      * ```typescript
@@ -4990,10 +4990,10 @@ class IgxGridBaseDirective {
         }
     }
     /**
-     * If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.
+     * If name is provided, clears the filtering state of the corresponding column.
      *
      * @remarks
-     * Otherwise clears the filtering state of all `IgxColumnComponent`s.
+     * Otherwise clears the filtering state of all columns.
      * @example
      * ```typescript
      * this.grid.clearFilter();
@@ -5004,10 +5004,10 @@ class IgxGridBaseDirective {
         this.filteringService.clearFilter(name);
     }
     /**
-     * If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.
+     * If name is provided, clears the sorting state of the corresponding column.
      *
      * @remarks
-     * otherwise clears the sorting state of all `IgxColumnComponent`.
+     * otherwise clears the sorting state of all column.
      * @example
      * ```typescript
      * this.grid.clearSort();
@@ -5917,7 +5917,7 @@ class IgxGridBaseDirective {
      *
      * @remarks
      * You can pass callback function as a third parameter of `getPreviousCell` method.
-     * The callback function accepts IgxColumnComponent as a param
+     * The callback function accepts column as a param
      * @example
      * ```typescript
      *  const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
@@ -5953,7 +5953,7 @@ class IgxGridBaseDirective {
      *
      * @remarks
      * You can pass callback function as a third parameter of `getPreviousCell` method.
-     * The callback function accepts IgxColumnComponent as a param
+     * The callback function accepts column as a param
      * @example
      * ```typescript
      *  const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
@@ -8358,7 +8358,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
          * The `groupingDone` event would be raised only once if several columns get grouped at once by calling
          * the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.
          * The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain
-         * the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation.
+         * the `ISortingExpression` and the column related to the grouping/ungrouping operation.
          * Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last**
          * grouping/ungrouping operation), not all columns which are currently grouped/ungrouped.
          * columns.
@@ -8621,7 +8621,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
     /**
      * Gets/Sets the grouping strategy of the grid.
      *
-     * @remarks The default IgxGrouping extends from IgxSorting and a custom one can be used as a `sortStrategy` as well.
+     * @remarks The default grouping extends from sorting and a custom one can be used as a `sortStrategy` as well.
      *
      * @example
      * ```html
@@ -8755,7 +8755,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         this.notifyChanges();
     }
     /**
-     * Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one.
+     * Groups by a new column based on the provided expression, or modifies an existing one.
      *
      * @remarks
      * Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.
@@ -8899,7 +8899,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         return this._columns.some((col) => col.groupable && !col.columnGroup);
     }
     /**
-     * Returns whether the `IgxGridComponent` has group area.
+     * Returns whether the grid has group area.
      *
      * @example
      * ```typescript
@@ -9110,7 +9110,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         }
     }
     /**
-     * Returns the `IgxGridRow` by index.
+     * Returns the grid row by index.
      *
      * @example
      * ```typescript
@@ -9137,7 +9137,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         return row;
     }
     /**
-     * Returns `IgxGridRow` object by the specified primary key.
+     * Returns grid row object by the specified primary key.
      *
      * @remarks
      * Requires that the `primaryKey` property is set.
@@ -9168,7 +9168,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         });
     }
     /**
-     * Returns the collection of `IgxGridRow`s for current page.
+     * Returns the collection of grid rows for current page.
      *
      * @hidden @internal
      */
@@ -9176,7 +9176,7 @@ class IgxGridComponent extends IgxGridBaseDirective {
         return this.allRows().filter(row => row instanceof IgxGridRow);
     }
     /**
-     * Returns an array of the selected `IgxGridCell`s.
+     * Returns an array of the selected grid cells.
      *
      * @example
      * ```typescript