igniteui-webcomponents-grids 7.1.0 → 7.2.0-beta.1

package/grids/lib/igc-scroll-strategy.d.ts

@@ -5,7 +5,7 @@
 
 /**
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll).
- * Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService.
+ * Scroll strategies determines how the scrolling will be handled in the provided overlay.
  */
 
     export declare class IgcScrollStrategy
@@ -15,9 +15,6 @@
 
     /**
      * Attaches the strategy
-     * ```typescript
-     * settings.scrollStrategy.attach();
-     * ```
      */
     public attach(): void;
 
@@ -25,9 +22,6 @@
 
     /**
      * Detaches the strategy
-     * ```typescript
-     * settings.scrollStrategy.detach();
-     * ```
      */
     public detach(): void;
 

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

@@ -7,8 +7,6 @@ import { IgcFilteringOperand } from './igc-filtering-operand';
 /* blazorCSSuppress */
 /**
  * Provides filtering operations for strings
- *
- * @export
  */
 
     export declare class IgcStringFilteringOperand extends IgcFilteringOperand
@@ -18,8 +16,6 @@ import { IgcFilteringOperand } from './igc-filtering-operand';
 
     /**
      * 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

@@ -14,44 +14,12 @@ import { IgcSummaryResult } from './igc-summary-result';
     /**
      * 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
+     * Executes the static `count` method and returns summary result[]`.
      */
     public operate(data?: any[], _allData?: any[], _fieldName?: string, _groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
 

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

@@ -26,15 +26,6 @@
           
     /**
      * Apply default formatting based on the grid column type.
-     * ```typescript
-     * const result: IgxSummaryResult = {
-     *   key: 'key',
-     *   label: 'label',
-     *   defaultFormatting: true
-     * }
-     * ```
-     *
-     * @memberof IgxSummaryResult
      */
     public defaultFormatting?: boolean;
   

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

@@ -16,11 +16,6 @@ import { IgcSummaryResult } from './igc-summary-result';
     /**
      * 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;
 
@@ -29,17 +24,11 @@ import { IgcSummaryResult } from './igc-summary-result';
     /**
      * 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-base-component.d.ts

@@ -0,0 +1,226 @@
+
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+import { IgcTreeGridRecord } from './igc-tree-grid-record';
+import { IgcRenderFunction } from './common';
+import { IgcCellType } from './igc-cell-type';
+import { IgcRowType } from './igc-row-type';
+import { IgcGridBaseDirectiveEventMap } from './igc-grid-base-directive';
+
+
+/* wcSkipComponentSuffix */
+
+
+/* wcAlternateName: TreeGridBase */
+/* blazorIndirectRender
+   blazorComponent
+   omitModule
+   wcSkipComponentSuffix */
+/**
+ * **Ignite UI for Angular Tree Grid** -
+ * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid)
+ * The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and
+ * provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding.
+ * Example:
+ */
+
+    export declare class IgcTreeGridBaseComponent extends IgcGridBaseDirective
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+    /**
+     * Sets the child data key of the tree grid.
+     */
+    public set childDataKey(value: string);
+          public get childDataKey(): string;
+  
+          
+
+    /**
+     * Sets the foreign key of the tree grid.
+     */
+    public set foreignKey(value: string);
+          public get foreignKey(): string;
+  
+          
+
+    /**
+     * Sets the key indicating whether a row has children.
+     * This property is only used for load on demand scenarios.
+     */
+    public set hasChildrenKey(value: string);
+          public get hasChildrenKey(): string;
+  
+          
+
+    /**
+     * Sets whether child records should be deleted when their parent gets deleted.
+     * By default it is set to true and deletes all children along with the parent.
+     */
+    public set cascadeOnDelete(value: boolean);
+          public get cascadeOnDelete(): boolean;
+  
+          
+
+    /* csSuppress */
+    /**
+     * Sets a callback for loading child rows on demand.
+     */
+    public set loadChildrenOnDemand(value: any);
+          public get loadChildrenOnDemand(): any;
+  
+          
+
+    /**
+     * Sets the value of the `id` attribute. If not provided it will be automatically generated.
+     */
+    public set id(value: string);
+          public get id(): string;
+  
+          
+
+    /**
+     * Returns an array of the root level `ITreeGridRecord`s.
+     */
+    public set rootRecords(value: IgcTreeGridRecord[]);
+          public get rootRecords(): IgcTreeGridRecord[];
+  
+          
+
+    /**
+     * Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s.
+     */
+    public set processedRootRecords(value: IgcTreeGridRecord[]);
+          public get processedRootRecords(): IgcTreeGridRecord[];
+  
+          
+
+    /* treatAsRef */
+    /**
+     * Gets/Sets the array of data that populates the component.
+     */
+    public set data(value: any[]);
+          public get data(): any[];
+  
+          
+
+    /**
+     * Sets the count of levels to be expanded in the tree grid. By default it is
+     * set to `Infinity` which means all levels would be expanded.
+     */
+    public set expansionDepth(value: number);
+          public get expansionDepth(): number;
+  
+          
+
+    /**
+     * Template for the row loading indicator when load on demand is enabled.
+     */
+    public set rowLoadingIndicatorTemplate(value: IgcRenderFunction<void>);
+          public get rowLoadingIndicatorTemplate(): IgcRenderFunction<void>;
+  
+                
+
+    /**
+     * Returns an array of the selected grid cells.
+     */
+    public get selectedCells(): IgcCellType[];
+        
+            
+
+    public getDefaultExpandState(record: IgcTreeGridRecord): boolean;
+
+            
+
+    /**
+     * Expands all rows.
+     */
+    public expandAll(): void;
+
+            
+
+    /**
+     * Collapses all rows.
+     */
+    public collapseAll(): void;
+
+            
+
+    /* blazorCSSuppress */
+    /**
+     * Creates a new tree grid row 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
+     * the specified parentRowID. If the parentRowID does not exist, an error would be thrown.
+     * @param data
+     * @param parentRowID
+     */
+    // TODO: remove evt emission
+    public addRow(data: any, parentRowID?: any): void;
+
+            
+
+    /**
+     * Enters add mode by spawning the UI with the context of the specified row by index.
+     * @param index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
+     * @param asChild - Whether the record should be added as a child. Only applicable to igxTreeGrid.
+     */
+    public beginAddRowByIndex(index: number, asChild?: boolean): void;
+
+            
+
+    /**
+     * Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.
+     */
+    public getSelectedData(formatters?: boolean, headers?: boolean): any[];
+
+            
+
+    /**
+     * Returns the tree grid row by index.
+     * @param index
+     */
+    public getRowByIndex(index: number): IgcRowType;
+
+            
+
+    /**
+     * Returns the `RowType` object by the specified primary key.
+     * @param index
+     */
+    public getRowByKey(key: any): IgcRowType;
+
+            
+
+    /**
+     * Returns a `CellType` object that matches the conditions.
+     * @param rowIndex
+     * @param columnField
+     */
+    public getCellByColumn(rowIndex: number, columnField: string): IgcCellType;
+
+            
+
+    /**
+     * Returns a `CellType` object that matches the conditions.
+     * @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;
+
+    }
+
+export type IgcTreeGridBaseComponentEventMap = IgcGridBaseDirectiveEventMap
+