igniteui-webcomponents-grids 4.0.4 → 4.2.3-alpha

package/grids/index.d.ts

@@ -11,15 +11,18 @@ export * from './lib/grid-paging-mode'
 export * from './lib/grid-selection-mode'
 export * from './lib/grid-summary-calculation-mode'
 export * from './lib/grid-summary-position'
+export * from './lib/grid-toolbar-exporter-type'
 export * from './lib/grid-validation-trigger'
 export * from './lib/horizontal-alignment'
 export * from './lib/igc-action-strip-component'
 export * from './lib/igc-action-strip-resource-strings'
 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-toolbar-column-actions-directive'
 export * from './lib/igc-base-toolbar-directive'
+export * from './lib/igc-boolean-filtering-operand'
 export * from './lib/igc-cancelable-browser-event-args'
 export * from './lib/igc-cancelable-event-args'
 export * from './lib/igc-cell-template-context'
@@ -38,7 +41,11 @@ export * from './lib/igc-column-template-context'
 export * from './lib/igc-column-toggled-event-args'
 export * from './lib/igc-column-visibility-changed-event-args'
 export * from './lib/igc-column-visibility-changing-event-args'
+export * from './lib/igc-columns-auto-generated-event-args'
 export * from './lib/igc-data-clone-strategy'
+export * from './lib/igc-date-filtering-operand'
+export * from './lib/igc-date-summary-operand'
+export * from './lib/igc-date-time-filtering-operand'
 export * from './lib/igc-density-changed-event-args'
 export * from './lib/igc-dimensions-change'
 export * from './lib/igc-display-density-base'
@@ -46,6 +53,7 @@ export * from './lib/igc-exporter-event'
 export * from './lib/igc-exporter-options-base'
 export * from './lib/igc-field-pipe-args'
 export * from './lib/igc-filtering-event-args'
+export * from './lib/igc-filtering-expression'
 export * from './lib/igc-filtering-expressions-tree'
 export * from './lib/igc-filtering-operand'
 export * from './lib/igc-filtering-operation'
@@ -106,6 +114,8 @@ export * from './lib/igc-head-selector-template-details'
 export * from './lib/igc-header-type'
 export * from './lib/igc-mrl-column-size-info'
 export * from './lib/igc-mrl-resize-column-info'
+export * from './lib/igc-number-filtering-operand'
+export * from './lib/igc-number-summary-operand'
 export * from './lib/igc-overlay-outlet-directive'
 export * from './lib/igc-overlay-settings'
 export * from './lib/igc-page-cancellable-event-args'
@@ -145,8 +155,12 @@ export * from './lib/igc-sorting-event-args'
 export * from './lib/igc-sorting-expression'
 export * from './lib/igc-sorting-options'
 export * from './lib/igc-sorting-strategy'
+export * from './lib/igc-string-filtering-operand'
+export * from './lib/igc-summary-operand'
 export * from './lib/igc-summary-result'
 export * from './lib/igc-summary-template-context'
+export * from './lib/igc-time-filtering-operand'
+export * from './lib/igc-time-summary-operand'
 export * from './lib/igc-toggle-directive'
 export * from './lib/igc-toggle-view-cancelable-event-args'
 export * from './lib/igc-toggle-view-event-args'
@@ -158,5 +172,6 @@ export * from './lib/pivot-aggregation-type'
 export * from './lib/pivot-dimension-type'
 export * from './lib/row-pinning-position'
 export * from './lib/sorting-direction'
+export * from './lib/sorting-options-mode'
 export * from './lib/validation-status'
 export * from './lib/vertical-alignment'

package/grids/lib/common.d.ts

@@ -25,8 +25,4 @@
         public x: number;
         public y: number;
     }
-
-    export class IgcFilteringExpression {
-
-    }
     

package/grids/lib/grid-toolbar-exporter-type.d.ts

@@ -0,0 +1,3 @@
+
+          export declare type GridToolbarExporterType = "excel" | "csv";
+          

package/grids/lib/igc-base-date-time-filtering-operand.d.ts

@@ -0,0 +1,18 @@
+
+import { IgcFilteringOperand } from './igc-filtering-operand';
+
+
+
+
+/**
+ * @internal
+ * @hidden
+ */
+
+    export declare class IgcBaseDateTimeFilteringOperand extends IgcFilteringOperand
+    {
+
+    }
+
+
+        

package/grids/lib/igc-base-toolbar-column-actions-directive.d.ts

@@ -1,4 +1,5 @@
 
+import { IgcBaseToolbarDirective } from './igc-base-toolbar-directive';
 
 
 
@@ -10,7 +11,7 @@
  * Base class for pinning/hiding column actions
  */
  
-    export declare class IgcBaseToolbarColumnActionsDirective
+    export declare class IgcBaseToolbarColumnActionsDirective extends IgcBaseToolbarDirective
     {
 
     }

package/grids/lib/igc-boolean-filtering-operand.d.ts

@@ -0,0 +1,20 @@
+
+import { IgcFilteringOperand } from './igc-filtering-operand';
+
+
+
+
+/* csSuppress */
+/**
+ * Provides filtering operations for booleans
+ *
+ * @export
+ */
+
+    export declare class IgcBooleanFilteringOperand extends IgcFilteringOperand
+    {
+
+    }
+
+
+        

package/grids/lib/igc-cell-template-context.d.ts

@@ -19,7 +19,8 @@ public set implicit(value: any);
           public get additionalTemplateContext(): any;
   
           
-    public cell?: IgcCellType;
+    public set cell(value: IgcCellType);
+          public get cell(): IgcCellType;
   
     }
 

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

@@ -1,5 +1,6 @@
 
 import { IgcSummaryResult } from './igc-summary-result';
+                import { IgcSummaryOperand } from './igc-summary-operand';
                 import { GridColumnDataType } from './grid-column-data-type';
 import { IgcFilteringOperand } from './igc-filtering-operand';
 import { IgcSortingStrategy } from './igc-sorting-strategy';
@@ -496,8 +497,8 @@ import { IgcMRLResizeColumnInfo } from './igc-mrl-resize-column-info';
      *
      * @memberof IgxColumnComponent
      */
-    public set summaryFormatter(value: (summary: IgcSummaryResult, summaryOperand: any) => any);
-          public get summaryFormatter(): (summary: IgcSummaryResult, summaryOperand: any) => any;
+    public set summaryFormatter(value: (summary: IgcSummaryResult, summaryOperand: IgcSummaryOperand) => any);
+          public get summaryFormatter(): (summary: IgcSummaryResult, summaryOperand: IgcSummaryOperand) => any;
   
           
 

package/grids/lib/igc-columns-auto-generated-event-args.d.ts

@@ -0,0 +1,21 @@
+
+import { IgcBaseEventArgs } from './igc-base-event-args';
+import { IgcColumnComponent } from './igc-column-component';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcColumnsAutoGeneratedEventArgs extends IgcBaseEventArgs
+    {
+
+        
+    /* blazorTreatAsCollection */
+    /* blazorCollectionName: ColumnCollection */
+    public columns?: IgcColumnComponent[];
+
+    }
+
+
+        

package/grids/lib/igc-date-filtering-operand.d.ts

@@ -0,0 +1,20 @@
+
+import { IgcBaseDateTimeFilteringOperand } from './igc-base-date-time-filtering-operand';
+
+
+
+
+/* csSuppress */
+/**
+ * Provides filtering operations for Dates
+ *
+ * @export
+ */
+
+    export declare class IgcDateFilteringOperand extends IgcBaseDateTimeFilteringOperand
+    {
+
+    }
+
+
+        

package/grids/lib/igc-date-summary-operand.d.ts

@@ -0,0 +1,75 @@
+
+import { IgcSummaryOperand } from './igc-summary-operand';
+import { IgcGroupByRecord } from './igc-group-by-record';
+import { IgcSummaryResult } from './igc-summary-result';
+
+
+
+
+/* csSuppress */
+// @dynamic
+
+    export declare class IgcDateSummaryOperand extends IgcSummaryOperand
+    {
+
+            
+    /**
+     * Returns the latest date value in the data records.
+     * If filtering is applied, returns the latest date value in the filtered data records.
+     * ```typescript
+     * IgxDateSummaryOperand.latest(data);
+     * ```
+     *
+     * @memberof IgxDateSummaryOperand
+     */
+    public static latest(data: any[]): void;
+
+            
+    /**
+     * Returns the earliest date value in the data records.
+     * If filtering is applied, returns the latest date value in the filtered data records.
+     * ```typescript
+     * IgxDateSummaryOperand.earliest(data);
+     * ```
+     *
+     * @memberof IgxDateSummaryOperand
+     */
+    public static earliest(data: any[]): void;
+
+            
+    /**
+     * Executes the static methods and returns `IgxSummaryResult[]`.
+     * ```typescript
+     * interface IgxSummaryResult {
+     *   key: string;
+     *   label: string;
+     *   summaryResult: any;
+     * }
+     * ```
+     * Can be overridden in the inherited classes to provide customization for the `summary`.
+     * ```typescript
+     * class CustomDateSummary extends IgxDateSummaryOperand {
+     *   constructor() {
+     *     super();
+     *   }
+     *   public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] {
+     *     const result = super.operate(data, allData, fieldName, groupRecord);
+     *     result.push({
+     *       key: "deadline",
+     *       label: "Deadline Date",
+     *       summaryResult: this.calculateDeadline(data);
+     *     });
+     *     return result;
+     *   }
+     * }
+     * this.grid.getColumnByName('ColumnName').summaries = CustomDateSummary;
+     * ```
+     *
+     * @memberof IgxDateSummaryOperand
+     */
+    public operate(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
+
+    }
+
+
+        

package/grids/lib/igc-date-time-filtering-operand.d.ts

@@ -0,0 +1,15 @@
+
+import { IgcBaseDateTimeFilteringOperand } from './igc-base-date-time-filtering-operand';
+
+
+
+
+/* csSuppress */
+
+    export declare class IgcDateTimeFilteringOperand extends IgcBaseDateTimeFilteringOperand
+    {
+
+    }
+
+
+        

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

@@ -38,7 +38,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
 export declare interface IgcDisplayDensityBaseEventMap {
             
-        onDensityChanged: CustomEvent<IgcDensityChangedEventArgs>;
+        densityChanged: CustomEvent<IgcDensityChangedEventArgs>;
 
 }
         

package/grids/lib/igc-exporter-options-base.d.ts

@@ -145,6 +145,8 @@
     public set fileName(value: string);
           public get fileName(): string;
   
+    constructor(fileName: string, _fileExtension: string);
+
     }
 
 

package/grids/lib/igc-filtering-expression.d.ts

@@ -0,0 +1,33 @@
+
+import { IgcFilteringOperation } from './igc-filtering-operation';
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+/**
+ * Represents filtering expressions.
+ */
+
+    export declare class IgcFilteringExpression
+    {
+
+          
+    public set fieldName(value: string);
+          public get fieldName(): string;
+  
+          
+    public set condition(value: IgcFilteringOperation);
+          public get condition(): IgcFilteringOperation;
+  
+          
+    public searchVal?: any;
+  
+             
+    public ignoreCase?: boolean;
+  
+    }
+
+
+        

package/grids/lib/igc-filtering-expressions-tree.d.ts

@@ -1,7 +1,7 @@
 
 import { FilteringLogic } from './filtering-logic';
 import { FilteringExpressionsTreeType } from './filtering-expressions-tree-type';
-import { IgcFilteringExpression } from './common';
+import { IgcFilteringExpression } from './igc-filtering-expression';
                 
 
 
@@ -33,8 +33,8 @@ import { IgcFilteringExpression } from './common';
      *
      * @memberof FilteringExpressionsTree
      */
-    public set filteringOperands(value: IgcFilteringExpressionsTree | IgcFilteringExpression[]);
-          public get filteringOperands(): IgcFilteringExpressionsTree | IgcFilteringExpression[];
+    public set filteringOperands(value: (IgcFilteringExpressionsTree | IgcFilteringExpression)[]);
+          public get filteringOperands(): (IgcFilteringExpressionsTree | IgcFilteringExpression)[];
   
           
 
@@ -91,7 +91,7 @@ import { IgcFilteringExpression } from './common';
      *
      * @param expressionTree filtering expressions tree.
      */
-    public empty(expressionTree: IgcFilteringExpressionsTree): boolean;
+    public static empty(expressionTree: IgcFilteringExpressionsTree): boolean;
 
             
 
@@ -117,6 +117,8 @@ import { IgcFilteringExpression } from './common';
      */
     public findIndex(fieldName: string): number;
 
+    constructor(operator: FilteringLogic, fieldName?: string);
+
     }
 
 

package/grids/lib/igc-filtering-operand.d.ts

@@ -5,7 +5,7 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
 /**
  * Provides base filtering operations
  * Implementations should be Singleton
- * 
+ *
  * @export
  */
 
@@ -18,7 +18,7 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
   
             
 
-    public instance(): IgcFilteringOperand;
+    public static instance(): IgcFilteringOperand;
 
             
 
@@ -45,6 +45,8 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
      */
     public append(operation: IgcFilteringOperation): void;
 
+    constructor();
+
     }
 
 

package/grids/lib/igc-filtering-operation.d.ts

@@ -29,6 +29,10 @@
           
     public hidden?: boolean;
   
+            
+    /* csSuppress */
+    public logic(value: any, searchVal?: any, ignoreCase?: boolean): boolean;
+
     }
 
 

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

@@ -12,6 +12,7 @@ import { IgcPinColumnEventArgs } from './igc-pin-column-event-args';
 import { IgcGridEditEventArgs } from './igc-grid-edit-event-args';
 import { IgcGridEditDoneEventArgs } from './igc-grid-edit-done-event-args';
 import { IgcColumnComponent } from './igc-column-component';
+import { IgcColumnsAutoGeneratedEventArgs } from './igc-columns-auto-generated-event-args';
 import { IgcSortingEventArgs } from './igc-sorting-event-args';
 import { IgcSortingExpression } from './igc-sorting-expression';
 import { IgcFilteringEventArgs } from './igc-filtering-event-args';
@@ -76,7 +77,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
 
 
-/* blazorIndirectRender 
+/* blazorIndirectRender
    blazorComponent
    omitModule */
 
@@ -2123,6 +2124,20 @@ public set selectedRows(value: any[]);
 
             
 
+    /**
+     * Select range(s) of cells between certain rows and columns of the grid.
+     */
+    public selectRange(arg: IgcGridSelectionRange[]): void;
+
+            
+
+    /**
+     * Get the currently selected ranges in the grid.
+     */
+    public getSelectedRanges(): IgcGridSelectionRange[];
+
+            
+
     /**
      *
      * Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.
@@ -2148,7 +2163,7 @@ public set selectedRows(value: any[]);
 
             
 
-    
+
     /**
      * Select specified columns.
      *
@@ -2564,6 +2579,12 @@ rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
 		     */
 columnInit: CustomEvent<IgcColumnComponent>;
 
+        		    /* blazorInclude */
+		    /**
+		     * @internal
+		     */
+columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
+
         		    /**
 		     * Emitted before sorting expressions are applied.
 		     *

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

@@ -401,7 +401,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      *
      * @remarks
      * Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.
-     * The onGroupingDone event would get raised only **once** if this method gets called multiple times with the same arguments.
+     * The `groupingDone` event would get raised only **once** if this method gets called multiple times with the same arguments.
      * @example
      * ```typescript
      * this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
@@ -605,7 +605,7 @@ dataPreLoad: CustomEvent<IgcForOfState>;
 		     * Emitted when columns are grouped/ungrouped.
 		     *
 		     * @remarks
-		     * The `onGroupingDone` event would be raised only once if several columns get grouped at once by calling
+		     * The `groupingDone` event would be raised only once if several columns get grouped at once by calling
 		     * the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.
 		     * The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain
 		     * the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation.
@@ -614,10 +614,10 @@ dataPreLoad: CustomEvent<IgcForOfState>;
 		     * columns.
 		     * @example
 		     * ```html
-		     * <igx-grid #grid [data]="localData" (onGroupingDone)="groupingDone($event)" [autoGenerate]="true"></igx-grid>
+		     * <igx-grid #grid [data]="localData" (groupingDone)="groupingDone($event)" [autoGenerate]="true"></igx-grid>
 		     * ```
 		     */
-onGroupingDone: CustomEvent<IgcGroupingDoneEventArgs>;
+groupingDone: CustomEvent<IgcGroupingDoneEventArgs>;
 
 }
         

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

@@ -15,7 +15,11 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public set rowID(value: any);
         public get rowID(): any;
 
-        
+         // deprecated
+    public set primaryKey(value: any);
+        public get primaryKey(): any;
+
+            // in a major version, remove the deprecated `rowID` and migrate to `key`
     public cellID?: { rowID: any; columnID: any; rowIndex: number; };
 
         

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

@@ -4,6 +4,7 @@
 /* jsonAPIPlainObject */
 
 
+/* marshalByValue */
 
     export declare class IgcGridSelectionRange
     {

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

@@ -1,6 +1,7 @@
 
 import { IgcBaseToolbarDirective } from './igc-base-toolbar-directive';
 import { IgcExporterEvent } from './igc-exporter-event';
+import { GridToolbarExporterType } from './grid-toolbar-exporter-type';
 import { IgcToggleDirective } from './igc-toggle-directive';
 import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
 
@@ -63,7 +64,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
             
 
     /* alternateName: exportGrid */
-    public export(type: any, toggleRef?: IgcToggleDirective): void;
+    public export(type: GridToolbarExporterType, toggleRef?: IgcToggleDirective): void;
 
     }
 

package/grids/lib/igc-grouped-records.d.ts

@@ -7,7 +7,7 @@
  * @hidden
  */
 
-    export declare class IgcGroupedRecords
+    export declare class IgcGroupedRecords extends Array
     {
 
     }

package/grids/lib/igc-number-filtering-operand.d.ts

@@ -0,0 +1,20 @@
+
+import { IgcFilteringOperand } from './igc-filtering-operand';
+
+
+
+
+/* csSuppress */
+/**
+ * Provides filtering operations for numbers
+ *
+ * @export
+ */
+
+    export declare class IgcNumberFilteringOperand extends IgcFilteringOperand
+    {
+
+    }
+
+
+