igniteui-webcomponents-grids 4.3.2 → 4.3.3-beta.0

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

@@ -0,0 +1,65 @@
+
+import { IgcGridStateBaseDirective } from './igc-grid-state-base-directive';
+import { IgcGridStateInfo } from './igc-grid-state-info';
+
+
+
+
+/* blazorElement */
+/* wcElementTag: igc-grid-state */
+/* blazorIndirectRender */
+/* singleInstanceIdentifier */
+/* contentParent: GridBaseDirective */
+/* jsonAPIManageCollectionInMarkup */
+/**
+ * State component allows saving and restoring the state of the grid features.
+ * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
+ */
+
+    export declare class IgcGridStateComponent extends IgcGridStateBaseDirective
+    {
+
+            
+
+    /* blazorCSSuppress */
+    /**
+     * Restores grid features' state based on the IGridStateInfo object passed as an argument.
+     * @param state object to restore state from.
+     * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
+     */
+    public applyState(state: IgcGridStateInfo, features?: string[]): void;
+
+            
+
+    /**
+     * Restores grid features' state based on the serialized IGridState object passed as an argument.
+     * @param state string to restore state from.
+     * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
+     */
+    public applyStateFromString(state: string, features?: string[]): void;
+
+            
+
+    /* blazorCSSuppress */
+    /**
+     * Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the `options` property.
+     *
+     * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
+     * @returns The state object.
+     */
+    public getState(features?: string[]): IgcGridStateInfo;
+
+            
+
+    /**
+     * Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the `options` property.
+     *
+     * @param feature array of strings determining the features to be added in the state. If skipped, all features are added.
+     * @returns Returns the serialized to JSON string IGridStateInfo object.
+     */
+    public getStateAsString(features?: string[]): string;
+
+    }
+
+
+        

package/grids/lib/igc-grid-state-info.d.ts

@@ -0,0 +1,73 @@
+
+import { IgcColumnState } from './igc-column-state';
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+import { IgcPagingState } from './igc-paging-state';
+import { IgcSortingExpression } from './igc-sorting-expression';
+import { IgcGroupingState } from './igc-grouping-state';
+import { IgcGridSelectionRange } from './igc-grid-selection-range';
+import { IgcPinningConfig } from './igc-pinning-config';
+import { IgcGridStateCollection } from './igc-grid-state-collection';
+import { IgcPivotConfiguration } from './igc-pivot-configuration';
+
+
+/* jsonAPIPlainObject */
+
+
+/* tsPlainInterface */
+/* marshalByValue */
+
+    export declare class IgcGridStateInfo
+    {
+
+          
+    public columns?: IgcColumnState[];
+  
+          
+    public filtering?: IgcFilteringExpressionsTree;
+  
+          
+    public advancedFiltering?: IgcFilteringExpressionsTree;
+  
+          
+    public paging?: IgcPagingState;
+  
+          
+    public moving?: boolean;
+  
+          
+    public sorting?: IgcSortingExpression[];
+  
+          
+    public groupBy?: IgcGroupingState;
+  
+          
+    public cellSelection?: IgcGridSelectionRange[];
+  
+          
+    public rowSelection?: any[];
+  
+          
+    public columnSelection?: string[];
+  
+          
+    public rowPinning?: any[];
+  
+          
+    public pinningConfig?: IgcPinningConfig;
+  
+          
+    public expansion?: any[];
+  
+          
+    public rowIslands?: IgcGridStateCollection[];
+  
+          
+    public id?: string;
+  
+          
+    public pivotConfiguration?: IgcPivotConfiguration;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-state-options.d.ts

@@ -0,0 +1,59 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcGridStateOptions
+    {
+
+          
+    public columns?: boolean;
+  
+          
+    public filtering?: boolean;
+  
+          
+    public advancedFiltering?: boolean;
+  
+          
+    public sorting?: boolean;
+  
+          
+    public groupBy?: boolean;
+  
+          
+    public paging?: boolean;
+  
+          
+    public cellSelection?: boolean;
+  
+          
+    public rowSelection?: boolean;
+  
+          
+    public columnSelection?: boolean;
+  
+          
+    public rowPinning?: boolean;
+  
+          
+    public pinningConfig?: boolean;
+  
+          
+    public expansion?: boolean;
+  
+          
+    public rowIslands?: boolean;
+  
+          
+    public moving?: boolean;
+  
+          
+    public pivotConfiguration?: boolean;
+  
+    }
+
+
+        

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

@@ -2,7 +2,6 @@
 import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -5,9 +5,10 @@ import { IgcBaseExporter } from './igc-base-exporter';
 import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
 
-/* jsonAPIPlainObject */
 
 
+/* jsonAPIPlainObject */
+/*  tsPlainInterface */
 
     export declare class IgcGridToolbarExportEventArgs extends IgcBaseEventArgs
     {

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

@@ -3,7 +3,6 @@ import { ValidationStatus } from './validation-status';
 import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 
-/* jsonAPIPlainObject */
 
 
 

package/grids/lib/igc-group-by-record.d.ts

@@ -3,9 +3,9 @@ import { IgcSortingExpression } from './igc-sorting-expression';
 import { IgcColumnComponent } from './igc-column-component';
 
 
-/* jsonAPIPlainObject */
 
 
+/* jsonAPIComplexObject */
 
     export declare class IgcGroupByRecord
     {

package/grids/lib/igc-group-by-result.d.ts

@@ -0,0 +1,23 @@
+
+import { IgcGroupByRecord } from './igc-group-by-record';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcGroupByResult
+    {
+
+          
+    public set data(value: any[]);
+          public get data(): any[];
+  
+          
+    public set metadata(value: IgcGroupByRecord[]);
+          public get metadata(): IgcGroupByRecord[];
+  
+    }
+
+
+        

package/grids/lib/igc-group-by-row-selector-template-context.d.ts

@@ -2,7 +2,6 @@
 import { IgcGroupByRowSelectorTemplateDetails } from './igc-group-by-row-selector-template-details';
 
 
-/* jsonAPIPlainObject */
 
 
     export declare class IgcGroupByRowSelectorTemplateContext

package/grids/lib/igc-group-by-row-selector-template-details.d.ts

@@ -2,9 +2,9 @@
 import { IgcGroupByRecord } from './igc-group-by-record';
 
 
-/* jsonAPIPlainObject */
 
 
+/* jsonAPIComplexObject */
 
     export declare class IgcGroupByRowSelectorTemplateDetails
     {

package/grids/lib/igc-group-by-row-template-context.d.ts

@@ -2,7 +2,6 @@
 import { IgcGroupByRecord } from './igc-group-by-record';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -4,7 +4,6 @@ import { IgcSortingExpression } from './igc-sorting-expression';
 import { IgcColumnComponent } from './igc-column-component';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -5,10 +5,16 @@ import { IgcSortingExpression } from './igc-sorting-expression';
 /* jsonAPIPlainObject */
 
 
+/* marshalByValue */
+/* tsPlainInterface */
 
     export declare class IgcGroupingExpression extends IgcSortingExpression
     {
 
+            
+    /* blazorCSSuppress */
+    public groupingComparer?(a: any, b: any, currRec?: any, groupRec?: any): number;
+
     }
 
 

package/grids/lib/igc-grouping-state.d.ts

@@ -0,0 +1,28 @@
+
+import { IgcGroupingExpression } from './igc-grouping-expression';
+import { IgcGroupByExpandState } from './igc-group-by-expand-state';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcGroupingState
+    {
+
+          
+    public set expressions(value: IgcGroupingExpression[]);
+          public get expressions(): IgcGroupingExpression[];
+  
+          
+    public set expansion(value: IgcGroupByExpandState[]);
+          public get expansion(): IgcGroupByExpandState[];
+  
+          
+    public set defaultExpanded(value: boolean);
+          public get defaultExpanded(): boolean;
+  
+    }
+
+
+        

package/grids/lib/igc-head-selector-template-context.d.ts

@@ -2,7 +2,6 @@
 import { IgcHeadSelectorTemplateDetails } from './igc-head-selector-template-details';
 
 
-/* jsonAPIPlainObject */
 
 
     export declare class IgcHeadSelectorTemplateContext

package/grids/lib/igc-head-selector-template-details.d.ts

@@ -1,9 +1,9 @@
 
 
 
-/* jsonAPIPlainObject */
 
 
+/* jsonAPIComplexObject */
 
     export declare class IgcHeadSelectorTemplateDetails
     {
@@ -17,10 +17,10 @@
           public get totalCount(): number;
   
             
-    public selectAll(): void;
+    public selectAll?(): void;
 
             
-    public deselectAll(): void;
+    public deselectAll?(): void;
 
     }
 

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

@@ -4,9 +4,9 @@ import { DisplayDensity } from './display-density';
 import { SortingDirection } from './sorting-direction';
 
 
-/* jsonAPIPlainObject */
 
 
+/* jsonAPIComplexObject */
 
     export declare class IgcHeaderType
     {

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

@@ -4,7 +4,7 @@ import { IgcFilteringOperand } from './igc-filtering-operand';
 
 
 
-/* csSuppress */
+/* blazorCSSuppress */
 /**
  * Provides filtering operations for numbers
  *

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

@@ -6,7 +6,7 @@ import { IgcSummaryResult } from './igc-summary-result';
 
 
 
-/* csSuppress */
+/* blazorCSSuppress */
 // @dynamic
 
     export declare class IgcNumberSummaryOperand extends IgcSummaryOperand

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

@@ -2,7 +2,6 @@
 import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -2,7 +2,6 @@
 import { IgcBaseEventArgs } from './igc-base-event-args';
 
 
-/* jsonAPIPlainObject */
 
 
 

package/grids/lib/igc-paging-state.d.ts

@@ -0,0 +1,22 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcPagingState
+    {
+
+          
+    public set index(value: number);
+          public get index(): number;
+  
+          
+    public set recordsPerPage(value: number);
+          public get recordsPerPage(): number;
+  
+    }
+
+
+        

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

@@ -1,8 +1,7 @@
 
-import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
+import { IgcColumnComponent } from './igc-column-component';
 
 
-/* jsonAPIPlainObject */
 
 
 /**
@@ -13,9 +12,36 @@ import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
  * the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
  */
 
-    export declare class IgcPinColumnCancellableEventArgs extends IgcCancelableEventArgs
+    export declare class IgcPinColumnCancellableEventArgs
     {
 
+        
+    public set column(value: IgcColumnComponent);
+        public get column(): IgcColumnComponent;
+
+        
+    /**
+     * If pinned, specifies at which index in the pinned area the column is inserted.
+     * If unpinned, specifies at which index in the unpinned area the column is inserted.
+     */
+    public set insertAtIndex(value: number);
+        public get insertAtIndex(): number;
+
+        
+    /**
+     * 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.
+     */
+    public set isPinned(value: boolean);
+        public get isPinned(): boolean;
+
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public set cancel(value: boolean);
+        public get cancel(): boolean;
+
     }
 
 

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

@@ -3,7 +3,6 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
 import { IgcColumnComponent } from './igc-column-component';
 
 
-/* jsonAPIPlainObject */
 
 
 /**

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

@@ -1,16 +1,14 @@
 
-import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
 import { IgcRowType } from './igc-row-type';
 
 
-/* jsonAPIPlainObject */
 
 
 /**
  * Event emitted when a row's pin state changes.
  */
 
-    export declare class IgcPinRowEventArgs extends IgcCancelableEventArgs
+    export declare class IgcPinRowEventArgs
     {
 
         
@@ -33,6 +31,19 @@ import { IgcRowType } from './igc-row-type';
     public set isPinned(value: boolean);
         public get isPinned(): boolean;
 
+        
+    /**
+     * Provides reference to the owner component.
+     */
+    public owner?: any;
+
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public set cancel(value: boolean);
+        public get cancel(): boolean;
+
     }
 
 

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

@@ -39,7 +39,7 @@ import { PivotAggregationType } from './pivot-aggregation-type';
      * Aggregator function can be a custom implementation of `PivotAggregation`, or
      * use predefined ones from `IgxPivotAggregate` and its variants.
      */
-    public aggregator?: (members: any[], data?: any[]) => any;
+    public aggregator?: any;
   
     }
 

package/grids/lib/igc-pivot-configuration-changed-event-args.d.ts

@@ -2,7 +2,6 @@
 import { IgcPivotConfiguration } from './igc-pivot-configuration';
 
 
-/* jsonAPIPlainObject */
 
 
 /**

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

@@ -17,7 +17,7 @@ import { IgcPivotKeys } from './igc-pivot-keys';
     {
 
             
-    /* csSuppress */
+    /* blazorCSSuppress */
     public process(collection: any, dimensions: IgcPivotDimension[], values: IgcPivotValue[], cloneStrategy: IgcDataCloneStrategy, pivotKeys?: IgcPivotKeys): any[];
 
     }

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

@@ -30,7 +30,7 @@ import { GridColumnDataType } from './grid-column-data-type';
     /* csTreatAsEvent: MemberFunctionHandler */
     /* blazorOnlyScript */
     /** Function that extracts the value */
-    public memberFunction?: (data: any) => any;
+    public memberFunction?: any;
   
           
     /** Enables/Disables a particular dimension from pivot structure. */

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

@@ -2,7 +2,6 @@
 import { IgcPivotValue } from './igc-pivot-value';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -1,9 +1,7 @@
 
 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 */
 
@@ -58,7 +56,7 @@ import { IgcPivotGridRecord } from './igc-pivot-grid-record';
     /* csTreatAsEvent: PivotValueFormatterEventHandler */
     /* blazorOnlyScript */
     /** Applies display format to cell values. */
-    public formatter?: (value: any, rowData?: IgcPivotGridRecord, columnData?: IgcPivotGridColumn) => any;
+    public formatter?: any;
   
     }
 

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

@@ -2,7 +2,6 @@
 import { IgcBaseEventArgs } from './igc-base-event-args';
 
 
-/* jsonAPIPlainObject */
 
 
     export declare class IgcRowDataEventArgs extends IgcBaseEventArgs

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

@@ -3,7 +3,6 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
 import { IgcRowType } from './igc-row-type';
 
 
-/* jsonAPIPlainObject */
 
 
 

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

@@ -1,13 +1,11 @@
 
-import { IgcBaseEventArgs } from './igc-base-event-args';
 import { IgcRowType } from './igc-row-type';
 
 
-/* jsonAPIPlainObject */
 
 
 
-    export declare class IgcRowDragStartEventArgs extends IgcBaseEventArgs
+    export declare class IgcRowDragStartEventArgs
     {
 
         
@@ -18,6 +16,19 @@ import { IgcRowType } from './igc-row-type';
     public set dragData(value: IgcRowType);
         public get dragData(): IgcRowType;
 
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public set cancel(value: boolean);
+        public get cancel(): boolean;
+
+        
+    /**
+     * Provides reference to the owner component.
+     */
+    public owner?: any;
+
     }