igniteui-webcomponents-grids 4.8.0 → 4.8.1-beta.0

package/grids/index.d.ts

@@ -20,6 +20,7 @@ export * from './lib/igc-active-node-change-event-args'
 export * from './lib/igc-base-date-time-filtering-operand'
 export * from './lib/igc-base-event-args'
 export * from './lib/igc-base-exporter'
+export * from './lib/igc-base-search-info'
 export * from './lib/igc-base-toolbar-column-actions-directive'
 export * from './lib/igc-base-toolbar-directive'
 export * from './lib/igc-boolean-filtering-operand'
@@ -169,6 +170,7 @@ export * from './lib/igc-row-selector-template-details'
 export * from './lib/igc-row-toggle-event-args'
 export * from './lib/igc-row-type'
 export * from './lib/igc-scroll-strategy'
+export * from './lib/igc-search-info'
 export * from './lib/igc-size'
 export * from './lib/igc-sorting-event-args'
 export * from './lib/igc-sorting-expression'

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

@@ -4,6 +4,11 @@
 
 
 /* mustCoerceToInt */
+/**
+ * Enumeration representing the possible positions for pinning columns.
+ * - Start: Columns are pinned to the start of the grid.
+ * - End: Columns are pinned to the end of the grid.
+ */
 
     export declare enum ColumnPinningPosition
     {

package/grids/lib/grid-paging-mode.d.ts

@@ -4,6 +4,11 @@
 
 
 /* mustCoerceToInt */
+/**
+ * Enumeration representing different paging modes for the grid.
+ * - Local: The grid will use local data to extract pages during paging.
+ * - Remote: The grid will expect pages to be delivered from a remote location and will only raise events during paging interactions.
+ */
 
     export declare enum GridPagingMode
     {

package/grids/lib/igc-active-node-change-event-args.d.ts

@@ -5,20 +5,31 @@ import { GridKeydownTargetType } from './grid-keydown-target-type';
 
 
 
+/** Emitted when the active node is changed */
 
     export declare class IgcActiveNodeChangeEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the row index of the active node */
     public row: number;
 
         
+    /** Represents the column index of the active node */
     public column: number;
 
         
+    /**
+     * Optional
+     * Represents the hierarchical level of the active node
+     */
     public level?: number;
 
         
+    /**
+     * Represents the type of the active node.
+     * The GridKeydownTargetType is an enum or that specifies the possible target types
+     */
     public tag: GridKeydownTargetType;
 
     }

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

@@ -0,0 +1,34 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcBaseSearchInfo
+    {
+
+          
+    public set searchText(value: string);
+          public get searchText(): string;
+  
+          
+    public set caseSensitive(value: boolean);
+          public get caseSensitive(): boolean;
+  
+          
+    public set exactMatch(value: boolean);
+          public get exactMatch(): boolean;
+  
+          
+    public set matchCount(value: number);
+          public get matchCount(): number;
+  
+          
+    public set content(value: string);
+          public get content(): string;
+  
+    }
+
+
+        

package/grids/lib/igc-cell-position.d.ts

@@ -4,17 +4,23 @@
 /* jsonAPIPlainObject */
 
 
+/** The event is triggered when getting the current position of a certain cell */
 
     export declare class IgcCellPosition
     {
 
           
     /* doNotStringify */
+    /** It returns the position (index) of the row, the cell is in */
     public set rowIndex(value: number);
           public get rowIndex(): number;
   
           
     /* doNotStringify */
+    /**
+     * It returns the position (index) of the column, the cell is in
+     * Counts only the visible (non hidden) columns
+     */
     public set visibleColumnIndex(value: number);
           public get visibleColumnIndex(): number;
   

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

@@ -10,76 +10,105 @@ import { IgcGridValidationState } from './igc-grid-validation-state';
 
 /* marshalByValue */
 /* jsonAPIComplexObject */
+/**
+ * Interface representing a cell in the grid. It is essentially the blueprint to a cell object.
+ * Contains definitions of properties and methods, relevant to a cell
+ */
 
     export declare class IgcCellType
     {
 
           
+    /** The current value of the cell. */
     public set value(value: any);
           public get value(): any;
   
           
+    /** The value to display when the cell is in edit mode. */
     public set editValue(value: any);
           public get editValue(): any;
   
           
+    /** Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is. */
     public set selected(value: boolean);
           public get selected(): boolean;
   
           
+    /** Indicates whether the cell is currently active (focused). */
     public set active(value: boolean);
           public get active(): boolean;
   
           
+    /** Indicates whether the cell can be edited. */
     public set editable(value: boolean);
           public get editable(): boolean;
   
           
+    /** Indicates whether the cell is currently in edit mode. */
     public set editMode(value: boolean);
           public get editMode(): boolean;
   
           
+    /** Represents the column that the cell belongs to. */
     public set column(value: IgcColumnComponent);
           public get column(): IgcColumnComponent;
   
           
     /* blazorCSSuppress */
+    /** Represents the row that the cell belongs to */
     public set row(value: IgcRowType);
           public get row(): IgcRowType;
   
           
+    /** Represents the grid instance containing the cell */
     public set grid(value: IgcGridBaseDirective);
           public get grid(): IgcGridBaseDirective;
   
           
+    /** Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell. */
     public id?: { rowID: any; columnID: number; rowIndex: number; };
   
           
+    /** Optional; The `cellID` is the unique key, used to identify the cell */
     public cellID?: any;
   
           
+    /**
+     * Optional; An object representing the validation state of the cell.
+     * Whether it's valid or invalid, and if it has errors
+     */
     public validation?: IgcGridValidationState;
   
           
     public readonly?: boolean;
   
           
+    /** An optional title to display for the cell */
     public title?: any;
   
           
+    /** The CSS width of the cell as a string. */
     public set width(value: string);
           public get width(): string;
   
           
+    /** The index of the column that the cell belongs to. It counts only the visible (not hidden) columns */
     public visibleColumnIndex?: number;
   
             
+    /** A method definition to update the value of the cell. */
     public update(value: any): void;
 
             
+    /** A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument*/
     public setEditMode?(value: boolean): void;
 
             
+    /**
+     * Optional;
+     * A method definition to calculate the size of the cell to fit the content
+     * The method can be used to calculate the size of the cell with the longest content and resize all cells to that size
+     */
     public calculateSizeToFit?(range: any): number;
 
     }

package/grids/lib/igc-child-grid-row-component.d.ts

@@ -26,6 +26,7 @@ import { IgcRowIslandComponent } from './igc-row-island-component';
           public get data(): any;
   
           
+
     /**
      * The index of the row.
      *

package/grids/lib/igc-column-component.d.ts

@@ -265,7 +265,7 @@ import { IgcGridHeaderGroupComponent } from './igc-grid-header-group-component';
      * <igx-column [movable] = "true"></igx-column>
      * ```
      *
-     * @deprecated in version 13.1.0. Use the Grid's `moving` property instead.
+     * @deprecated Use the Grid's `moving` property instead.
      */
     public set movable(value: boolean);
           public get movable(): boolean;

package/grids/lib/igc-column-moving-end-event-args.d.ts

@@ -5,17 +5,30 @@ import { IgcColumnComponent } from './igc-column-component';
 
 
 
+/** Represents event arguments related to the end of a column moving operation in a grid */
 
     export declare class IgcColumnMovingEndEventArgs extends IgcBaseEventArgs
     {
 
         
+    /**
+     * The source of the event represents the column that is being moved.
+     * The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
+     */
     public source: IgcColumnComponent;
 
         
+    /**
+     * The target of the event represents the column, the source is being moved to.
+     * The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
+     */
     public target: IgcColumnComponent;
 
         
+    /**
+     * `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-column-moving-event-args.d.ts

@@ -5,14 +5,23 @@ import { IgcColumnComponent } from './igc-column-component';
 
 
 
+/** Represents event arguments related to a column moving operation in a grid */
 
     export declare class IgcColumnMovingEventArgs extends IgcBaseEventArgs
     {
 
         
+    /**
+     * Represents the column that is being moved.
+     * The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
+     */
     public source: IgcColumnComponent;
 
         
+    /**
+     * `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-column-moving-start-event-args.d.ts

@@ -5,11 +5,16 @@ import { IgcColumnComponent } from './igc-column-component';
 
 
 
+/** Represents event arguments related to the start of a column moving operation in a grid. */
 
     export declare class IgcColumnMovingStartEventArgs extends IgcBaseEventArgs
     {
 
         
+    /**
+     * Represents the column that is being moved.
+     * The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
+     */
     public source: IgcColumnComponent;
 
     }

package/grids/lib/igc-column-resize-event-args.d.ts

@@ -5,17 +5,21 @@ import { IgcColumnComponent } from './igc-column-component';
 
 
 
+/** The event arguments when a column is being resized */
 
     export declare class IgcColumnResizeEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the information of the column that is being resized */
     public column: IgcColumnComponent;
 
         
+    /** Represents the old width of the column before the resizing */
     public prevWidth: string;
 
         
+    /** Represents the new width, the column is being resized to */
     public newWidth: string;
 
     }

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

@@ -3,20 +3,34 @@
 
 
 
+/**
+ * The event arguments when the selection state of a column is being changed
+ * The event is cancelable
+ */
 
     export declare class IgcColumnSelectionEventArgs
     {
 
         
+    /** Represents an array of columns, that have already been selected */
     public oldSelection: string[];
 
         
+    /** Represents the newly selected columns */
     public newSelection: string[];
 
         
+    /**
+     * Represents an array of all added columns
+     * Whenever a column has been selected, the array is "refreshed" with the selected columns
+     */
     public added: string[];
 
         
+    /**
+     * Represents an array of all columns, removed from the selection
+     * Whenever a column has been deselected, the array is "refreshed" with the columns, that have been previously selected, but are no longer
+     */
     public removed: string[];
 
         

package/grids/lib/igc-column-state.d.ts

@@ -99,6 +99,19 @@ import { GridColumnDataType } from './grid-column-data-type';
     public set disableHiding(value: boolean);
           public get disableHiding(): boolean;
   
+          
+    public set disablePinning(value: boolean);
+          public get disablePinning(): boolean;
+  
+          
+    public collapsible?: boolean;
+  
+          
+    public expanded?: boolean;
+  
+          
+    public visibleWhenCollapsed?: boolean;
+  
     }
 
 

package/grids/lib/igc-column-visibility-changed-event-args.d.ts

@@ -4,16 +4,18 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
 
 
 
+/** The event arguments after a column's visibility is changed. */
 
     export declare class IgcColumnVisibilityChangedEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the column the event originated from */
     public column: any;
 
         
     /**
-     * The new hidden state that the column will have, if operation is succesfull.
+     * The new hidden state that the column will have, if operation is successful.
      * Will be `true` when hiding and `false` when showing.
      */
     public newValue: boolean;

package/grids/lib/igc-column-visibility-changing-event-args.d.ts

@@ -3,16 +3,22 @@
 
 
 
+/**
+ * The event arguments when a column's visibility is changed.
+ * The event is cancelable
+ * It contains information about the column and the it's visibility after the operation (will be `true` when hiding and `false` when showing)
+ */
 
     export declare class IgcColumnVisibilityChangingEventArgs
     {
 
         
+    /** Represents the column the event originated from */
     public column: any;
 
         
     /**
-     * The new hidden state that the column will have, if operation is succesfull.
+     * The new hidden state that the column will have, if operation is successful.
      * Will be `true` when hiding and `false` when showing.
      */
     public newValue: boolean;

package/grids/lib/igc-display-density-base.d.ts

@@ -28,6 +28,9 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      * ```typescript
      * let componentTheme = this.component.displayDensity;
      * ```
+     *
+     * @deprecated Please use the `--ig-size` CSS custom property.
+     * @see {@link [Update Guide](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general/update-guide#from-160x-to-161x)}
      */
     public set displayDensity(value: DisplayDensity);
           public get displayDensity(): DisplayDensity;

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

@@ -4,11 +4,19 @@ import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
 
 
 
+/**
+ * Represents event arguments related to filtering operations
+ * The event is cancelable
+ */
 
     export declare class IgcFilteringEventArgs
     {
 
         
+    /**
+     * Represents the filtering expressions applied to the grid.
+     * The expression contains information like filtering operands and operator, an expression or condition, etc.
+     */
     public filteringExpressions: IgcFilteringExpressionsTree;
 
         

package/grids/lib/igc-grid-base-directive.d.ts

@@ -61,6 +61,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 { IgcForOfState } from './igc-for-of-state';
 import { IgcOverlayOutletDirective } from './igc-overlay-outlet-directive';
 import { IgcGridRowComponent } from './igc-grid-row-component';
@@ -532,7 +533,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* csSuppress */
     /**
      * Gets/Sets the height.
      *
@@ -546,7 +546,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* csSuppress */
     /**
      * Gets/Sets the width of the grid.
      *
@@ -860,7 +859,7 @@ public set selectedRows(value: any[]);
   
           
 
-    /* mustSetInCodePlatforms: WebComponents;Blazor */
+    /* mustSetInCodePlatforms: WebComponents;Blazor;React */
     /**
      * Gets/Sets the sorting state.
      *
@@ -947,6 +946,13 @@ public set selectedRows(value: any[]);
   
                 
 
+    /**
+     * Represents the last search information.
+     */
+    public get lastSearchInfo(): IgcSearchInfo;
+        
+                
+
     /**
      * Returns an array of objects containing the filtered data.
      *
@@ -1508,7 +1514,7 @@ public set selectedRows(value: any[]);
      * @param columnName
      * @param index
      */
-    public pinColumn(columnName: string, index?: any): boolean;
+    public pinColumn(columnName: string, index?: number): boolean;
 
             
 
@@ -1522,7 +1528,7 @@ public set selectedRows(value: any[]);
      * @param columnName
      * @param index
      */
-    public unpinColumn(columnName: string, index?: any): boolean;
+    public unpinColumn(columnName: string, index?: number): boolean;
 
             
 
@@ -1888,20 +1894,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-grid-cell-event-args.d.ts

@@ -5,15 +5,21 @@ import { IgcCellType } from './igc-cell-type';
 
 
 
+/** Represents an event argument related to grid cell interactions. */
 
     export declare class IgcGridCellEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the grid cell that triggered the event. */
     public cell: IgcCellType;
 
         
     /* blazorCSSuppress */
+    /**
+     * Represents the original event that occurred
+     * Examples of such events include: selecting, clicking, double clicking, etc.
+     */
     public event: any;
 
     }

package/grids/lib/igc-grid-clipboard-event.d.ts

@@ -4,15 +4,21 @@
 /* jsonAPIPlainObject */
 
 
+/** The event arguments when data from a grid is being copied. */
 
     export declare class IgcGridClipboardEvent
     {
 
           
+    /** `data` can be of any type and refers to the data that is being copied/stored to the clipboard */
     public set data(value: any[]);
           public get data(): any[];
   
           
+    /**
+     * `cancel` returns whether an external event has intercepted the copying
+     * If the value becomes "true", it returns/exits from the method, instantiating the interface
+     */
     public set cancel(value: boolean);
           public get cancel(): boolean;
   

package/grids/lib/igc-grid-component.d.ts

@@ -176,7 +176,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* mustSetInCodePlatforms: WebComponents;Blazor */
+    /* mustSetInCodePlatforms: WebComponents;Blazor;React */
     /**
      * Gets/Sets the group by state.
      *