igniteui-webcomponents-grids 4.0.3 → 4.2.2

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

@@ -0,0 +1,47 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+/** Interface describing the Pivot data keys used for data generation.
+*  Can be used for custom remote scenarios where the data is pre-populated.
+*/
+
+    export declare class IgcPivotKeys
+    {
+
+          
+    /** Field that stores children for hierarchy building. */
+    public set children(value: string);
+          public get children(): string;
+  
+          
+    /** Field that stores reference to the original data records. */
+    public set records(value: string);
+          public get records(): string;
+  
+          
+    /** Field that stores aggregation values. */
+    public set aggregations(value: string);
+          public get aggregations(): string;
+  
+          
+    /** Field that stores dimension level based on its hierarchy. */
+    public set level(value: string);
+          public get level(): string;
+  
+          
+    /** Separator used when generating the unique column field values. */
+    public set columnDimensionSeparator(value: string);
+          public get columnDimensionSeparator(): string;
+  
+          
+    /** Separator used when generating the unique row field values. */
+    public set rowDimensionSeparator(value: string);
+          public get rowDimensionSeparator(): string;
+  
+    }
+
+
+        

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

@@ -0,0 +1,65 @@
+
+import { IgcPivotAggregator } from './igc-pivot-aggregator';
+import { GridColumnDataType } from './grid-column-data-type';
+import { IgcPivotGridRecord } from './igc-pivot-grid-record';
+                import { IgcPivotGridColumn } from './igc-pivot-grid-column';
+                
+
+/* jsonAPIPlainObject */
+
+
+/**
+* Configuration of a pivot value aggregation.
+*/
+
+    export declare class IgcPivotValue
+    {
+
+          
+    /** Field name to use in order to extract value. */
+    public set member(value: string);
+          public get member(): string;
+  
+          
+    /** Display name to show instead of member for the column header of this value. **/
+    public displayName?: string;
+  
+          
+    /**
+     * Active aggregator definition with key, label and aggregator.
+     */
+    public set aggregate(value: IgcPivotAggregator);
+          public get aggregate(): IgcPivotAggregator;
+  
+          
+    /* blazorTreatAsCollection */
+    /* blazorCollectionName: PivotAggregatorCollection */
+    /**
+     * List of aggregates to show in aggregate drop-down.
+     */
+    public aggregateList?: IgcPivotAggregator[];
+  
+          
+    /** Enables/Disables a particular value from pivot aggregation. */
+    public set enabled(value: boolean);
+          public get enabled(): boolean;
+  
+          
+    /**  Allow conditionally styling of the IgxPivotGrid cells. */
+    public styles?: any;
+  
+          
+    /** Enables a data type specific template of the cells */
+    public dataType?: GridColumnDataType;
+  
+          
+
+    /* csTreatAsEvent: PivotValueFormatterEventHandler */
+    /* blazorOnlyScript */
+    /** Applies display format to cell values. */
+    public formatter?: (value: any, rowData?: IgcPivotGridRecord, columnData?: IgcPivotGridColumn) => any;
+  
+    }
+
+
+        

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

@@ -18,33 +18,27 @@ import { IgcSize } from './igc-size';
      *
      * Attaching target for the component to show
      */
-    public set target(value: HTMLElement | Point);
-          public get target(): HTMLElement | Point;
+    public target?: HTMLElement | Point;
   
           
     /** Direction in which the component should show */
-    public set horizontalDirection(value: HorizontalAlignment);
-          public get horizontalDirection(): HorizontalAlignment;
+    public horizontalDirection?: HorizontalAlignment;
   
           
     /** Direction in which the component should show */
-    public set verticalDirection(value: VerticalAlignment);
-          public get verticalDirection(): VerticalAlignment;
+    public verticalDirection?: VerticalAlignment;
   
           
     /** Target's starting point */
-    public set horizontalStartPoint(value: HorizontalAlignment);
-          public get horizontalStartPoint(): HorizontalAlignment;
+    public horizontalStartPoint?: HorizontalAlignment;
   
           
     /** Target's starting point */
-    public set verticalStartPoint(value: VerticalAlignment);
-          public get verticalStartPoint(): VerticalAlignment;
+    public verticalStartPoint?: VerticalAlignment;
   
           
     /** The size up to which element may shrink when shown in elastic position strategy */
-    public set minSize(value: IgcSize);
-          public get minSize(): IgcSize;
+    public minSize?: IgcSize;
   
     }
 

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

@@ -1,6 +1,5 @@
 
 import { IgcBaseEventArgs } from './igc-base-event-args';
-import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
 /* jsonAPIPlainObject */
@@ -13,10 +12,6 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     public set data(value: any);
         public get data(): any;
 
-        
-    public set owner(value: IgcGridBaseDirective);
-        public get owner(): IgcGridBaseDirective;
-
     }
 
 

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

@@ -25,6 +25,9 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     public set removed(value: any[]);
         public get removed(): any[];
 
+        
+    public allRowsSelected?: boolean;
+
     }
 
 

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

@@ -23,81 +23,62 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
           public get viewIndex(): number;
   
           
-    public set isGroupByRow(value: boolean);
-          public get isGroupByRow(): boolean;
+    public isGroupByRow?: boolean;
   
           
-    public set isSummaryRow(value: boolean);
-          public get isSummaryRow(): boolean;
+    public isSummaryRow?: boolean;
   
           
-    public set groupRow(value: IgcGroupByRecord);
-          public get groupRow(): IgcGroupByRecord;
+    public groupRow?: IgcGroupByRecord;
   
           
-    public set key(value: any);
-          public get key(): any;
+    public key?: any;
   
           
-    public set validation(value: IgcGridValidationState);
-          public get validation(): IgcGridValidationState;
+    public validation?: IgcGridValidationState;
   
           
-    public set data(value: any);
-          public get data(): any;
+    public data?: any;
   
           
-    public set cells(value: IgcCellType[]);
-          public get cells(): IgcCellType[];
+    public cells?: IgcCellType[];
   
           
-    public set disabled(value: boolean);
-          public get disabled(): boolean;
+    public disabled?: boolean;
   
           
-    public set pinned(value: boolean);
-          public get pinned(): boolean;
+    public pinned?: boolean;
   
           
-    public set selected(value: boolean);
-          public get selected(): boolean;
+    public selected?: boolean;
   
           
-    public set expanded(value: boolean);
-          public get expanded(): boolean;
+    public expanded?: boolean;
   
           
-    public set deleted(value: boolean);
-          public get deleted(): boolean;
+    public deleted?: boolean;
   
           
-    public set inEditMode(value: boolean);
-          public get inEditMode(): boolean;
+    public inEditMode?: boolean;
   
           
-    public set children(value: IgcRowType[]);
-          public get children(): IgcRowType[];
+    public children?: IgcRowType[];
   
           
     /* blazorAlternateName: RowParent */
-    public set parent(value: IgcRowType);
-          public get parent(): IgcRowType;
+    public parent?: IgcRowType;
   
           
-    public set hasChildren(value: boolean);
-          public get hasChildren(): boolean;
+    public hasChildren?: boolean;
   
           
-    public set treeRow(value: IgcTreeGridRecord);
-          public get treeRow(): IgcTreeGridRecord;
+    public treeRow?: IgcTreeGridRecord;
   
           
-    public set addRowUI(value: boolean);
-          public get addRowUI(): boolean;
+    public addRowUI?: boolean;
   
           
-    public set focused(value: boolean);
-          public get focused(): boolean;
+    public focused?: boolean;
   
           
     public set grid(value: IgcGridBaseDirective);

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

@@ -12,12 +12,10 @@ import { IgcGroupingExpression } from './igc-grouping-expression';
     {
 
         
-    public set sortingExpressions(value: IgcSortingExpression[]);
-        public get sortingExpressions(): IgcSortingExpression[];
+    public sortingExpressions?: IgcSortingExpression[];
 
         
-    public set groupingExpressions(value: IgcGroupingExpression[]);
-        public get groupingExpressions(): IgcGroupingExpression[];
+    public groupingExpressions?: IgcGroupingExpression[];
 
     }
 

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

@@ -22,12 +22,10 @@ import { IgcSortingStrategy } from './igc-sorting-strategy';
           public get dir(): SortingDirection;
   
           
-    public set ignoreCase(value: boolean);
-          public get ignoreCase(): boolean;
+    public ignoreCase?: boolean;
   
           
-    public set strategy(value: IgcSortingStrategy);
-          public get strategy(): IgcSortingStrategy;
+    public strategy?: IgcSortingStrategy;
   
     }
 

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

@@ -1,4 +1,5 @@
 
+import { SortingOptionsMode } from './sorting-options-mode';
 
 
 /* jsonAPIPlainObject */
@@ -9,8 +10,8 @@
     {
 
           
-    public set mode(value: any);
-          public get mode(): any;
+    public set mode(value: SortingOptionsMode);
+          public get mode(): SortingOptionsMode;
   
     }
 

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

@@ -0,0 +1,29 @@
+
+import { IgcFilteringOperand } from './igc-filtering-operand';
+
+
+
+
+/* csSuppress */
+/**
+ * Provides filtering operations for strings
+ *
+ * @export
+ */
+
+    export declare class IgcStringFilteringOperand extends IgcFilteringOperand
+    {
+
+            
+
+    /**
+     * Applies case sensitivity on strings if provided
+     *
+     * @memberof IgxStringFilteringOperand
+     */
+    public static applyIgnoreCase(a: string, ignoreCase: boolean): string;
+
+    }
+
+
+        

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

@@ -0,0 +1,61 @@
+
+import { IgcGroupByRecord } from './igc-group-by-record';
+import { IgcSummaryResult } from './igc-summary-result';
+
+
+
+
+/* csSuppress */
+
+    export declare class IgcSummaryOperand
+    {
+
+            
+    /**
+     * Counts all the records in the data source.
+     * If filtering is applied, counts only the filtered records.
+     * ```typescript
+     * IgxSummaryOperand.count(dataSource);
+     * ```
+     *
+     * @memberof IgxSummaryOperand
+     */
+    public static count(data: any[]): number;
+
+            
+    /**
+     * Executes the static `count` method 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 CustomSummary extends IgxSummaryOperand {
+     *   constructor() {
+     *     super();
+     *   }
+     *   public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] {
+     *     const result = [];
+     *     result.push({
+     *       key: "test",
+     *       label: "Test",
+     *       summaryResult: IgxSummaryOperand.count(data)
+     *     });
+     *     return result;
+     *   }
+     * }
+     * this.grid.getColumnByName('ColumnName').summaries = CustomSummary;
+     * ```
+     *
+     * @memberof IgxSummaryOperand
+     */
+    public operate(data?: any[], _allData?: any[], _fieldName?: string, _groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
+
+    }
+
+
+        

package/grids/lib/igc-summary-result.d.ts

@@ -35,8 +35,7 @@
      *
      * @memberof IgxSummaryResult
      */
-    public set defaultFormatting(value: boolean);
-          public get defaultFormatting(): boolean;
+    public defaultFormatting?: boolean;
   
     }
 

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

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

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

@@ -0,0 +1,49 @@
+
+import { IgcSummaryOperand } from './igc-summary-operand';
+import { IgcGroupByRecord } from './igc-group-by-record';
+import { IgcSummaryResult } from './igc-summary-result';
+
+
+
+
+/* csSuppress */
+// @dynamic
+
+    export declare class IgcTimeSummaryOperand extends IgcSummaryOperand
+    {
+
+            
+    /**
+     * Returns the latest time value in the data records. Compare only the time part of the date.
+     * If filtering is applied, returns the latest time value in the filtered data records.
+     * ```typescript
+     * IgxTimeSummaryOperand.latestTime(data);
+     * ```
+     *
+     * @memberof IgxTimeSummaryOperand
+     */
+    public static latestTime(data: any[]): void;
+
+            
+
+    /**
+     * Returns the earliest time value in the data records. Compare only the time part of the date.
+     * If filtering is applied, returns the earliest time value in the filtered data records.
+     * ```typescript
+     * IgxTimeSummaryOperand.earliestTime(data);
+     * ```
+     *
+     * @memberof IgxTimeSummaryOperand
+     */
+    public static earliestTime(data: any[]): void;
+
+            
+    /**
+     * @memberof IgxTimeSummaryOperand
+     */
+    public operate(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
+
+    }
+
+
+        

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

@@ -174,6 +174,7 @@ import { IgcRowType } from './igc-row-type';
   
           
 
+    
     /**
      * Returns an array of objects containing the filtered data in the `IgxGridComponent`.
      * ```typescript
@@ -294,7 +295,7 @@ import { IgcRowType } from './igc-row-type';
 
             
 
-
+    /* blazorCSSuppress */
     /**
      * Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created
      * row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches
@@ -340,7 +341,7 @@ import { IgcRowType } from './igc-row-type';
             
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     public getSelectedData(formatters?: boolean, headers?: boolean): any[];
 

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

@@ -17,25 +17,20 @@
           public get data(): any;
   
           
-    public set children(value: IgcTreeGridRecord[]);
-          public get children(): IgcTreeGridRecord[];
+    public children?: IgcTreeGridRecord[];
   
           
     /* blazorAlternateName: RecordParent */
-    public set parent(value: IgcTreeGridRecord);
-          public get parent(): IgcTreeGridRecord;
+    public parent?: IgcTreeGridRecord;
   
           
-    public set level(value: number);
-          public get level(): number;
+    public level?: number;
   
           
-    public set isFilteredOutParent(value: boolean);
-          public get isFilteredOutParent(): boolean;
+    public isFilteredOutParent?: boolean;
   
           
-    public set expanded(value: boolean);
-          public get expanded(): boolean;
+    public expanded?: boolean;
   
     }
 

package/grids/lib/igc-values-change.d.ts

@@ -0,0 +1,23 @@
+
+import { IgcPivotValue } from './igc-pivot-value';
+
+
+/* jsonAPIPlainObject */
+
+
+/**
+* Event emitted when values list is changed.
+*/
+
+    export declare class IgcValuesChange
+    {
+
+          
+    /** The new list of values. */
+    public set values(value: IgcPivotValue[]);
+          public get values(): IgcPivotValue[];
+  
+    }
+
+
+        

package/grids/lib/pivot-aggregation-type.d.ts

@@ -0,0 +1,3 @@
+
+          export declare type PivotAggregationType = "SUM" | "AVG" | "MIN" | "MAX" | "COUNT" | "LATEST" | "EARLIEST";
+          

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

@@ -0,0 +1,17 @@
+
+
+
+
+
+/* mustCoerceToInt */
+/** The dimension types - Row, Column or Filter. */
+
+    export declare enum PivotDimensionType
+    {
+      Row,
+      Column,
+      Filter
+    }
+
+
+        

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

@@ -3,6 +3,7 @@
 
 
 
+/* mustCoerceToInt */
 
     export declare enum RowPinningPosition
     {

package/grids/lib/sorting-direction.d.ts

@@ -3,6 +3,7 @@
 
 
 
+/* mustCoerceToInt */
 
     export declare enum SortingDirection
     {

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

@@ -0,0 +1,3 @@
+
+          export declare type SortingOptionsMode = "single" | "multiple";
+