igniteui-webcomponents-grids 4.8.1-alpha.0 → 4.8.1

package/grids/lib/igc-row-island-component.d.ts

@@ -63,6 +63,7 @@ import { IgcRowDirective } from './igc-row-directive';
 import { IgcHeadSelectorTemplateContext } from './igc-head-selector-template-context';
 import { IgcRowSelectorTemplateContext } from './igc-row-selector-template-context';
 import { GridSelectionMode } from './grid-selection-mode';
+import { IgcSearchInfo } from './igc-search-info';
 import { IgcGridRowComponent } from './igc-grid-row-component';
 import { DropPosition } from './drop-position';
 import { IgcFilteringOperation } from './igc-filtering-operation';
@@ -1031,6 +1032,13 @@ public set selectedRows(value: any[]);
   
                 
 
+    /**
+     * Represents the last search information.
+     */
+    public get lastSearchInfo(): IgcSearchInfo;
+        
+                
+
     /**
      * Returns an array of objects containing the filtered data.
      *
@@ -1581,7 +1589,7 @@ public set selectedRows(value: any[]);
      * @param columnName
      * @param index
      */
-    public pinColumn(columnName: string, index?: any): boolean;
+    public pinColumn(columnName: string, index?: number): boolean;
 
             
 
@@ -1595,7 +1603,7 @@ public set selectedRows(value: any[]);
      * @param columnName
      * @param index
      */
-    public unpinColumn(columnName: string, index?: any): boolean;
+    public unpinColumn(columnName: string, index?: number): boolean;
 
             
 
@@ -1947,20 +1955,20 @@ public set selectedRows(value: any[]);
             
 
     /**
-     * Finishes the row transactions on the current row.
+     * Finishes the row transactions on the current row and returns whether the grid editing was canceled.
      *
      * @remarks
      * If `commit === true`, passes them from the pending state to the data (or transaction service)
      * @example
      * ```html
-     * <button igxButton (click)="grid.endEdit(true)">Commit Row</button>
+     * <button type="button" igxButton (click)="grid.endEdit(true)">Commit Row</button>
      * ```
      * @param commit
      */
     // TODO: Facade for crud service refactoring. To be removed
     // TODO: do not remove this, as it is used in rowEditTemplate, but mark is as internal and hidden
     /* blazorCSSuppress */
-    public endEdit(commit?: boolean, evt?: any): void;
+    public endEdit(commit?: boolean, evt?: any): boolean;
 
             
 

package/grids/lib/igc-row-selection-event-args.d.ts

@@ -3,23 +3,39 @@
 
 
 
+/**
+ * The event arguments when the selection state of a row is being changed
+ * The event is cancelable
+ */
 
     export declare class IgcRowSelectionEventArgs
     {
 
         
+    /** Represents an array of rows, that have already been selected */
     public oldSelection: any[];
 
         
+    /** Represents the newly selected rows */
     public newSelection: any[];
 
         
+    /**
+     * Represents an array of all added rows
+     * Whenever a row has been selected, the array is "refreshed" with the selected rows
+     */
     public added: any[];
 
         
+    /**
+     * Represents an array of all rows, removed from the selection
+     * Whenever a row has been deselected, the array is "refreshed" with the rows,
+     * that have been previously selected, but are no longer
+     */
     public removed: any[];
 
         
+    /** Indicates whether or not all rows of the grid have been selected */
     public allRowsSelected?: boolean;
 
         

package/grids/lib/igc-row-toggle-event-args.d.ts

@@ -4,17 +4,28 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
 
 
 
+/** Represents event arguments related to the row's expansion state being changed in a grid */
 
     export declare class IgcRowToggleEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the ID of the row that emitted the event (which state is changed) */
     public rowID: any;
 
         
+    /**
+     * Returns the state of the row after the operation has ended
+     * Indicating whether the row is being expanded (true) or collapsed (false)
+     */
     public expanded: boolean;
 
         
+    /**
+     * The event is cancelable
+     * `cancel` returns whether the event has been intercepted and stopped
+     * If the value becomes "true", it returns/exits from the method, instantiating the interface
+     */
     public cancel: boolean;
 
     }

package/grids/lib/igc-row-type.d.ts

@@ -10,11 +10,16 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 /* jsonAPIComplexObject */
 /* marshalByValue */
+/**
+ * Interface representing a row in the grid. It is essentially the blueprint to a row object.
+ * Contains definitions of properties and methods, relevant to a row
+ */
 
     export declare class IgcRowType
     {
 
           
+    /** The index of the row within the grid */
     public set index(value: number);
           public get index(): number;
   
@@ -23,6 +28,7 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
           public get viewIndex(): number;
   
           
+    /** Indicates whether the row is grouped. */
     public isGroupByRow?: boolean;
   
           
@@ -41,59 +47,128 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public data?: any;
   
           
+    /**
+     * Optional
+     * A list or an array of cells, that belong to the row
+     */
     public cells?: IgcCellType[];
   
           
+    /**
+     * Optional
+     * Indicates whether the current row is disabled
+     */
     public disabled?: boolean;
   
           
+    /**
+     * Optional
+     * Indicates whether the current row is pinned.
+     */
     public pinned?: boolean;
   
           
+    /**
+     * Optional
+     * Indicates whether the current row is selected
+     */
     public selected?: boolean;
   
           
+    /**
+     * Optional
+     * Indicates whether the current row is expanded.
+     * The value is true, if the row is expanded and false, if it is collapsed
+     */
     public expanded?: boolean;
   
           
+    /**
+     * Optional
+     * Indicates whether the row is marked for deletion.
+     */
     public deleted?: boolean;
   
           
+     /**
+     * Optional
+     * Indicates whether the row is currently being edited.
+     */
     public inEditMode?: boolean;
   
           
+    /**
+     * Optional
+     * Contains the child rows of the current row, if there are any.
+     */
     public children?: IgcRowType[];
   
           
     /* blazorAlternateName: RowParent */
+    /**
+     * Optional
+     * Contains the parent row of the current row, if it has one.
+     * If the parent row exist, it means that the current row is a child row
+     */
     public parent?: IgcRowType;
   
           
+    /**
+     * Optional
+     * Indicates whether the current row has any child rows
+     */
     public hasChildren?: boolean;
   
           
+    /**
+     * Optional
+     * Represents the hierarchical record associated with the row (for tree grids).
+     * It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc.
+     */
     public treeRow?: IgcTreeGridRecord;
   
           
     public addRowUI?: boolean;
   
           
+    /**
+     * Optional
+     * Indicates whether the row is currently focused.
+     */
     public focused?: boolean;
   
           
+    /** Represent the grid instance, the row belongs to */
     public set grid(value: IgcGridBaseDirective);
           public get grid(): IgcGridBaseDirective;
   
             
+    /**
+     * Optional
+     * A method to handle changing the value of elements of the row
+     * It takes the new value as an argument
+     */
     public update?(value: any): void;
 
             
+    /**
+     * Optional
+     * A method to handle deleting rows
+     */
     public delete?(): any;
 
             
+    /**
+     * Optional
+     * A method to handle pinning a row
+     */
     public pin?(): void;
 
             
+    /**
+     * Optional
+     * A method to handle unpinning a row, that has been pinned
+     */
     public unpin?(): void;
 
     }

package/grids/lib/igc-search-info.d.ts

@@ -0,0 +1,23 @@
+
+import { IgcBaseSearchInfo } from './igc-base-search-info';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcSearchInfo extends IgcBaseSearchInfo
+    {
+
+          
+    public set matchInfoCache(value: any[]);
+          public get matchInfoCache(): any[];
+  
+          
+    public set activeMatchIndex(value: number);
+          public get activeMatchIndex(): number;
+  
+    }
+
+
+        

package/grids/lib/igc-sorting-event-args.d.ts

@@ -5,14 +5,30 @@ import { IgcGroupingExpression } from './igc-grouping-expression';
 
 
 
+/**
+ * Represents event arguments related to sorting and grouping operations
+ * The event is cancelable
+ */
 
     export declare class IgcSortingEventArgs
     {
 
         
+    /**
+     * Optional
+     * Represents the sorting expressions applied to the grid.
+     * It can be a single sorting expression or an array of them
+     * The expression contains information like file name, whether the letter case should be taken into account, etc.
+     */
     public sortingExpressions?: IgcSortingExpression[];
 
         
+    /**
+     * Optional
+     * Represents the grouping expressions applied to the grid.
+     * It can be a single grouping expression or an array of them
+     * The expression contains information like the sorting expression and criteria by which the elements will be grouped
+     */
     public groupingExpressions?: IgcGroupingExpression[];
 
         

package/grids/lib/igc-toggle-directive.d.ts

@@ -89,7 +89,7 @@ export declare interface IgcToggleDirectiveEventMap {
 		     * ```html
 		     * <div
 		     *   igxToggle
-		     *   (onOpened)='onToggleOpened($event)'>
+		     *   (opened)='onToggleOpened($event)'>
 		     * </div>
 		     * ```
 		     */
@@ -107,7 +107,7 @@ opened: CustomEvent<IgcToggleViewEventArgs>;
 		     * ```html
 		     * <div
 		     *   igxToggle
-		     *   (onOpening)='onToggleOpening($event)'>
+		     *   (opening)='onToggleOpening($event)'>
 		     * </div>
 		     * ```
 		     */
@@ -125,7 +125,7 @@ opening: CustomEvent<IgcToggleViewCancelableEventArgs>;
 		     * ```html
 		     * <div
 		     *   igxToggle
-		     *   (onClosed)='onToggleClosed($event)'>
+		     *   (closed)='onToggleClosed($event)'>
 		     * </div>
 		     * ```
 		     */
@@ -161,7 +161,7 @@ closing: CustomEvent<IgcToggleViewCancelableEventArgs>;
 		     * ```html
 		     * <div
 		     *   igxToggle
-		     *   (onAppended)='onToggleAppended()'>
+		     *   (appended)='onToggleAppended()'>
 		     * </div>
 		     * ```
 		     */

package/grids/lib/row-pinning-position.d.ts

@@ -4,6 +4,11 @@
 
 
 /* mustCoerceToInt */
+/**
+ * Enumeration representing the possible positions for pinning rows.
+ * - Top: Rows are pinned to the top of the grid.
+ * - Bottom: Rows are pinned to the bottom of the grid.
+ */
 
     export declare enum RowPinningPosition
     {