igniteui-webcomponents-grids 4.7.0 → 4.7.2-beta.0

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

@@ -0,0 +1,218 @@
+
+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 { IgcCellType } from './igc-cell-type';
+import { IgcRowType } from './igc-row-type';
+
+
+
+
+
+/* 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
+    {
+
+          
+
+    /* contentChildren */
+    /* blazorInclude */
+    /* blazorTreatAsCollection */
+    /* blazorCollectionName: RowIslandCollection */
+    /* ngQueryListName: childLayoutList */
+    /**
+     * @hidden
+     */
+    public set childLayoutList(value: IgcRowIslandComponent[]);
+          public get childLayoutList(): IgcRowIslandComponent[];
+  
+          
+
+    /**
+     * 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 */
+    /**
+     * An @Input property that lets you fill the `IgxHierarchicalGridComponent` with an array of data.
+     * ```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.
+     * Defult 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 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;
+
+    }
+
+
+        

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-page-cancellable-event-args.d.ts

@@ -9,12 +9,10 @@ import { IgcCancelableEventArgs } from './igc-cancelable-event-args';
     {
 
         
-    public set current(value: number);
-        public get current(): number;
+    public current: number;
 
         
-    public set next(value: number);
-        public get next(): number;
+    public next: number;
 
     }
 

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

@@ -9,12 +9,10 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     {
 
         
-    public set previous(value: number);
-        public get previous(): number;
+    public previous: number;
 
         
-    public set current(value: number);
-        public get current(): number;
+    public current: number;
 
     }
 

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

@@ -14,6 +14,8 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 /* wcElementTag: igc-paginator */
 /* blazorIndirectRender */
 /* contentParent: GridBaseDirective */
+/* contentParent: RowIsland */
+/* contentParent: HierarchicalGrid */
 /* jsonAPIManageCollectionInMarkup */
 /**
  * Paginator component description
@@ -99,6 +101,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
   
           
 
+    /* mustSetInCodePlatforms: WebComponents;Blazor;React */
     /**
      * An accessor that sets the resource strings.
      * By default it uses EN resources.

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

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

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

@@ -16,31 +16,27 @@ import { IgcColumnComponent } from './igc-column-component';
     {
 
         
-    public set column(value: IgcColumnComponent);
-        public get column(): IgcColumnComponent;
+    public 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;
+    public 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;
+    public isPinned: boolean;
 
         
     /**
      * Provides the ability to cancel the event.
      */
-    public set cancel(value: boolean);
-        public get cancel(): boolean;
+    public cancel: boolean;
 
     }
 

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

@@ -15,24 +15,21 @@ import { IgcColumnComponent } from './igc-column-component';
     {
 
         
-    public set column(value: IgcColumnComponent);
-        public get column(): IgcColumnComponent;
+    public 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;
+    public 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;
+    public isPinned: boolean;
 
     }
 

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

@@ -16,8 +16,7 @@ import { IgcRowType } from './igc-row-type';
      * The ID of the row, that was pinned/unpinned.
      *   ID is either the primaryKey value or the data record instance.
      */
-    public set rowID(value: any);
-        public get rowID(): any;
+    public rowID: any;
 
         
     public row?: IgcRowType;
@@ -28,8 +27,7 @@ import { IgcRowType } from './igc-row-type';
 
         
     /** Whether or not the row is pinned or unpinned. */
-    public set isPinned(value: boolean);
-        public get isPinned(): boolean;
+    public isPinned: boolean;
 
         
     /**
@@ -41,8 +39,7 @@ import { IgcRowType } from './igc-row-type';
     /**
      * Provides the ability to cancel the event.
      */
-    public set cancel(value: boolean);
-        public get cancel(): boolean;
+    public cancel: boolean;
 
     }
 

package/grids/lib/igc-pinning-config.d.ts

@@ -6,6 +6,7 @@ import { RowPinningPosition } from './row-pinning-position';
 /* jsonAPIPlainObject */
 
 
+/* marshalByValue */
 /**
  * An interface describing settings for row/column pinning position.
  */

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

@@ -13,8 +13,7 @@ import { IgcPivotConfiguration } from './igc-pivot-configuration';
 
         
     /** The new configuration. */
-    public set pivotConfiguration(value: IgcPivotConfiguration);
-        public get pivotConfiguration(): IgcPivotConfiguration;
+    public pivotConfiguration: IgcPivotConfiguration;
 
     }
 

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

@@ -8,12 +8,10 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     {
 
         
-    public set data(value: any);
-        public get data(): any;
+    public data: any;
 
         
-    public set primaryKey(value: any);
-        public get primaryKey(): any;
+    public primaryKey: any;
 
     }
 

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

@@ -10,16 +10,13 @@ import { IgcRowType } from './igc-row-type';
     {
 
         
-    public set dragDirective(value: any);
-        public get dragDirective(): any;
+    public dragDirective: any;
 
         
-    public set dragData(value: IgcRowType);
-        public get dragData(): IgcRowType;
+    public dragData: IgcRowType;
 
         
-    public set animation(value: boolean);
-        public get animation(): boolean;
+    public animation: boolean;
 
     }
 

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

@@ -9,19 +9,16 @@ import { IgcRowType } from './igc-row-type';
     {
 
         
-    public set dragDirective(value: any);
-        public get dragDirective(): any;
+    public dragDirective: any;
 
         
-    public set dragData(value: IgcRowType);
-        public get dragData(): IgcRowType;
+    public dragData: IgcRowType;
 
         
     /**
      * Provides the ability to cancel the event.
      */
-    public set cancel(value: boolean);
-        public get cancel(): boolean;
+    public cancel: boolean;
 
         
     /**

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

@@ -17,24 +17,21 @@ import { IgcBaseEventArgs } from './igc-base-event-args';
     /**
      * Contains the exporting row data
      */
-    public set rowData(value: any);
-        public get rowData(): any;
+    public rowData: any;
 
         
 
     /**
      * Contains the exporting row index
      */
-    public set rowIndex(value: number);
-        public get rowIndex(): number;
+    public rowIndex: number;
 
         
 
     /**
      * Skip the exporting row when set to true
      */
-    public set cancel(value: boolean);
-        public get cancel(): boolean;
+    public cancel: boolean;
 
     }