igniteui-webcomponents-grids 4.8.1 → 5.0.0-beta.1

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

@@ -1,8 +1,8 @@
 
-import { IgcDisplayDensityBase } from './igc-display-density-base';
 import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
 import { IgcGridScrollEventArgs } from './igc-grid-scroll-event-args';
 import { IgcGridCellEventArgs } from './igc-grid-cell-event-args';
+import { IgcGridRowEventArgs } from './igc-grid-row-event-args';
 import { IgcGridFormGroupCreatedEventArgs } from './igc-grid-form-group-created-event-args';
 import { IgcGridValidationStatusEventArgs } from './igc-grid-validation-status-event-args';
 import { IgcRowSelectionEventArgs } from './igc-row-selection-event-args';
@@ -17,7 +17,9 @@ import { IgcSortingEventArgs } from './igc-sorting-event-args';
 import { IgcSortingExpression } from './igc-sorting-expression';
 import { IgcFilteringEventArgs } from './igc-filtering-event-args';
 import { IgcRowDataEventArgs } from './igc-row-data-event-args';
+import { IgcRowDataCancelableEventArgs } from './igc-row-data-cancelable-event-args';
 import { IgcColumnResizeEventArgs } from './igc-column-resize-event-args';
+import { IgcGridContextMenuEventArgs } from './igc-grid-context-menu-event-args';
 import { IgcColumnVisibilityChangingEventArgs } from './igc-column-visibility-changing-event-args';
 import { IgcColumnVisibilityChangedEventArgs } from './igc-column-visibility-changed-event-args';
 import { IgcColumnMovingStartEventArgs } from './igc-column-moving-start-event-args';
@@ -36,7 +38,7 @@ import { IgcForOfDataChangingEventArgs } from './igc-for-of-data-changing-event-
 import { IgcRenderFunction } from './common';
 import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
 import { IgcClipboardOptions } from './igc-clipboard-options';
-import { IgcActionStripComponent } from './igc-action-strip-component';
+import { IgcActionStripToken } from './igc-action-strip-token';
 import { IgcGridRowDragGhostContext } from './igc-grid-row-drag-ghost-context';
 import { IgcGridRowEditTextTemplateContext } from './igc-grid-row-edit-text-template-context';
 import { IgcGridEmptyTemplateContext } from './igc-grid-empty-template-context';
@@ -81,7 +83,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
    omitModule
    wcSkipComponentSuffix */
 
-    export declare abstract class IgcGridBaseDirective extends EventEmitterMixin<IgcGridBaseDirectiveEventMap, Constructor<IgcDisplayDensityBase>>(IgcDisplayDensityBase)
+    export declare abstract class IgcGridBaseDirective extends EventEmitterMixin<IgcGridBaseDirectiveEventMap, Constructor<LitElement>>(LitElement)
 
     {
 
@@ -252,7 +254,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* alternateType: string */
     /**
      * Gets/Sets the primary key.
      *
@@ -266,7 +267,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* contentChildren */
+    /* reactContentChildren */
     /* blazorInclude */
     /* blazorTreatAsCollection */
     /* blazorCollectionName: ColumnCollection */
@@ -283,10 +284,11 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /* blazorInclude */
     /* blazorTreatAsCollection */
     /* blazorCollectionName: ActionStripCollection */
+    /* blazorCollectionItemName: ActionStrip */
     /* ngQueryListName: actionStripComponents */
     /** @hidden @internal */
-    public set actionStripComponents(value: IgcActionStripComponent[]);
-          public get actionStripComponents(): IgcActionStripComponent[];
+    public set actionStripComponents(value: IgcActionStripToken[]);
+          public get actionStripComponents(): IgcActionStripToken[];
   
           
 
@@ -409,6 +411,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
+
     /**
      * Gets/Sets the resource strings.
      *
@@ -1024,19 +1027,18 @@ public set selectedRows(value: any[]);
      */
     public get defaultHeaderGroupMinWidth(): number;
         
-          
+                
 
     /**
      * Gets an array of `IgxColumnComponent`s.
      *
      * @example
      * ```typescript
-     * const columns = this.grid.columns.
+     * const colums = this.grid.columns.
      * ```
      */
-    public set columns(value: IgcColumnComponent[]);
-          public get columns(): IgcColumnComponent[];
-  
+    public get columns(): IgcColumnComponent[];
+        
                 
 
     /**
@@ -1763,7 +1765,6 @@ public set selectedRows(value: any[]);
 
             
 
-
     /**
      * Select specified columns.
      *
@@ -1998,6 +1999,18 @@ gridScroll: CustomEvent<IgcGridScrollEventArgs>;
 		     */
 cellClick: CustomEvent<IgcGridCellEventArgs>;
 
+        		    /**
+		     * Emitted when a row is clicked.
+		     *
+		     * @remarks
+		     * Returns the `IgxGridRow`.
+		     * @example
+		     * ```html
+		     * <igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
+		     * ```
+		     */
+rowClick: CustomEvent<IgcGridRowEventArgs>;
+
         		    /**
 		     * Emitted when formGroup is created on edit of row/cell.
 		     *
@@ -2208,7 +2221,7 @@ columnInit: CustomEvent<IgcColumnComponent>;
 
         		    /* blazorInclude */
 		    /**
-		     * @internal
+		     * @hidden @internal
 		     */
 columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
 
@@ -2291,26 +2304,26 @@ rowDeleted: CustomEvent<IgcRowDataEventArgs>;
 		     *
 		     * @remarks
 		     * This event is cancelable.
-		     * Returns an `IGridEditEventArgs` object.
+		     * Returns an IRowDataCancellableEventArgs` object.
 		     * @example
 		     * ```html
 		     * <igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
 		     * ```
 		     */
-rowDelete: CustomEvent<IgcGridEditEventArgs>;
+rowDelete: CustomEvent<IgcRowDataCancelableEventArgs>;
 
         		    /**
 		     * Emmited just before the newly added row is commited.
 		     *
 		     * @remarks
 		     * This event is cancelable.
-		     * Returns an `IGridEditEventArgs` object.
+		     * Returns an IRowDataCancellableEventArgs` object.
 		     * @example
 		     * ```html
 		     * <igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
 		     * ```
 		     */
-rowAdd: CustomEvent<IgcGridEditEventArgs>;
+rowAdd: CustomEvent<IgcRowDataCancelableEventArgs>;
 
         		    /**
 		     * Emitted after column is resized.
@@ -2325,15 +2338,15 @@ rowAdd: CustomEvent<IgcGridEditEventArgs>;
 columnResized: CustomEvent<IgcColumnResizeEventArgs>;
 
         		    /**
-		     * Emitted when a cell is right clicked.
+		     * Emitted when a cell or row is right clicked.
 		     *
 		     * @remarks
-		     * Returns the `IgxGridCell` object.
+		     * Returns the `IgxGridCell` object if the immediate context menu target is a cell or an `IgxGridRow` otherwise.
 		     * ```html
 		     * <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
 		     * ```
 		     */
-contextMenu: CustomEvent<IgcGridCellEventArgs>;
+contextMenu: CustomEvent<IgcGridContextMenuEventArgs>;
 
         		    /**
 		     * Emitted when a cell is double clicked.

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

@@ -147,7 +147,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
 
     /**
-     * Gets/Sets the array of data that populates the `IgxGridComponent`.
+     * Gets/Sets the array of data that populates the component.
      *
      * @example
      * ```html

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

@@ -0,0 +1,32 @@
+
+import { IgcCellType } from './igc-cell-type';
+import { IgcRowType } from './igc-row-type';
+
+
+
+
+/** Represents an event argument for the grid contextMenu output */
+
+    export declare class IgcGridContextMenuEventArgs
+    {
+
+        
+    /** 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;
+
+        
+    /** Represents the grid row that triggered the event. */
+    public row: IgcRowType;
+
+    }
+
+
+        

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

@@ -12,13 +12,21 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     {
 
         
+    /**
+     * @deprecated Use the `rowKey` property instead.
+     */
     public rowID: any;
 
-         // deprecated
+        
+    /**
+     * @deprecated Use the `rowKey` property instead.
+     */
     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 rowKey: any;
+
+        
     public cellID?: { rowID: any; columnID: any; rowIndex: number; };
 
         

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

@@ -5,6 +5,7 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 
+
 /**
  * Represents event arguments related to grid editing.
  * The event is cancelable
@@ -21,13 +22,21 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public cancel: boolean;
 
         
+    /**
+     * @deprecated Use the `rowKey` property instead.
+     */
     public rowID: any;
 
-         // deprecated
+        
+    /**
+     * @deprecated Use the `rowKey` property instead.
+     */
     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 rowKey: any;
+
+        
     public cellID?: { rowID: any; columnID: any; rowIndex: number; };
 
         

package/grids/lib/igc-grid-paginator-template-context.d.ts

@@ -0,0 +1,19 @@
+
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+
+
+
+
+
+    export declare class IgcGridPaginatorTemplateContext
+    {
+
+          
+    /* @wcWidgetMemberName: $implicit */
+public set implicit(value: IgcGridBaseDirective);
+          public get implicit(): IgcGridBaseDirective;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-resource-strings.d.ts

@@ -498,9 +498,6 @@
           
     public igx_grid_pattern_validation_error?: string;
   
-          
-    public igx_grid_pivot_no_aggregator?: string;
-  
     }
 
 

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

@@ -0,0 +1,27 @@
+
+import { IgcBaseEventArgs } from './igc-base-event-args';
+import { IgcRowType } from './igc-row-type';
+
+
+
+
+/** Represents an event argument related to grid row interactions. */
+
+    export declare class IgcGridRowEventArgs extends IgcBaseEventArgs
+    {
+
+        
+    /** Represents the grid row that triggered the event. */
+    public row: IgcRowType;
+
+        
+    /**
+     * Represents the original event that occurred
+     * Examples of such events include: selecting, clicking, double clicking, etc.
+     */
+    public event: any;
+
+    }
+
+
+        

package/grids/lib/igc-grid-toolbar-advanced-filtering-component.d.ts

@@ -1,5 +1,4 @@
 
-import { IgcGridBaseDirective } from './igc-grid-base-directive';
 import { IgcOverlaySettings } from './igc-overlay-settings';
 
 
@@ -28,13 +27,6 @@ import { IgcOverlaySettings } from './igc-overlay-settings';
     export declare class IgcGridToolbarAdvancedFilteringComponent extends HTMLElement
     {
 
-                
-
-    /**
-     * Returns the grid containing this component.
-     */
-    public get grid(): IgcGridBaseDirective;
-        
           
 
     public set overlaySettings(value: IgcOverlaySettings);

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

@@ -1,5 +1,4 @@
 
-import { IgcDisplayDensityBase } from './igc-display-density-base';
 import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
@@ -23,7 +22,7 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
  *
  */
 
-    export declare class IgcGridToolbarComponent extends IgcDisplayDensityBase
+    export declare class IgcGridToolbarComponent extends HTMLElement
     {
 
           
@@ -43,6 +42,8 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     /**
      * Gets/sets the grid component for the toolbar component.
      *
+     * @deprecated No longer required to be set for the Hierarchical Grid child grid template
+     *
      * @remarks
      * Usually you should not set this property in the context of the default grid/tree grid.
      * The only grids that demands this to be set are the hierarchical child grids. For additional

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

@@ -2,7 +2,6 @@
 import { IgcBaseToolbarDirective } from './igc-base-toolbar-directive';
 import { IgcExporterEventArgs } from './igc-exporter-event-args';
 import { GridToolbarExporterType } from './grid-toolbar-exporter-type';
-import { IgcToggleDirective } from './igc-toggle-directive';
 import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
 
 
@@ -54,18 +53,14 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     public set filename(value: string);
           public get filename(): string;
   
-          
-
-    /**
-     * Indicates whether there is an export in progress.
-     */
-    public set isExporting(value: boolean);
-          public get isExporting(): boolean;
-  
             
 
     /* alternateName: exportGrid */
-    public export(type: GridToolbarExporterType, toggleRef?: IgcToggleDirective): void;
+    /**
+     * Export the grid's data
+     * @param type File type to export
+     */
+    public export(type: GridToolbarExporterType): void;
 
     }
 

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

@@ -1,6 +1,5 @@
 
 import { IgcColumnComponent } from './igc-column-component';
-import { DisplayDensity } from './display-density';
 import { SortingDirection } from './sorting-direction';
 
 
@@ -21,10 +20,6 @@ import { SortingDirection } from './sorting-direction';
           public get column(): IgcColumnComponent;
   
           
-    public set density(value: DisplayDensity);
-          public get density(): DisplayDensity;
-  
-          
     /** Indicates whether the column is currently sorted. */
     public set sorted(value: boolean);
           public get sorted(): boolean;

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

@@ -79,7 +79,7 @@ import { IgcRowType } from './igc-row-type';
 
     /* treatAsRef */
     /**
-     * An @Input property that lets you fill the `IgxHierarchicalGridComponent` with an array of data.
+     * Gets/Sets the array of data that populates the component.
      * ```html
      * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true"></igx-hierarchical-grid>
      * ```
@@ -109,7 +109,7 @@ import { IgcRowType } from './igc-row-type';
 
     /**
      * Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.
-     * Defult value is false.
+     * Default value is false.
      * ```html
      * <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" [expandChildren]="true"></igx-hierarchical-grid>
      * ```

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

@@ -1,5 +1,4 @@
 
-import { IgcDisplayDensityBase } from './igc-display-density-base';
 import { IgcPageCancellableEventArgs } from './igc-page-cancellable-event-args';
 import { IgcPageEventArgs } from './igc-page-event-args';
 import { IgcOverlaySettings } from './igc-overlay-settings';
@@ -23,7 +22,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
  * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
  */
 
-    export declare class IgcPaginatorComponent extends EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<IgcDisplayDensityBase>>(IgcDisplayDensityBase)
+    export declare class IgcPaginatorComponent extends EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<LitElement>>(LitElement)
 
     {
 
@@ -38,7 +37,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * An @Input property, sets current page of the `IgxPaginatorComponent`.
+     * Gets/Sets the current page of the paginator.
      * The default is 0.
      * ```typescript
      * let page = this.paginator.page;
@@ -52,7 +51,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * An @Input property, sets number of visible items per page in the `IgxPaginatorComponent`.
+     * Gets/Sets the number of visible items per page in the paginator.
      * The default is 15.
      * ```typescript
      * let itemsPerPage = this.paginator.perPage;
@@ -66,7 +65,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * An @Input property that sets the total records.
+     * Sets the total records.
      * ```typescript
      * let totalRecords = this.paginator.totalRecords;
      * ```
@@ -79,7 +78,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * An @Input property that sets custom options in the select of the paginator
+     * Sets custom options in the select of the paginator
      * ```typescript
      * let options = this.paginator.selectOptions;
      * ```
@@ -92,7 +91,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * An @Input property that sets custom OverlaySettings.
+     * Sets custom OverlaySettings.
      * ```html
      * <igx-paginator [overlaySettings] = "customOverlaySettings"></igx-paginator>
      * ```
@@ -130,21 +129,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      */
     public get isFirstPage(): boolean;
         
-                
-
-
-    /**
-     * Returns if the first pager buttons should be disabled
-     */
-    public get isFirstPageDisabled(): boolean;
-        
-                
-
-    /**
-     * Returns if the last pager buttons should be disabled
-     */
-    public get isLastPageDisabled(): boolean;
-        
             
 
     /**

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

@@ -15,11 +15,15 @@ import { IgcRowType } from './igc-row-type';
         
     /**
      * The ID of the row, that was pinned/unpinned.
-     *   ID is either the primaryKey value or the data record instance.
+     * ID is either the primaryKey value or the data record instance.
+     * @deprecated Use the `rowKey` property instead.
      */
     public rowID: any;
 
         
+    public rowKey: any;
+
+        
     public row?: IgcRowType;
 
         

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

@@ -33,7 +33,7 @@ import { PivotAggregationType } from './pivot-aggregation-type';
   
           
 
-    /* csTreatAsEvent: AggregatorEventHandler */
+    /* blazorAlternateType: AggregatorEventHandler */
     /* blazorOnlyScript */
     /**
      * Aggregator function can be a custom implementation of `PivotAggregation`, or

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

@@ -9,7 +9,6 @@ import { IgcPivotKeys } from './igc-pivot-keys';
 
 
 /* marshalByValue */
-/* tsPlainInterface */
 /**
 * Configuration of the pivot grid.
 */

package/grids/lib/igc-pivot-data-selector-component.d.ts

@@ -114,9 +114,10 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
   
           
 
+
     /* treatAsRef */
     /**
-     * An @Input property that sets the grid.
+     * Sets the grid.
      */
     public set grid(value: IgcPivotGridComponent);
           public get grid(): IgcPivotGridComponent;

package/grids/lib/igc-pivot-date-dimension.d.ts

@@ -80,6 +80,9 @@ import { IgcPivotDateDimensionOptions } from './igc-pivot-date-dimension-options
     public set options(value: IgcPivotDateDimensionOptions);
           public get options(): IgcPivotDateDimensionOptions;
   
+          
+    public displayName: string;
+  
     constructor(inBaseDimension?: IgcPivotDimension, inOptions?: IgcPivotDateDimensionOptions);
 
     }

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

@@ -33,6 +33,10 @@ import { GridColumnDataType } from './grid-column-data-type';
     public memberFunction?: any;
   
           
+    /** Display name to show instead of the field name of this value. **/
+    public displayName?: string;
+  
+          
     /** Enables/Disables a particular dimension from pivot structure. */
     public set enabled(value: boolean);
           public get enabled(): boolean;
@@ -44,6 +48,10 @@ import { GridColumnDataType } from './grid-column-data-type';
     public filter?: IgcFilteringExpressionsTree;
   
           
+    /** Enable/disable sorting for a particular dimension. True by default. */
+    public sortable?: boolean;
+  
+          
     /**
      * The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.
      */
@@ -56,13 +64,16 @@ import { GridColumnDataType } from './grid-column-data-type';
     public dataType?: GridColumnDataType;
   
           
-    /** The width of the dimension cells to be rendered.Can be pixel or %. */
+    /** The width of the dimension cells to be rendered.Can be pixel, % or "auto". */
     public width?: string;
   
           
     /** Level of the dimension. */
     public level?: number;
   
+          
+    public horizontalSummary?: boolean;
+  
     }