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

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

@@ -21,7 +21,9 @@ import { IgcSortingExpression } from './igc-sorting-expression';
 import { IgcValuesChange } from './igc-values-change';
 import { IgcPivotGridValueTemplateContext } from './igc-pivot-grid-value-template-context';
 import { IgcRenderFunction } from './common';
+import { IgcColumnTemplateContext } from './igc-column-template-context';
 import { IgcPivotConfiguration } from './igc-pivot-configuration';
+import { IgcPivotUISettings } from './igc-pivot-ui-settings';
 import { PivotDimensionType } from './pivot-dimension-type';
 import { SortingDirection } from './sorting-direction';
 import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
@@ -91,12 +93,17 @@ import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
      * <igx-pivot-grid [valueChipTemplate]="myTemplate"><igx-pivot-grid>
      * ```
      */
-     public set valueChipTemplate(value: IgcRenderFunction<IgcPivotGridValueTemplateContext>);
+    public set valueChipTemplate(value: IgcRenderFunction<IgcPivotGridValueTemplateContext>);
           public get valueChipTemplate(): IgcRenderFunction<IgcPivotGridValueTemplateContext>;
   
           
 
-    /* mustSetInCodePlatforms: WebComponents;Blazor */
+    public set rowDimensionHeaderTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>);
+          public get rowDimensionHeaderTemplate(): IgcRenderFunction<IgcColumnTemplateContext>;
+  
+          
+
+    /* mustSetInCodePlatforms: WebComponents;Blazor;React */
     /* @tsTwoWayProperty (true, "PivotConfigurationChange", "Detail.PivotConfiguration", false) */
     /**
      * Gets/Sets the pivot configuration with all related dimensions and values.
@@ -113,15 +120,31 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
   
           
 
-    public set showPivotConfigurationUI(value: boolean);
-          public get showPivotConfigurationUI(): boolean;
+    /**
+     * Gets/Sets whether to auto-generate the pivot configuration based on the provided data.
+     *
+     * @remarks
+     * The default value is false. When set to true, it will override all dimensions and values in the pivotConfiguration.
+     * @example
+     * ```html
+     * <igx-pivot-grid [data]="Data" [autoGenerateConfig]="true"></igx-pivot-grid>
+     * ```
+     */
+    public set autoGenerateConfig(value: boolean);
+          public get autoGenerateConfig(): boolean;
+  
+          
+
+    public set pivotUI(value: IgcPivotUISettings);
+          public get pivotUI(): IgcPivotUISettings;
   
           
 
+
     /**
      * Enables a super compact theme for the component.
      * @remarks
-     * Overrides the displayDensity option if one is set.
+     * Overrides the grid size option if one is set.
      * @example
      * ```html
      * <igx-pivot-grid [superCompactMode]="true"></igx-pivot-grid>
@@ -145,19 +168,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
         
                 
 
-    /* csSuppress */
-    /**
-     * Gets the default row height.
-     *
-     * @example
-     * ```typescript
-     * const rowHeigh = this.grid.defaultRowHeight;
-     * ```
-     */
-    public get defaultRowHeight(): number;
-        
-                
-
     /**
      * Gets the full list of dimensions.
      *
@@ -173,7 +183,7 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
     /* treatAsRef */
     /* blazorAlternateType: object */
     /**
-     * An @Input property that lets you fill the `IgxPivotGridComponent` with an array of data.
+     * Gets/Sets the array of data that populates the component.
      * ```html
      * <igx-pivot-grid [data]="Data"></igx-pivot-grid>
      * ```

package/grids/lib/igc-pivot-grid-record.d.ts

@@ -22,6 +22,14 @@ import { IgcPivotDimension } from './igc-pivot-dimension';
     public set dimensions(value: IgcPivotDimension[]);
           public get dimensions(): IgcPivotDimension[];
   
+          
+    /** If set, it specifies the name of the dimension, that has total record enabled. */
+    public totalRecordDimensionName?: string;
+  
+          
+    /** The index of the record in the total view */
+    public dataIndex?: number;
+  
     }
 
 

package/grids/lib/igc-pivot-ui-settings.d.ts

@@ -0,0 +1,28 @@
+
+import { PivotRowLayoutType } from './pivot-row-layout-type';
+import { PivotSummaryPosition } from './pivot-summary-position';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcPivotUISettings
+    {
+
+          
+    public showConfiguration?: boolean;
+  
+          
+    public showRowHeaders?: boolean;
+  
+          
+    public rowLayout?: PivotRowLayoutType;
+  
+          
+    public horizontalSummariesPosition?: PivotSummaryPosition;
+  
+    }
+
+
+        

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

@@ -31,8 +31,6 @@ import { GridColumnDataType } from './grid-column-data-type';
           public get aggregate(): IgcPivotAggregator;
   
           
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: PivotAggregatorCollection */
     /**
      * List of aggregates to show in aggregate drop-down.
      */

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

@@ -1,6 +1,5 @@
 
-import { Point } from './common';
-                import { HorizontalAlignment } from './horizontal-alignment';
+import { HorizontalAlignment } from './horizontal-alignment';
 import { VerticalAlignment } from './vertical-alignment';
 import { IgcSize } from './igc-size';
 
@@ -13,14 +12,6 @@ import { IgcSize } from './igc-size';
     {
 
           
-    /**
-     * Attaching target for the component to show
-     *
-     * @deprecated Set the target point/element in the overlay settings instead
-     */
-    public target?: HTMLElement | Point;
-  
-          
     /** Direction in which the component should show */
     public horizontalDirection?: HorizontalAlignment;
   

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

@@ -0,0 +1,61 @@
+
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+
+
+
+
+
+    export declare class IgcRowDataCancelableEventArgs
+    {
+
+        
+    /**
+     * @deprecated 
+     */
+    public cellID?: { rowID: any; columnID: any; rowIndex: number; };
+
+        
+    /**
+     * @deprecated 
+     */
+    public oldValue: any;
+
+        
+    /**
+     * @deprecated 
+     */
+    public newValue?: any;
+
+        
+    /**
+     * @deprecated 
+     */
+    public isAddRow?: boolean;
+
+        
+    public owner: IgcGridBaseDirective;
+
+        
+    /**
+     * @deprecated Use the `rowData` property instead.
+     */
+    public data: any;
+
+        
+    public rowData: any;
+
+        
+    /**
+     * Represents the unique key, the row can be associated with.
+     * Available if `primaryKey` exists
+     * @deprecated Use the `rowKey` property instead.
+     */
+    public primaryKey: any;
+
+        
+    public rowKey: any;
+
+    }
+
+
+        

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

@@ -13,15 +13,25 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     {
 
         
+    /**
+     * @deprecated Use the `rowData` property instead.
+     */
     public data: any;
 
         
+    public rowData: any;
+
+        
     /**
      * Represents the unique key, the row can be associated with.
      * Available if `primaryKey` exists
+     * @deprecated Use the `rowKey` property instead.
      */
     public primaryKey: any;
 
+        
+    public rowKey: any;
+
     }
 
 

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

@@ -5,7 +5,6 @@ import { IgcCellType } from './igc-cell-type';
 /* jsonAPIManageCollectionInMarkup */
 
 
-/* omitModule */
 
     export declare class IgcRowDirective
     {
@@ -80,10 +79,6 @@ import { IgcCellType } from './igc-cell-type';
         
                 
 
-    public get cellHeight(): number;
-        
-                
-
     /**
      * Gets the rendered cells in the row component.
      *

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

@@ -4,6 +4,7 @@ import { IgcForOfState } from './igc-for-of-state';
 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';
@@ -18,7 +19,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,9 +39,10 @@ import { IgcGridSelectionRange } from './igc-grid-selection-range';
 import { IgcForOfDataChangingEventArgs } from './igc-for-of-data-changing-event-args';
 import { IgcGridToolbarTemplateContext } from './igc-grid-toolbar-template-context';
 import { IgcRenderFunction } from './common';
+import { IgcGridPaginatorTemplateContext } from './igc-grid-paginator-template-context';
+import { IgcActionStripToken } from './igc-action-strip-token';
 import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
 import { IgcClipboardOptions } from './igc-clipboard-options';
-import { IgcActionStripComponent } from './igc-action-strip-component';
 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';
@@ -63,7 +67,6 @@ 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';
@@ -98,6 +101,11 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     {
 
           
+
+    /* blazorInclude,wcInclude TODO: Move to Elements-only component */
+    /**
+     * Sets the key of the row island by which child data would be taken from the row data if such is provided.
+     */
     public set childDataKey(value: string);
           public get childDataKey(): string;
   
@@ -108,7 +116,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /* blazorTreatAsCollection */
     /* blazorCollectionName: RowIslandCollection */
     /**
-     * @hidden
+     * @hidden @internal
      */
     public set childLayoutList(value: IgcRowIslandComponent[]);
           public get childLayoutList(): IgcRowIslandComponent[];
@@ -129,12 +137,21 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /**
      * Sets/Gets the paginator template for each child grid created from this row island.
     */
-    public set paginatorTemplate(value: IgcRenderFunction<any>);
-          public get paginatorTemplate(): IgcRenderFunction<any>;
+    public set paginatorTemplate(value: IgcRenderFunction<IgcGridPaginatorTemplateContext>);
+          public get paginatorTemplate(): IgcRenderFunction<IgcGridPaginatorTemplateContext>;
   
           
-    public set data(value: any[]);
-          public get data(): any[];
+
+    // TODO(api-analyzer): Shouldn't need all tags to copy from base or hidden/internal due to include tag
+    /* contentChildren */
+    /* blazorInclude */
+    /* blazorTreatAsCollection */
+    /* blazorCollectionName: ActionStripCollection */
+    /* blazorCollectionItemName: ActionStrip */
+    /* ngQueryListName: actionStripComponents */
+    /** @hidden @internal */
+    public set actionStripComponents(value: IgcActionStripToken[]);
+          public get actionStripComponents(): IgcActionStripToken[];
   
           
 
@@ -354,7 +371,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* alternateType: string */
     /**
      * Gets/Sets the primary key.
      *
@@ -368,7 +384,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* contentChildren */
+    /* reactContentChildren */
     /* blazorInclude */
     /* blazorTreatAsCollection */
     /* blazorCollectionName: ColumnCollection */
@@ -381,17 +397,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
-    /* contentChildren */
-    /* blazorInclude */
-    /* blazorTreatAsCollection */
-    /* blazorCollectionName: ActionStripCollection */
-    /* ngQueryListName: actionStripComponents */
-    /** @hidden @internal */
-    public set actionStripComponents(value: IgcActionStripComponent[]);
-          public get actionStripComponents(): IgcActionStripComponent[];
-  
-          
-
 
     /**
      * Gets the custom template, if any, used for row drag ghost.
@@ -511,6 +516,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
+
     /**
      * Gets/Sets the resource strings.
      *
@@ -975,25 +981,6 @@ public set selectedRows(value: any[]);
     public set sortingExpressions(value: IgcSortingExpression[]);
           public get sortingExpressions(): IgcSortingExpression[];
   
-                
-
-    /**
-     * Gets the number of hidden columns.
-     *
-     * @example
-     * ```typescript
-     * const hiddenCol = this.grid.hiddenColumnsCount;
-     * ``
-     */
-    public get hiddenColumnsCount(): number;
-        
-                
-
-    /**
-     * Gets the number of pinned columns.
-     */
-    public get pinnedColumnsCount(): number;
-        
           
 
     /**
@@ -1032,51 +1019,6 @@ public set selectedRows(value: any[]);
   
                 
 
-    /**
-     * Represents the last search information.
-     */
-    public get lastSearchInfo(): IgcSearchInfo;
-        
-                
-
-    /**
-     * Returns an array of objects containing the filtered data.
-     *
-     * @example
-     * ```typescript
-     * let filteredData = this.grid.filteredData;
-     * ```
-     */
-    public get filteredData(): any;
-        
-                
-
-    /**
-     * Returns an array containing the filtered sorted data.
-     *
-     * @example
-     * ```typescript
-     * const filteredSortedData = this.grid1.filteredSortedData;
-     * ```
-     */
-    public get filteredSortedData(): any[];
-        
-                
-
-    /**
-     * Returns the state of the grid virtualization.
-     *
-     * @remarks
-     * Includes the start index and how many records are rendered.
-     * @example
-     * ```typescript
-     * const gridVirtState = this.grid1.virtualizationState;
-     * ```
-     */
-    public get virtualizationState(): IgcForOfState;
-        
-                
-
 
     /**
      * Gets the default row height.
@@ -1099,30 +1041,17 @@ public set selectedRows(value: any[]);
      */
     public get defaultHeaderGroupMinWidth(): number;
         
-          
-
-    /**
-     * Gets an array of `IgxColumnComponent`s.
-     *
-     * @example
-     * ```typescript
-     * const columns = this.grid.columns.
-     * ```
-     */
-    public set columns(value: IgcColumnComponent[]);
-          public get columns(): IgcColumnComponent[];
-  
                 
 
     /**
-     * Gets an array of the pinned `IgxColumnComponent`s.
+     * Gets an array of `IgxColumnComponent`s.
      *
      * @example
      * ```typescript
-     * const pinnedColumns = this.grid.pinnedColumns.
+     * const colums = this.grid.columns.
      * ```
      */
-    public get pinnedColumns(): IgcColumnComponent[];
+    public get columns(): IgcColumnComponent[];
         
                 
 
@@ -1137,30 +1066,6 @@ public set selectedRows(value: any[]);
      */
     public get pinnedRows(): IgcGridRowComponent[];
         
-                
-
-    /**
-     * Gets an array of unpinned `IgxColumnComponent`s.
-     *
-     * @example
-     * ```typescript
-     * const unpinnedColumns = this.grid.unpinnedColumns.
-     * ```
-     */
-    public get unpinnedColumns(): IgcColumnComponent[];
-        
-                
-
-    /**
-     * Returns an array of visible `IgxColumnComponent`s.
-     *
-     * @example
-     * ```typescript
-     * const visibleColumns = this.grid.visibleColumns.
-     * ```
-     */
-    public get visibleColumns(): IgcColumnComponent[];
-        
           
 
     /**
@@ -1176,18 +1081,6 @@ public set selectedRows(value: any[]);
     public set totalRecords(value: number);
           public get totalRecords(): number;
   
-                
-
-    /**
-     * Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.
-     *
-     * @example
-     * ```typescript
-     *      const dataView = this.grid.dataView;
-     * ```
-     */
-    public get dataView(): any[];
-        
           
 
     /**
@@ -1824,7 +1717,6 @@ public set selectedRows(value: any[]);
 
             
 
-
     /**
      * Select specified columns.
      *
@@ -2011,7 +1903,7 @@ public set selectedRows(value: any[]);
 export declare interface IgcRowIslandComponentEventMap {
             
         		    /**
-		     * Event emmited when a grid is being created based on this row island.
+		     * Event emitted when a grid is being created based on this row island.
 		     * ```html
 		     * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
 		     *      <igx-row-island [key]="'childData'" (gridCreated)="gridCreated($event)" #rowIsland>
@@ -2099,6 +1991,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.
 		     *
@@ -2309,7 +2213,7 @@ columnInit: CustomEvent<IgcColumnComponent>;
 
         		    /* blazorInclude */
 		    /**
-		     * @internal
+		     * @hidden @internal
 		     */
 columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
 
@@ -2392,26 +2296,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.
@@ -2426,15 +2330,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-row-toggle-event-args.d.ts

@@ -10,10 +10,16 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     {
 
         
-    /** Represents the ID of the row that emitted the event (which state is changed) */
+    /**
+     * Represents the ID of the row that emitted the event (which state is changed)
+     * @deprecated Use the `rowKey` property instead.
+     */
     public rowID: any;
 
         
+    public rowKey: any;
+
+        
     /**
      * Returns the state of the row after the operation has ended
      * Indicating whether the row is being expanded (true) or collapsed (false)

package/grids/lib/igc-sorting-options.d.ts

@@ -4,7 +4,6 @@ import { SortingOptionsMode } from './sorting-options-mode';
 
 /* jsonAPIPlainObject */
 
-// export type IColumnPipeArgs = IFieldPipeArgs
 
 
     export declare class IgcSortingOptions