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

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-edit-done-event-args.d.ts

@@ -6,6 +6,7 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 
+/** Represents event arguments related to grid editing completion. */
 
     export declare class IgcGridEditDoneEventArgs extends IgcBaseEventArgs
     {
@@ -17,27 +18,58 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public primaryKey: any;
 
             // in a major version, remove the deprecated `rowID` and migrate to `key`
+    /** `cellID` is optional; specifies the cell the editing is being done on. */
     public cellID?: { rowID: any; columnID: any; rowIndex: number; };
 
         
+    /**
+     * `rowData` represents the updated/committed data of the row after the edit (newValue)
+     * The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled
+     */
     public rowData: any;
 
         
+    /**
+     * Represents the previous (before editing) value of the edited cell.
+     * It's used when the event has been stopped/exited.
+     */
     public oldValue: any;
 
         
+    /**
+     * Optional
+     * Represents the value, that is being entered in the edited cell
+     * When there is no `newValue` and the event has ended, the value of the cell returns to the `oldValue`
+     */
     public newValue?: any;
 
         
+    /**
+     * Optional
+     * Represents the column information of the edited cell
+     */
     public column?: IgcColumnComponent;
 
         
+    /**
+     * Optional
+     * Represents the grid instance that owns the edit event.
+     */
     public owner?: IgcGridBaseDirective;
 
         
+    /**
+     * Optional
+     * Indicates if the editing consists of adding a new row
+     */
     public isAddRow?: boolean;
 
         
+    /**
+     * Optional
+     * Indicates if the new value would be valid.
+     * It can be set to return the result of the methods for validation of the grid
+     */
     public valid?: boolean;
 
     }

package/grids/lib/igc-grid-edit-event-args.d.ts

@@ -5,6 +5,11 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 
+/**
+ * Represents event arguments related to grid editing.
+ * The event is cancelable
+ * It contains information about the row and the column, as well as the old and nwe value of the element/cell
+ */
 
     export declare class IgcGridEditEventArgs
     {
@@ -22,27 +27,58 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public primaryKey: any;
 
             // in a major version, remove the deprecated `rowID` and migrate to `key`
+    /** `cellID` is optional; specifies the cell the editing is being done on. */
     public cellID?: { rowID: any; columnID: any; rowIndex: number; };
 
         
+    /**
+     * `rowData` represents the updated/committed data of the row after the edit (newValue)
+     * The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled
+     */
     public rowData: any;
 
         
+    /**
+     * Represents the previous (before editing) value of the edited cell.
+     * It's used when the event has been stopped/exited.
+     */
     public oldValue: any;
 
         
+    /**
+     * Optional
+     * Represents the value, that is being entered in the edited cell
+     * When there is no `newValue` and the event has ended, the value of the cell returns to the `oldValue`
+     */
     public newValue?: any;
 
         
+    /**
+     * Optional
+     * Represents the column information of the edited cell
+     */
     public column?: IgcColumnComponent;
 
         
+    /**
+     * Optional
+     * Represents the grid instance that owns the edit event.
+     */
     public owner?: IgcGridBaseDirective;
 
         
+    /**
+     * Optional
+     * Indicates if the editing consists of adding a new row
+     */
     public isAddRow?: boolean;
 
         
+    /**
+     * Optional
+     * Indicates if the new value would be valid.
+     * It can be set to return the result of the methods for validation of the grid
+     */
     public valid?: boolean;
 
     }

package/grids/lib/igc-grid-form-group-created-event-args.d.ts

@@ -4,6 +4,11 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 
+/**
+ * Interface representing the event arguments when a form group is created in the grid.
+ * - formGroup: The form group that is created.
+ * - owner: The grid instance that owns the form group.
+ */
 
     export declare class IgcGridFormGroupCreatedEventArgs
     {

package/grids/lib/igc-grid-grouping-strategy.d.ts

@@ -7,12 +7,24 @@ import { IgcGroupByResult } from './igc-group-by-result';
 /* jsonAPIPlainObject */
 
 
+/**
+ * Represents a grouping strategy for the grid data, extending the Sorting Strategy interface (contains a sorting method).
+ */
 
     export declare class IgcGridGroupingStrategy extends IgcGridSortingStrategy
     {
 
             
     /* blazorCSSuppress */
+  /**
+   * The method groups the provided data based on the given grouping state and returns the result.
+   * `data`: The array of data to be grouped. Could be of any type.
+   * `state`: The grouping state that defines the grouping settings and expressions.
+   * `grid`: (Optional) The instance of the grid where the grouping is applied.
+   * `groupsRecords`: (Optional) An array that holds the records for each group.
+   * `fullResult`: (Optional) The complete result of grouping including groups and summary data.
+   * Returns an object containing the result of the grouping operation.
+   */
     public groupBy(data: any[], state: IgcGroupingState, grid?: any, groupsRecords?: any[], fullResult?: IgcGroupByResult): IgcGroupByResult;
 
     }

package/grids/lib/igc-grid-keydown-event-args.d.ts

@@ -5,21 +5,33 @@ import { GridKeydownTargetType } from './grid-keydown-target-type';
 
 
 
+/**
+ * Represents an event, emitted when keydown is triggered over element inside grid's body
+ * This event is fired only if the key combination is supported in the grid.
+ */
 
     export declare class IgcGridKeydownEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** The `targetType` represents the type of the targeted object. For example a cell or a row */
     public targetType: GridKeydownTargetType;
 
         
+    /** Represents the information and details of the object itself */
     public target: any;
 
         
     /* blazorCSSuppress */
+    /** Represents the original event, that occurred. */
     public event: any;
 
         
+    /**
+     * 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-grid-resource-strings.d.ts

@@ -271,6 +271,9 @@
     public igx_grid_excel_no_matches?: string;
   
           
+    public igx_grid_excel_matches_count?: string;
+  
+          
     public igx_grid_advanced_filter_title?: string;
   
           

package/grids/lib/igc-grid-selection-range.d.ts

@@ -6,25 +6,39 @@
 
 /* tsPlainInterface */
 /* marshalByValue */
+/**
+ * Represents a range selection between certain rows and columns of the grid.
+ * Range selection can be made either through drag selection or through keyboard selection.
+ */
 
     export declare class IgcGridSelectionRange
     {
 
           
+    /** The index of the starting row of the selection range. */
     public set rowStart(value: number);
           public get rowStart(): number;
   
           
+     /** The index of the ending row of the selection range. */
     public set rowEnd(value: number);
           public get rowEnd(): number;
   
           
     /* blazorAlternateType: double */
+    /**
+     * The identifier or index of the starting column of the selection range.
+     * It can be either a string representing the column's field name or a numeric index.
+     */
     public set columnStart(value: string);
           public get columnStart(): string;
   
           
     /* blazorAlternateType: double */
+    /**
+     * The identifier or index of the ending column of the selection range.
+     * It can be either a string representing the column's field name or a numeric index.
+     */
     public set columnEnd(value: string);
           public get columnEnd(): string;
   

package/grids/lib/igc-grid-sorting-strategy.d.ts

@@ -6,12 +6,22 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 /* jsonAPIPlainObject */
 
 
+/**
+ * Represents a sorting strategy for the grid data
+ * Contains a single method sort that sorts the provided data based on the given sorting expressions
+ */
 
     export declare class IgcGridSortingStrategy
     {
 
             
     /* blazorCSSuppress */
+   /**
+   * `data`: The array of data to be sorted. Could be of any type.
+   * `expressions`: An array of sorting expressions that define the sorting rules. The expression contains information like file name, whether the letter case should be taken into account, etc.
+   * `grid`: (Optional) The instance of the grid where the sorting is applied.
+   * Returns a new array with the data sorted according to the sorting expressions.
+   */
     public sort(data: any[], expressions: IgcSortingExpression[], grid?: IgcGridBaseDirective): any[];
 
     }

package/grids/lib/igc-grid-toolbar-export-event-args.d.ts

@@ -9,20 +9,41 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
 /* jsonAPIPlainObject */
 /*  tsPlainInterface */
+/**
+ * Represents the arguments for the grid toolbar export event.
+ * It provides information about the grid instance, exporter service, export options,
+ * and allows the event to be canceled.
+ */
 
     export declare class IgcGridToolbarExportEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** `grid` represents a reference to the instance of the grid te event originated from */
     public grid: IgcGridBaseDirective;
 
         
+    /**
+     * The `exporter` is a base service.
+     * The type (an abstract class `IgxBaseExporter`) has it's own properties and methods
+     * It is used to define the format and options of the export, the exported element
+     * and methods for preparing the data from the elements for exporting
+     */
     public exporter: IgcBaseExporter;
 
         
+    /**
+     * Represents the different settings, that can be given to an export
+     * The type (an abstract class `IgxExporterOptionsBase`) has properties for column settings
+     * (whether they should be ignored) as well as method for generating a file name
+     */
     public options: IgcExporterOptionsBase;
 
         
+    /**
+     * `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-grid-validation-state.d.ts

@@ -6,6 +6,11 @@ import { IgcValidationErrors } from './igc-validation-errors';
 /* jsonAPIPlainObject */
 
 
+/**
+ * Interface representing the validation state of a grid.
+ * - status: The validation status ('VALID' or 'INVALID').
+ * - errors: The validation errors if any.
+ */
 
     export declare class IgcGridValidationState
     {

package/grids/lib/igc-grid-validation-status-event-args.d.ts

@@ -5,6 +5,11 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 
+/**
+ * Interface representing the event arguments for the grid validation status change event.
+ * - status: The validation status ('VALID' or 'INVALID').
+ * - owner: The grid instance that owns the validation state.
+ */
 
     export declare class IgcGridValidationStatusEventArgs
     {

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

@@ -4,14 +4,19 @@ import { DisplayDensity } from './display-density';
 import { SortingDirection } from './sorting-direction';
 
 
+/* jsonAPIPlainObject */
 
 
-/* jsonAPIComplexObject */
+/**
+ * Interface representing a header cell in the grid. It is essentially the blueprint to a header cell object.
+ * Contains definitions of properties, relevant to the header
+ */
 
     export declare class IgcHeaderType
     {
 
           
+    /** The column that the header cell represents. */
     public set column(value: IgcColumnComponent);
           public get column(): IgcColumnComponent;
   
@@ -20,22 +25,27 @@ import { SortingDirection } from './sorting-direction';
           public get density(): DisplayDensity;
   
           
+    /** Indicates whether the column is currently sorted. */
     public set sorted(value: boolean);
           public get sorted(): boolean;
   
           
+    /** Indicates whether the cell can be selected */
     public set selectable(value: boolean);
           public get selectable(): boolean;
   
           
+    /** Indicates whether the cell is currently selected */
     public set selected(value: boolean);
           public get selected(): boolean;
   
           
+    /** Indicates whether the column header is a title cell. */
     public set title(value: boolean);
           public get title(): boolean;
   
           
+    /** Represents the sorting direction of the column (ascending, descending or none). */
     public set sortDirection(value: SortingDirection);
           public get sortDirection(): SortingDirection;
   

package/grids/lib/igc-noop-filtering-strategy.d.ts

@@ -0,0 +1,24 @@
+
+import { IgcBaseFilteringStrategy } from './igc-base-filtering-strategy';
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+
+
+
+
+/* csSuppress */
+
+    export declare class IgcNoopFilteringStrategy extends IgcBaseFilteringStrategy
+    {
+
+            
+
+    public static instance(): void;
+
+            
+
+    public filter(data: any[], _: IgcFilteringExpressionsTree, __?: IgcFilteringExpressionsTree): any[];
+
+    }
+
+
+        

package/grids/lib/igc-noop-sorting-strategy.d.ts

@@ -0,0 +1,27 @@
+
+
+
+
+
+/* csSuppress */
+/**
+ * Represents a class implementing the IGridSortingStrategy interface with a no-operation sorting strategy.
+ * It performs no sorting and returns the data as it is.
+ */
+
+    export declare class IgcNoopSortingStrategy
+    {
+
+            
+
+    public static instance(): IgcNoopSortingStrategy;
+
+            
+
+    /* csSuppress */
+    public sort(data: any[]): any[];
+
+    }
+
+
+        

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

@@ -146,6 +146,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     public get isLastPageDisabled(): boolean;
         
             
+
     /**
      * Goes to the next page of the `IgxPaginatorComponent`, if the paginator is not already at the last page.
      * ```typescript

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

@@ -8,7 +8,7 @@ import { IgcColumnComponent } from './igc-column-component';
  * The event arguments before a column's pin state is changed.
  * `insertAtIndex`specifies at which index in the pinned/unpinned area the column is inserted.
  * Can be changed in the `columnPin` event.
- * `isPinned` returns the actual pin state of the column. When pinning/unpinning is succesfull,
+ * `isPinned` returns the actual pin state of the column. When pinning/unpinning is successful,
  * the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
  */
 
@@ -28,7 +28,7 @@ import { IgcColumnComponent } from './igc-column-component';
         
     /**
      * Returns the actual pin state of the column.
-     * If pinning/unpinning is succesfull, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
+     * If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
      */
     public isPinned: boolean;
 

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

@@ -27,7 +27,7 @@ import { IgcColumnComponent } from './igc-column-component';
         
     /**
      * Returns the actual pin state of the column.
-     * If pinning/unpinning is succesfull, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
+     * If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
      */
     public isPinned: boolean;
 

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

@@ -6,6 +6,7 @@ import { IgcRowType } from './igc-row-type';
 
 /**
  * Event emitted when a row's pin state changes.
+ * The event is cancelable
  */
 
     export declare class IgcPinRowEventArgs

package/grids/lib/igc-pivot-configuration.d.ts

@@ -9,6 +9,7 @@ import { IgcPivotKeys } from './igc-pivot-keys';
 
 
 /* marshalByValue */
+/* tsPlainInterface */
 /**
 * Configuration of the pivot grid.
 */
@@ -25,29 +26,21 @@ import { IgcPivotKeys } from './igc-pivot-keys';
     public columnStrategy?: IgcPivotDimensionStrategy;
   
           
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: PivotDimensionCollection */
     /** A list of the rows. */
     public set rows(value: IgcPivotDimension[]);
           public get rows(): IgcPivotDimension[];
   
           
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: PivotDimensionCollection */
     /** A list of the columns. */
     public set columns(value: IgcPivotDimension[]);
           public get columns(): IgcPivotDimension[];
   
           
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: PivotValueCollection */
     /** A list of the values. */
     public set values(value: IgcPivotValue[]);
           public get values(): IgcPivotValue[];
   
           
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: PivotDimensionCollection */
     /** Dimensions to be displayed in the filter area. */
     public filters?: IgcPivotDimension[];
   

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

@@ -4,6 +4,11 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
 
 
 
+/**
+ * Represents event arguments related to events, that can occur for rows in a grid
+ * Example for events: adding, deleting, selection, transaction, etc.
+ */
+
     export declare class IgcRowDataEventArgs extends IgcBaseEventArgs
     {
 
@@ -11,6 +16,10 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     public data: any;
 
         
+    /**
+     * Represents the unique key, the row can be associated with.
+     * Available if `primaryKey` exists
+     */
     public primaryKey: any;
 
     }

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

@@ -5,17 +5,21 @@ import { IgcRowType } from './igc-row-type';
 
 
 
+/** Emitted when a dragging operation is finished (when the row is dropped) */
 
     export declare class IgcRowDragEndEventArgs extends IgcBaseEventArgs
     {
 
         
+    /** Represents the drag directive or information associated with the drag operation */
     public dragDirective: any;
 
         
+    /** Represents the information of the row that is being dragged. */
     public dragData: IgcRowType;
 
         
+    /** `animation` returns whether the event is animated */
     public animation: boolean;
 
     }

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

@@ -4,14 +4,20 @@ import { IgcRowType } from './igc-row-type';
 
 
 
+/**
+ * Emitted when a dragging operation is starting (when the row is "picked")
+ * The event is cancelable
+ */
 
     export declare class IgcRowDragStartEventArgs
     {
 
         
+    /** Represents the drag directive or information associated with the drag operation */
     public dragDirective: any;
 
         
+    /** Represents the information of the row that is being dragged. */
     public dragData: IgcRowType;