igniteui-webcomponents-grids 6.3.0-alpha.0 → 6.3.0-alpha.2

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

@@ -0,0 +1,242 @@
+
+import { IgcHierarchicalGridBaseDirective } from './igc-hierarchical-grid-base-directive';
+import { IgcColumnComponent } from './igc-column-component';
+import { IgcColumnGroupComponent } from './igc-column-group-component';
+import { IgcColumnLayoutComponent } from './igc-column-layout-component';
+import { IgcGridToolbarComponent } from './igc-grid-toolbar-component';
+import { IgcGridToolbarActionsComponent } from './igc-grid-toolbar-actions-component';
+import { IgcGridToolbarTitleComponent } from './igc-grid-toolbar-title-component';
+import { IgcGridToolbarAdvancedFilteringComponent } from './igc-grid-toolbar-advanced-filtering-component';
+import { IgcGridToolbarExporterComponent } from './igc-grid-toolbar-exporter-component';
+import { IgcGridToolbarHidingComponent } from './igc-grid-toolbar-hiding-component';
+import { IgcGridToolbarPinningComponent } from './igc-grid-toolbar-pinning-component';
+import { IgcActionStripComponent } from './igc-action-strip-component';
+import { IgcGridEditingActionsComponent } from './igc-grid-editing-actions-component';
+import { IgcGridPinningActionsComponent } from './igc-grid-pinning-actions-component';
+import { IgcRowIslandComponent } from './igc-row-island-component';
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+import { IgcPrefixedResourceStrings } from './igc-prefixed-resource-strings';
+import { IgcCellType } from './igc-cell-type';
+import { IgcRowType } from './igc-row-type';
+import { IgcHierarchicalGridBaseDirectiveEventMap } from './igc-hierarchical-grid-base-directive';
+
+
+
+
+
+/* blazorAdditionalDependency: Column */
+/* blazorAdditionalDependency: ColumnGroup */
+/* blazorAdditionalDependency: ColumnLayout */
+/* blazorAdditionalDependency: GridToolbar */
+/* blazorAdditionalDependency: GridToolbarActions */
+/* blazorAdditionalDependency: GridToolbarTitle */
+/* blazorAdditionalDependency: GridToolbarAdvancedFiltering */
+/* blazorAdditionalDependency: GridToolbarExporter */
+/* blazorAdditionalDependency: GridToolbarHiding */
+/* blazorAdditionalDependency: GridToolbarPinning */
+/* blazorAdditionalDependency: ActionStrip */
+/* blazorAdditionalDependency: GridActionsBaseDirective */
+/* blazorAdditionalDependency: GridEditingActions */
+/* blazorAdditionalDependency: GridPinningActions */
+/* blazorAdditionalDependency: RowIsland */
+/* blazorIndirectRender */
+/**
+ * Hierarchical grid
+ *
+ * @igxModule IgxHierarchicalGridModule
+ *
+ */
+
+    export declare class IgcHierarchicalGridComponent extends IgcHierarchicalGridBaseDirective
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+    /* contentChildren */
+    /* blazorInclude */
+    /* blazorTreatAsCollection */
+    /* blazorCollectionName: RowIslandCollection */
+    /* ngQueryListName: childLayoutList */
+    /**
+     * @hidden
+     */
+    public set childLayoutList(value: IgcRowIslandComponent[]);
+          public get childLayoutList(): IgcRowIslandComponent[];
+  
+          
+
+    public set advancedFilteringExpressionsTree(value: IgcFilteringExpressionsTree);
+          public get advancedFilteringExpressionsTree(): IgcFilteringExpressionsTree;
+  
+          
+
+    /**
+     * Gets/Sets the value of the `id` attribute.
+     *
+     * @remarks
+     * If not provided it will be automatically generated.
+     * @example
+     * ```html
+     * <igx-hierarchical-grid [id]="'igx-hgrid-1'" [data]="Data" [autoGenerate]="true"></igx-hierarchical-grid>
+     * ```
+     */
+    public set id(value: string);
+          public get id(): string;
+  
+          
+
+    /* treatAsRef */
+    /**
+     * Gets/Sets the array of data that populates the component.
+     * ```html
+     * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true"></igx-hierarchical-grid>
+     * ```
+     *
+     * @memberof IgxHierarchicalGridComponent
+     */
+    public set data(value: any[]);
+          public get data(): any[];
+  
+          
+
+    /**
+     * Gets/Sets the total number of records in the data source.
+     *
+     * @remarks
+     * This property is required for remote grid virtualization to function when it is bound to remote data.
+     * @example
+     * ```typescript
+     * const itemCount = this.grid1.totalItemCount;
+     * this.grid1.totalItemCount = 55;
+     * ```
+     */
+    public set totalItemCount(value: number);
+          public get totalItemCount(): number;
+  
+          
+
+    /**
+     * Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.
+     * Default value is false.
+     * ```html
+     * <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" [expandChildren]="true"></igx-hierarchical-grid>
+     * ```
+     *
+     * @memberof IgxHierarchicalGridComponent
+     */
+    public set expandChildren(value: boolean);
+          public get expandChildren(): boolean;
+  
+          
+
+    /**
+     * Gets/Sets the resource strings.
+     *
+     * @remarks
+     * By default it uses EN resources.
+     */
+    public set resourceStrings(value: IgcPrefixedResourceStrings);
+          public get resourceStrings(): IgcPrefixedResourceStrings;
+  
+                
+
+    /**
+     * Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the
+     * parent grid is set or an object reference of the parent record otherwise.
+     * ```typescript
+     * const foreignKey = this.grid.foreignKey;
+     * ```
+     *
+     * @memberof IgxHierarchicalGridComponent
+     */
+    public get foreignKey(): any;
+        
+                
+
+    /**
+     * Returns an array of the selected `IgxGridCell`s.
+     *
+     * @example
+     * ```typescript
+     * const selectedCells = this.grid.selectedCells;
+     * ```
+     */
+    public get selectedCells(): IgcCellType[];
+        
+            
+
+    /**
+     * Returns the `RowType` by index.
+     *
+     * @example
+     * ```typescript
+     * const myRow = this.grid1.getRowByIndex(1);
+     * ```
+     * @param index
+     */
+    public getRowByIndex(index: number): IgcRowType;
+
+            
+
+    /**
+     * Returns the `RowType` by key.
+     *
+     * @example
+     * ```typescript
+     * const myRow = this.grid1.getRowByKey(1);
+     * ```
+     * @param key
+     */
+    public getRowByKey(key: any): IgcRowType;
+
+            
+
+    /**
+     * Returns a `CellType` object that matches the conditions.
+     *
+     * @example
+     * ```typescript
+     * const myCell = this.grid1.getCellByColumn(2, "UnitPrice");
+     * ```
+     * @param rowIndex
+     * @param columnField
+     */
+    public getCellByColumn(rowIndex: number, columnField: string): IgcCellType;
+
+            
+
+    /**
+     * Returns a `CellType` object that matches the conditions.
+     *
+     * @remarks
+     * Requires that the primaryKey property is set.
+     * @example
+     * ```typescript
+     * grid.getCellByKey(1, 'index');
+     * ```
+     * @param rowSelector match any rowID
+     * @param columnField
+     */
+    public getCellByKey(rowSelector: any, columnField: string): IgcCellType;
+
+            
+
+    public pinRow(rowID: any, index?: number): boolean;
+
+            
+
+    public unpinRow(rowID: any): boolean;
+
+            
+
+    public getDefaultExpandState(record: any): void;
+
+    }
+
+export type IgcHierarchicalGridComponentEventMap = IgcHierarchicalGridBaseDirectiveEventMap
+        

package/grids/lib/igc-noop-filtering-strategy.d.ts

@@ -0,0 +1,24 @@
+
+import { IgcBaseFilteringStrategy } from './igc-base-filtering-strategy';
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+
+
+
+
+/* csSuppress */
+
+    export declare class IgcNoopFilteringStrategy extends IgcBaseFilteringStrategy
+    {
+
+            
+
+    public static instance(): void;
+
+            
+
+    public filter(data: any[], _: IgcFilteringExpressionsTree, __?: IgcFilteringExpressionsTree): any[];
+
+    }
+
+
+        

package/grids/lib/igc-noop-pivot-dimensions-strategy.d.ts

@@ -0,0 +1,24 @@
+
+import { IgcPivotDimension } from './igc-pivot-dimension';
+import { IgcPivotValue } from './igc-pivot-value';
+
+
+
+
+/* csSuppress */
+
+    export declare class IgcNoopPivotDimensionsStrategy
+    {
+
+            
+
+    public static instance(): IgcNoopPivotDimensionsStrategy;
+
+            
+
+    public process(collection: any[], _: IgcPivotDimension[], __: IgcPivotValue[]): any[];
+
+    }
+
+
+        

package/grids/lib/igc-noop-sorting-strategy.d.ts

@@ -0,0 +1,27 @@
+
+
+
+
+
+/* csSuppress */
+/**
+ * Represents a class implementing the IGridSortingStrategy interface with a no-operation sorting strategy.
+ * It performs no sorting and returns the data as it is.
+ */
+
+    export declare class IgcNoopSortingStrategy
+    {
+
+            
+
+    public static instance(): IgcNoopSortingStrategy;
+
+            
+
+    /* csSuppress */
+    public sort(data: any[]): any[];
+
+    }
+
+
+        

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

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

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

@@ -0,0 +1,104 @@
+
+import { IgcSummaryOperand } from './igc-summary-operand';
+import { IgcGroupByRecord } from './igc-group-by-record';
+import { IgcSummaryResult } from './igc-summary-result';
+
+
+
+
+/* blazorCSSuppress */
+// @dynamic
+
+    export declare class IgcNumberSummaryOperand extends IgcSummaryOperand
+    {
+
+            
+    /**
+     * Returns the minimum numeric value in the provided data records.
+     * If filtering is applied, returns the minimum value in the filtered data records.
+     * ```typescript
+     * IgxNumberSummaryOperand.min(data);
+     * ```
+     *
+     * @memberof IgxNumberSummaryOperand
+     */
+    public static min(data: any[]): number;
+
+            
+    /**
+     * Returns the maximum numeric value in the provided data records.
+     * If filtering is applied, returns the maximum value in the filtered data records.
+     * ```typescript
+     * IgxNumberSummaryOperand.max(data);
+     * ```
+     *
+     * @memberof IgxNumberSummaryOperand
+     */
+    public static max(data: any[]): number;
+
+            
+    /**
+     * Returns the sum of the numeric values in the provided data records.
+     * If filtering is applied, returns the sum of the numeric values in the data records.
+     * ```typescript
+     * IgxNumberSummaryOperand.sum(data);
+     * ```
+     *
+     * @memberof IgxNumberSummaryOperand
+     */
+    public static sum(data: any[]): number;
+
+            
+    /**
+     * Returns the average numeric value in the data provided data records.
+     * If filtering is applied, returns the average numeric value in the filtered data records.
+     * ```typescript
+     * IgxSummaryOperand.average(data);
+     * ```
+     *
+     * @memberof IgxNumberSummaryOperand
+     */
+    public static average(data: any[]): number;
+
+            
+    /**
+     * 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 CustomNumberSummary extends IgxNumberSummaryOperand {
+     *   constructor() {
+     *     super();
+     *   }
+     *   public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] {
+     *     const result = super.operate(data, allData, fieldName, groupRecord);
+     *     result.push({
+     *       key: "avg",
+     *       label: "Avg",
+     *       summaryResult: IgxNumberSummaryOperand.average(data)
+     *     });
+     *     result.push({
+     *       key: 'mdn',
+     *       label: 'Median',
+     *       summaryResult: this.findMedian(data)
+     *     });
+     *     return result;
+     *   }
+     * }
+     * this.grid.getColumnByName('ColumnName').summaries = CustomNumberSummary;
+     * ```
+     *
+     * @memberof IgxNumberSummaryOperand
+     */
+    public operate(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
+
+    }
+
+
+        

package/grids/lib/igc-overlay-outlet-directive.d.ts

@@ -0,0 +1,20 @@
+
+
+
+
+
+/**
+ * Mark an element as an igxOverlay outlet container.
+ * Directive instance is exported as `overlay-outlet` to be assigned to templates variables:
+ * ```html
+ * <div igxOverlayOutlet #outlet="overlay-outlet"></div>
+ * ```
+ */
+
+    export declare class IgcOverlayOutletDirective
+    {
+
+    }
+
+
+        

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

@@ -0,0 +1,41 @@
+
+import { Point } from './common';
+                import { IgcPositionStrategy } from './igc-position-strategy';
+import { IgcScrollStrategy } from './igc-scroll-strategy';
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcOverlaySettings
+    {
+
+          
+    /** Attaching target for the component to show */
+    public target?: HTMLElement | Point;
+  
+          
+    /** Position strategy to use with these settings */
+    public positionStrategy?: IgcPositionStrategy;
+  
+          
+    /** Scroll strategy to use with these settings */
+    public scrollStrategy?: IgcScrollStrategy;
+  
+          
+    /** Set if the overlay should be in modal mode */
+    public modal?: boolean;
+  
+          
+    /** Set if the overlay should close on outside click */
+    public closeOnOutsideClick?: boolean;
+  
+          
+    /** Set if the overlay should close when `Esc` key is pressed */
+    public closeOnEscape?: boolean;
+  
+    }
+
+
+        

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

@@ -0,0 +1,20 @@
+
+import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
+
+
+
+
+
+    export declare class IgcPageCancellableEventArgs extends IgcCancelableEventArgs
+    {
+
+        
+    public current: number;
+
+        
+    public next: number;
+
+    }
+
+
+        

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

@@ -0,0 +1,20 @@
+
+import { IgcBaseEventArgs } from './igc-base-event-args';
+
+
+
+
+
+    export declare class IgcPageEventArgs extends IgcBaseEventArgs
+    {
+
+        
+    public previous: number;
+
+        
+    public current: number;
+
+    }
+
+
+