igniteui-angular 22.0.0-rc.1 → 22.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/igniteui-angular-accordion.mjs +1 -1
- package/fesm2022/igniteui-angular-accordion.mjs.map +1 -1
- package/fesm2022/igniteui-angular-action-strip.mjs +1 -1
- package/fesm2022/igniteui-angular-action-strip.mjs.map +1 -1
- package/fesm2022/igniteui-angular-button-group.mjs +1 -1
- package/fesm2022/igniteui-angular-button-group.mjs.map +1 -1
- package/fesm2022/igniteui-angular-calendar.mjs +1 -1
- package/fesm2022/igniteui-angular-calendar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-card.mjs +6 -6
- package/fesm2022/igniteui-angular-card.mjs.map +1 -1
- package/fesm2022/igniteui-angular-carousel.mjs +6 -6
- package/fesm2022/igniteui-angular-carousel.mjs.map +1 -1
- package/fesm2022/igniteui-angular-chips.mjs +34 -34
- package/fesm2022/igniteui-angular-chips.mjs.map +1 -1
- package/fesm2022/igniteui-angular-core.mjs +6 -6
- package/fesm2022/igniteui-angular-core.mjs.map +1 -1
- package/fesm2022/igniteui-angular-date-picker.mjs +2 -2
- package/fesm2022/igniteui-angular-date-picker.mjs.map +1 -1
- package/fesm2022/igniteui-angular-directives.mjs +12 -12
- package/fesm2022/igniteui-angular-directives.mjs.map +1 -1
- package/fesm2022/igniteui-angular-drop-down.mjs +5 -5
- package/fesm2022/igniteui-angular-drop-down.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-core.mjs +26 -23
- package/fesm2022/igniteui-angular-grids-core.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-grid.mjs +51 -51
- package/fesm2022/igniteui-angular-grids-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-hierarchical-grid.mjs +7 -7
- package/fesm2022/igniteui-angular-grids-hierarchical-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-tree-grid.mjs +5 -5
- package/fesm2022/igniteui-angular-grids-tree-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-icon.mjs +4 -4
- package/fesm2022/igniteui-angular-icon.mjs.map +1 -1
- package/fesm2022/igniteui-angular-input-group.mjs +18 -18
- package/fesm2022/igniteui-angular-input-group.mjs.map +1 -1
- package/fesm2022/igniteui-angular-list.mjs +5 -5
- package/fesm2022/igniteui-angular-list.mjs.map +1 -1
- package/fesm2022/igniteui-angular-navbar.mjs +5 -5
- package/fesm2022/igniteui-angular-navbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-paginator.mjs +2 -2
- package/fesm2022/igniteui-angular-paginator.mjs.map +1 -1
- package/fesm2022/igniteui-angular-progressbar.mjs +7 -7
- package/fesm2022/igniteui-angular-progressbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-query-builder.mjs +2 -2
- package/fesm2022/igniteui-angular-query-builder.mjs.map +1 -1
- package/fesm2022/igniteui-angular-radio.mjs +5 -5
- package/fesm2022/igniteui-angular-radio.mjs.map +1 -1
- package/fesm2022/igniteui-angular-select.mjs +217 -209
- package/fesm2022/igniteui-angular-select.mjs.map +1 -1
- package/fesm2022/igniteui-angular-slider.mjs +17 -17
- package/fesm2022/igniteui-angular-slider.mjs.map +1 -1
- package/fesm2022/igniteui-angular-snackbar.mjs +1 -1
- package/fesm2022/igniteui-angular-snackbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-splitter.mjs +2 -2
- package/fesm2022/igniteui-angular-splitter.mjs.map +1 -1
- package/fesm2022/igniteui-angular-stepper.mjs +2 -2
- package/fesm2022/igniteui-angular-stepper.mjs.map +1 -1
- package/fesm2022/igniteui-angular-time-picker.mjs +1 -1
- package/fesm2022/igniteui-angular-time-picker.mjs.map +1 -1
- package/fesm2022/igniteui-angular-tree.mjs +1 -1
- package/fesm2022/igniteui-angular-tree.mjs.map +1 -1
- package/input-group/README.md +1 -1
- package/migrations/migration-collection.json +5 -0
- package/migrations/update-22_0_0/index.d.ts +3 -0
- package/migrations/update-22_0_0/index.js +86 -0
- package/migrations/update-22_0_0/index.spec.d.ts +1 -0
- package/migrations/update-22_0_0/index.spec.js +116 -0
- package/package.json +1 -1
- package/types/igniteui-angular-accordion.d.ts +3 -3
- package/types/igniteui-angular-action-strip.d.ts +1 -1
- package/types/igniteui-angular-button-group.d.ts +1 -1
- package/types/igniteui-angular-calendar.d.ts +1 -1
- package/types/igniteui-angular-card.d.ts +6 -6
- package/types/igniteui-angular-carousel.d.ts +6 -6
- package/types/igniteui-angular-chips.d.ts +38 -38
- package/types/igniteui-angular-core.d.ts +9 -9
- package/types/igniteui-angular-date-picker.d.ts +4 -4
- package/types/igniteui-angular-directives.d.ts +15 -15
- package/types/igniteui-angular-drop-down.d.ts +6 -6
- package/types/igniteui-angular-grids-core.d.ts +30 -29
- package/types/igniteui-angular-grids-grid.d.ts +51 -51
- package/types/igniteui-angular-grids-hierarchical-grid.d.ts +7 -7
- package/types/igniteui-angular-grids-tree-grid.d.ts +7 -7
- package/types/igniteui-angular-icon.d.ts +4 -4
- package/types/igniteui-angular-input-group.d.ts +17 -17
- package/types/igniteui-angular-list.d.ts +7 -7
- package/types/igniteui-angular-navbar.d.ts +7 -7
- package/types/igniteui-angular-paginator.d.ts +2 -2
- package/types/igniteui-angular-progressbar.d.ts +7 -7
- package/types/igniteui-angular-query-builder.d.ts +3 -3
- package/types/igniteui-angular-radio.d.ts +5 -5
- package/types/igniteui-angular-select.d.ts +91 -7
- package/types/igniteui-angular-slider.d.ts +17 -17
- package/types/igniteui-angular-snackbar.d.ts +1 -1
- package/types/igniteui-angular-splitter.d.ts +3 -3
- package/types/igniteui-angular-stepper.d.ts +2 -2
- package/types/igniteui-angular-time-picker.d.ts +1 -1
- package/types/igniteui-angular-tree.d.ts +2 -2
|
@@ -162,7 +162,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
162
162
|
get loadingGridTemplate(): TemplateRef<IgxGridTemplateContext>;
|
|
163
163
|
set loadingGridTemplate(template: TemplateRef<IgxGridTemplateContext>);
|
|
164
164
|
/**
|
|
165
|
-
* Get/Set
|
|
165
|
+
* Get/Set summary row height
|
|
166
166
|
*/
|
|
167
167
|
set summaryRowHeight(value: number);
|
|
168
168
|
get summaryRowHeight(): number;
|
|
@@ -281,7 +281,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
281
281
|
* Emitted when a cell is clicked.
|
|
282
282
|
*
|
|
283
283
|
* @remarks
|
|
284
|
-
* Returns the
|
|
284
|
+
* Returns the grid cell.
|
|
285
285
|
* @example
|
|
286
286
|
* ```html
|
|
287
287
|
* <igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
@@ -292,7 +292,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
292
292
|
* Emitted when a row is clicked.
|
|
293
293
|
*
|
|
294
294
|
* @remarks
|
|
295
|
-
* Returns the
|
|
295
|
+
* Returns the grid row.
|
|
296
296
|
* @example
|
|
297
297
|
* ```html
|
|
298
298
|
* <igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
@@ -321,7 +321,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
321
321
|
* Emitted when a cell is selected.
|
|
322
322
|
*
|
|
323
323
|
* @remarks
|
|
324
|
-
* Returns the
|
|
324
|
+
* Returns the grid cell.
|
|
325
325
|
* @example
|
|
326
326
|
* ```html
|
|
327
327
|
* <igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
@@ -329,7 +329,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
329
329
|
*/
|
|
330
330
|
selected: EventEmitter<IGridCellEventArgs>;
|
|
331
331
|
/**
|
|
332
|
-
* Emitted when
|
|
332
|
+
* Emitted when grid row is selected.
|
|
333
333
|
*
|
|
334
334
|
* @example
|
|
335
335
|
* ```html
|
|
@@ -338,7 +338,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
338
338
|
*/
|
|
339
339
|
rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>;
|
|
340
340
|
/**
|
|
341
|
-
* Emitted when
|
|
341
|
+
* Emitted when column is selected.
|
|
342
342
|
*
|
|
343
343
|
* @example
|
|
344
344
|
* ```html
|
|
@@ -347,7 +347,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
347
347
|
*/
|
|
348
348
|
columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>;
|
|
349
349
|
/**
|
|
350
|
-
* Emitted before
|
|
350
|
+
* Emitted before column is pinned.
|
|
351
351
|
*
|
|
352
352
|
* @remarks
|
|
353
353
|
* The index at which to insert the column may be changed through the `insertAtIndex` property.
|
|
@@ -362,7 +362,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
362
362
|
*/
|
|
363
363
|
columnPin: EventEmitter<IPinColumnCancellableEventArgs>;
|
|
364
364
|
/**
|
|
365
|
-
* Emitted after
|
|
365
|
+
* Emitted after column is pinned.
|
|
366
366
|
*
|
|
367
367
|
* @remarks
|
|
368
368
|
* The index that the column is inserted at may be changed through the `insertAtIndex` property.
|
|
@@ -538,7 +538,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
538
538
|
* Emitted when a row is added.
|
|
539
539
|
*
|
|
540
540
|
* @remarks
|
|
541
|
-
* Returns the data for the new
|
|
541
|
+
* Returns the data for the new grid row object.
|
|
542
542
|
* @example
|
|
543
543
|
* ```html
|
|
544
544
|
* <igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
@@ -584,7 +584,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
584
584
|
* Emitted after column is resized.
|
|
585
585
|
*
|
|
586
586
|
* @remarks
|
|
587
|
-
* Returns the
|
|
587
|
+
* Returns the column object's old and new width.
|
|
588
588
|
* @example
|
|
589
589
|
* ```html
|
|
590
590
|
* <igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
|
|
@@ -595,7 +595,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
595
595
|
* Emitted when a cell or row is right clicked.
|
|
596
596
|
*
|
|
597
597
|
* @remarks
|
|
598
|
-
* Returns the
|
|
598
|
+
* Returns the grid cell object if the immediate context menu target is a cell or an grid row otherwise.
|
|
599
599
|
* ```html
|
|
600
600
|
* <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
|
|
601
601
|
* ```
|
|
@@ -605,7 +605,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
605
605
|
* Emitted when a cell is double clicked.
|
|
606
606
|
*
|
|
607
607
|
* @remarks
|
|
608
|
-
* Returns the
|
|
608
|
+
* Returns the grid cell object.
|
|
609
609
|
* @example
|
|
610
610
|
* ```html
|
|
611
611
|
* <igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
|
|
@@ -638,7 +638,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
638
638
|
* Emitted when column moving starts.
|
|
639
639
|
*
|
|
640
640
|
* @remarks
|
|
641
|
-
* Returns the moved
|
|
641
|
+
* Returns the moved column object.
|
|
642
642
|
* @example
|
|
643
643
|
* ```html
|
|
644
644
|
* <igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
|
|
@@ -649,7 +649,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
649
649
|
* Emitted during the column moving operation.
|
|
650
650
|
*
|
|
651
651
|
* @remarks
|
|
652
|
-
* Returns the source and target
|
|
652
|
+
* Returns the source and target column objects. This event is cancelable.
|
|
653
653
|
* @example
|
|
654
654
|
* ```html
|
|
655
655
|
* <igx-grid (columnMoving)="moving($event)"></igx-grid>
|
|
@@ -660,7 +660,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
660
660
|
* Emitted when column moving ends.
|
|
661
661
|
*
|
|
662
662
|
* @remarks
|
|
663
|
-
* Returns the source and target
|
|
663
|
+
* Returns the source and target column objects.
|
|
664
664
|
* @example
|
|
665
665
|
* ```html
|
|
666
666
|
* <igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
|
|
@@ -1249,7 +1249,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
1249
1249
|
set resourceStrings(value: IGridResourceStrings);
|
|
1250
1250
|
get resourceStrings(): IGridResourceStrings;
|
|
1251
1251
|
/**
|
|
1252
|
-
* Gets/Sets the filtering logic of the
|
|
1252
|
+
* Gets/Sets the filtering logic of the grid.
|
|
1253
1253
|
*
|
|
1254
1254
|
* @remarks
|
|
1255
1255
|
* The default is AND.
|
|
@@ -1586,7 +1586,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
1586
1586
|
*/
|
|
1587
1587
|
get summariesRowList(): QueryList<any>;
|
|
1588
1588
|
/**
|
|
1589
|
-
* A list of
|
|
1589
|
+
* A list of grid row.
|
|
1590
1590
|
*
|
|
1591
1591
|
* @example
|
|
1592
1592
|
* ```typescript
|
|
@@ -1595,7 +1595,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
1595
1595
|
*/
|
|
1596
1596
|
get rowList(): QueryList<IgxRowDirective>;
|
|
1597
1597
|
/**
|
|
1598
|
-
* A list of currently rendered
|
|
1598
|
+
* A list of currently rendered grid row's.
|
|
1599
1599
|
*
|
|
1600
1600
|
* @example
|
|
1601
1601
|
* ```typescript
|
|
@@ -1759,7 +1759,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
1759
1759
|
*
|
|
1760
1760
|
* @remarks
|
|
1761
1761
|
* By default the row selection mode is 'none'
|
|
1762
|
-
* Note that in
|
|
1762
|
+
* Note that in grid and hierarchical grid 'multipleCascade' behaves like 'multiple'
|
|
1763
1763
|
*/
|
|
1764
1764
|
get rowSelection(): GridSelectionMode;
|
|
1765
1765
|
set rowSelection(selectionMode: GridSelectionMode);
|
|
@@ -2495,7 +2495,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2495
2495
|
*/
|
|
2496
2496
|
get summariesMargin(): number;
|
|
2497
2497
|
/**
|
|
2498
|
-
* Gets an array of
|
|
2498
|
+
* Gets an array of columns.
|
|
2499
2499
|
*
|
|
2500
2500
|
* @example
|
|
2501
2501
|
* ```typescript
|
|
@@ -2504,7 +2504,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2504
2504
|
*/
|
|
2505
2505
|
get columns(): IgxColumnComponent[];
|
|
2506
2506
|
/**
|
|
2507
|
-
* Gets an array of the pinned
|
|
2507
|
+
* Gets an array of the pinned columns.
|
|
2508
2508
|
*
|
|
2509
2509
|
* @example
|
|
2510
2510
|
* ```typescript
|
|
@@ -2513,7 +2513,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2513
2513
|
*/
|
|
2514
2514
|
get pinnedColumns(): IgxColumnComponent[];
|
|
2515
2515
|
/**
|
|
2516
|
-
* Gets an array of the pinned to the left
|
|
2516
|
+
* Gets an array of the pinned to the left columns.
|
|
2517
2517
|
*
|
|
2518
2518
|
* @example
|
|
2519
2519
|
* ```typescript
|
|
@@ -2522,7 +2522,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2522
2522
|
*/
|
|
2523
2523
|
get pinnedStartColumns(): IgxColumnComponent[];
|
|
2524
2524
|
/**
|
|
2525
|
-
* Gets an array of the pinned to the right
|
|
2525
|
+
* Gets an array of the pinned to the right columns.
|
|
2526
2526
|
*
|
|
2527
2527
|
* @example
|
|
2528
2528
|
* ```typescript
|
|
@@ -2531,7 +2531,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2531
2531
|
*/
|
|
2532
2532
|
get pinnedEndColumns(): IgxColumnComponent[];
|
|
2533
2533
|
/**
|
|
2534
|
-
* Gets an array of the pinned
|
|
2534
|
+
* Gets an array of the pinned rows.
|
|
2535
2535
|
*
|
|
2536
2536
|
* @example
|
|
2537
2537
|
* ```typescript
|
|
@@ -2540,7 +2540,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2540
2540
|
*/
|
|
2541
2541
|
get pinnedRows(): IgxGridRowComponent[];
|
|
2542
2542
|
/**
|
|
2543
|
-
* Gets an array of unpinned
|
|
2543
|
+
* Gets an array of unpinned columns.
|
|
2544
2544
|
*
|
|
2545
2545
|
* @example
|
|
2546
2546
|
* ```typescript
|
|
@@ -2549,11 +2549,11 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2549
2549
|
*/
|
|
2550
2550
|
get unpinnedColumns(): IgxColumnComponent[];
|
|
2551
2551
|
/**
|
|
2552
|
-
* Gets the `width` to be set on
|
|
2552
|
+
* Gets the `width` to be set on grid header group.
|
|
2553
2553
|
*/
|
|
2554
2554
|
getHeaderGroupWidth(column: IgxColumnComponent): string;
|
|
2555
2555
|
/**
|
|
2556
|
-
* Returns the
|
|
2556
|
+
* Returns the column by field name.
|
|
2557
2557
|
*
|
|
2558
2558
|
* @example
|
|
2559
2559
|
* ```typescript
|
|
@@ -2573,7 +2573,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2573
2573
|
*/
|
|
2574
2574
|
recalculateAutoSizes(): void;
|
|
2575
2575
|
/**
|
|
2576
|
-
* Returns an array of visible
|
|
2576
|
+
* Returns an array of visible columns.
|
|
2577
2577
|
*
|
|
2578
2578
|
* @example
|
|
2579
2579
|
* ```typescript
|
|
@@ -2630,7 +2630,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2630
2630
|
*/
|
|
2631
2631
|
moveColumn(column: IgxColumnComponent, target: IgxColumnComponent, pos?: DropPosition): void;
|
|
2632
2632
|
/**
|
|
2633
|
-
* Triggers change detection for the
|
|
2633
|
+
* Triggers change detection for the grid.
|
|
2634
2634
|
* Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed.
|
|
2635
2635
|
* May degrade performance if used when not needed, or if misused:
|
|
2636
2636
|
* ```typescript
|
|
@@ -2657,7 +2657,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2657
2657
|
*/
|
|
2658
2658
|
markForCheck(): void;
|
|
2659
2659
|
/**
|
|
2660
|
-
* Creates a new
|
|
2660
|
+
* Creates a new grid row and adds the data record to the end of the data source.
|
|
2661
2661
|
*
|
|
2662
2662
|
* @example
|
|
2663
2663
|
* ```typescript
|
|
@@ -2667,7 +2667,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2667
2667
|
*/
|
|
2668
2668
|
addRow(data: any): void;
|
|
2669
2669
|
/**
|
|
2670
|
-
* Removes the
|
|
2670
|
+
* Removes the grid row and the corresponding data record by primary key.
|
|
2671
2671
|
*
|
|
2672
2672
|
* @remarks
|
|
2673
2673
|
* Requires that the `primaryKey` property is set.
|
|
@@ -2682,7 +2682,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2682
2682
|
/** @hidden */
|
|
2683
2683
|
deleteRowById(rowId: any): any;
|
|
2684
2684
|
/**
|
|
2685
|
-
* Updates the
|
|
2685
|
+
* Updates the grid row and the corresponding data record by primary key.
|
|
2686
2686
|
*
|
|
2687
2687
|
* @remarks
|
|
2688
2688
|
* Requires that the `primaryKey` property is set.
|
|
@@ -2696,7 +2696,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2696
2696
|
*/
|
|
2697
2697
|
updateCell(value: any, rowSelector: any, column: string): void;
|
|
2698
2698
|
/**
|
|
2699
|
-
* Updates the
|
|
2699
|
+
* Updates the grid row
|
|
2700
2700
|
*
|
|
2701
2701
|
* @remarks
|
|
2702
2702
|
* The row is specified by
|
|
@@ -2725,10 +2725,10 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2725
2725
|
*/
|
|
2726
2726
|
getRowData(rowSelector: any): any;
|
|
2727
2727
|
/**
|
|
2728
|
-
* Sort a single
|
|
2728
|
+
* Sort a single column.
|
|
2729
2729
|
*
|
|
2730
2730
|
* @remarks
|
|
2731
|
-
* Sort the
|
|
2731
|
+
* Sort the grid's column based on the provided array of sorting expressions.
|
|
2732
2732
|
* @example
|
|
2733
2733
|
* ```typescript
|
|
2734
2734
|
* this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
|
|
@@ -2736,7 +2736,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2736
2736
|
*/
|
|
2737
2737
|
sort(expression: ISortingExpression | Array<ISortingExpression>): void;
|
|
2738
2738
|
/**
|
|
2739
|
-
* Filters a single
|
|
2739
|
+
* Filters a single column.
|
|
2740
2740
|
*
|
|
2741
2741
|
* @example
|
|
2742
2742
|
* ```typescript
|
|
@@ -2751,7 +2751,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2751
2751
|
*/
|
|
2752
2752
|
filter(name: string, value: any, conditionOrExpressionTree?: IFilteringOperation | IFilteringExpressionsTree, ignoreCase?: boolean): void;
|
|
2753
2753
|
/**
|
|
2754
|
-
* Filters all the
|
|
2754
|
+
* Filters all the column in the grid with the same condition.
|
|
2755
2755
|
*
|
|
2756
2756
|
* @example
|
|
2757
2757
|
* ```typescript
|
|
@@ -2796,10 +2796,10 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2796
2796
|
*/
|
|
2797
2797
|
disableSummaries(...rest: any[]): void;
|
|
2798
2798
|
/**
|
|
2799
|
-
* If name is provided, clears the filtering state of the corresponding
|
|
2799
|
+
* If name is provided, clears the filtering state of the corresponding column.
|
|
2800
2800
|
*
|
|
2801
2801
|
* @remarks
|
|
2802
|
-
* Otherwise clears the filtering state of all
|
|
2802
|
+
* Otherwise clears the filtering state of all columns.
|
|
2803
2803
|
* @example
|
|
2804
2804
|
* ```typescript
|
|
2805
2805
|
* this.grid.clearFilter();
|
|
@@ -2808,10 +2808,10 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
2808
2808
|
*/
|
|
2809
2809
|
clearFilter(name?: string): void;
|
|
2810
2810
|
/**
|
|
2811
|
-
* If name is provided, clears the sorting state of the corresponding
|
|
2811
|
+
* If name is provided, clears the sorting state of the corresponding column.
|
|
2812
2812
|
*
|
|
2813
2813
|
* @remarks
|
|
2814
|
-
* otherwise clears the sorting state of all
|
|
2814
|
+
* otherwise clears the sorting state of all column.
|
|
2815
2815
|
* @example
|
|
2816
2816
|
* ```typescript
|
|
2817
2817
|
* this.grid.clearSort();
|
|
@@ -3251,7 +3251,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
3251
3251
|
*
|
|
3252
3252
|
* @remarks
|
|
3253
3253
|
* You can pass callback function as a third parameter of `getPreviousCell` method.
|
|
3254
|
-
* The callback function accepts
|
|
3254
|
+
* The callback function accepts column as a param
|
|
3255
3255
|
* @example
|
|
3256
3256
|
* ```typescript
|
|
3257
3257
|
* const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
|
|
@@ -3264,7 +3264,7 @@ declare abstract class IgxGridBaseDirective implements GridType, OnInit, DoCheck
|
|
|
3264
3264
|
*
|
|
3265
3265
|
* @remarks
|
|
3266
3266
|
* You can pass callback function as a third parameter of `getPreviousCell` method.
|
|
3267
|
-
* The callback function accepts
|
|
3267
|
+
* The callback function accepts column as a param
|
|
3268
3268
|
* @example
|
|
3269
3269
|
* ```typescript
|
|
3270
3270
|
* const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
|
|
@@ -3703,7 +3703,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
3703
3703
|
* The `groupingDone` event would be raised only once if several columns get grouped at once by calling
|
|
3704
3704
|
* the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.
|
|
3705
3705
|
* The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain
|
|
3706
|
-
* the `ISortingExpression` and the
|
|
3706
|
+
* the `ISortingExpression` and the column related to the grouping/ungrouping operation.
|
|
3707
3707
|
* Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last**
|
|
3708
3708
|
* grouping/ungrouping operation), not all columns which are currently grouped/ungrouped.
|
|
3709
3709
|
* columns.
|
|
@@ -3932,7 +3932,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
3932
3932
|
/**
|
|
3933
3933
|
* Gets/Sets the grouping strategy of the grid.
|
|
3934
3934
|
*
|
|
3935
|
-
* @remarks The default
|
|
3935
|
+
* @remarks The default grouping extends from sorting and a custom one can be used as a `sortStrategy` as well.
|
|
3936
3936
|
*
|
|
3937
3937
|
* @example
|
|
3938
3938
|
* ```html
|
|
@@ -4015,7 +4015,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
4015
4015
|
/** @hidden @internal */
|
|
4016
4016
|
trackChanges: (index: any, rec: any) => any;
|
|
4017
4017
|
/**
|
|
4018
|
-
* Groups by a new
|
|
4018
|
+
* Groups by a new column based on the provided expression, or modifies an existing one.
|
|
4019
4019
|
*
|
|
4020
4020
|
* @remarks
|
|
4021
4021
|
* Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.
|
|
@@ -4117,7 +4117,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
4117
4117
|
/** @hidden @internal */
|
|
4118
4118
|
get hasGroupableColumns(): boolean;
|
|
4119
4119
|
/**
|
|
4120
|
-
* Returns whether the
|
|
4120
|
+
* Returns whether the grid has group area.
|
|
4121
4121
|
*
|
|
4122
4122
|
* @example
|
|
4123
4123
|
* ```typescript
|
|
@@ -4181,7 +4181,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
4181
4181
|
*/
|
|
4182
4182
|
getSelectedData(formatters?: boolean, headers?: boolean): any[];
|
|
4183
4183
|
/**
|
|
4184
|
-
* Returns the
|
|
4184
|
+
* Returns the grid row by index.
|
|
4185
4185
|
*
|
|
4186
4186
|
* @example
|
|
4187
4187
|
* ```typescript
|
|
@@ -4191,7 +4191,7 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
4191
4191
|
*/
|
|
4192
4192
|
getRowByIndex(index: number): RowType;
|
|
4193
4193
|
/**
|
|
4194
|
-
* Returns
|
|
4194
|
+
* Returns grid row object by the specified primary key.
|
|
4195
4195
|
*
|
|
4196
4196
|
* @remarks
|
|
4197
4197
|
* Requires that the `primaryKey` property is set.
|
|
@@ -4207,13 +4207,13 @@ declare class IgxGridComponent extends IgxGridBaseDirective implements GridType,
|
|
|
4207
4207
|
*/
|
|
4208
4208
|
allRows(): RowType[];
|
|
4209
4209
|
/**
|
|
4210
|
-
* Returns the collection of
|
|
4210
|
+
* Returns the collection of grid rows for current page.
|
|
4211
4211
|
*
|
|
4212
4212
|
* @hidden @internal
|
|
4213
4213
|
*/
|
|
4214
4214
|
dataRows(): RowType[];
|
|
4215
4215
|
/**
|
|
4216
|
-
* Returns an array of the selected
|
|
4216
|
+
* Returns an array of the selected grid cells.
|
|
4217
4217
|
*
|
|
4218
4218
|
* @example
|
|
4219
4219
|
* ```typescript
|
|
@@ -338,7 +338,7 @@ declare class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective imp
|
|
|
338
338
|
private _toolbarTemplate;
|
|
339
339
|
private _paginatorTemplate;
|
|
340
340
|
/**
|
|
341
|
-
* Sets if all immediate children of the grids for this
|
|
341
|
+
* Sets if all immediate children of the grids for this row island should be expanded/collapsed.
|
|
342
342
|
* ```html
|
|
343
343
|
* <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
|
|
344
344
|
* <igx-row-island [key]="'childData'" [expandChildren]="true" #rowIsland>
|
|
@@ -351,7 +351,7 @@ declare class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective imp
|
|
|
351
351
|
*/
|
|
352
352
|
set expandChildren(value: boolean);
|
|
353
353
|
/**
|
|
354
|
-
* Gets if all immediate children of the grids for this
|
|
354
|
+
* Gets if all immediate children of the grids for this row island have been set to be expanded/collapsed.
|
|
355
355
|
* ```typescript
|
|
356
356
|
* const expanded = this.rowIsland.expandChildren;
|
|
357
357
|
* ```
|
|
@@ -610,7 +610,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
610
610
|
*/
|
|
611
611
|
set data(value: any[] | null);
|
|
612
612
|
/**
|
|
613
|
-
* Returns an array of data set to the
|
|
613
|
+
* Returns an array of data set to the hierarchical grid.
|
|
614
614
|
* ```typescript
|
|
615
615
|
* let filteredData = this.grid.filteredData;
|
|
616
616
|
* ```
|
|
@@ -636,7 +636,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
636
636
|
set totalItemCount(count: number);
|
|
637
637
|
get totalItemCount(): number;
|
|
638
638
|
/**
|
|
639
|
-
* Sets if all immediate children of the
|
|
639
|
+
* Sets if all immediate children of the hierarchical grid should be expanded/collapsed.
|
|
640
640
|
* Default value is false.
|
|
641
641
|
* ```html
|
|
642
642
|
* <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" [expandChildren]="true"></igx-hierarchical-grid>
|
|
@@ -646,7 +646,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
646
646
|
*/
|
|
647
647
|
set expandChildren(value: boolean);
|
|
648
648
|
/**
|
|
649
|
-
* Gets if all immediate children of the
|
|
649
|
+
* Gets if all immediate children of the hierarchical grid previously have been set to be expanded/collapsed.
|
|
650
650
|
* If previously set and some rows have been manually expanded/collapsed it will still return the last set value.
|
|
651
651
|
* ```typescript
|
|
652
652
|
* const expanded = this.grid.expandChildren;
|
|
@@ -743,13 +743,13 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
743
743
|
*/
|
|
744
744
|
allRows(): RowType[];
|
|
745
745
|
/**
|
|
746
|
-
* Returns the collection of
|
|
746
|
+
* Returns the collection of hierarchical grid rows for current page.
|
|
747
747
|
*
|
|
748
748
|
* @hidden @internal
|
|
749
749
|
*/
|
|
750
750
|
dataRows(): RowType[];
|
|
751
751
|
/**
|
|
752
|
-
* Returns an array of the selected
|
|
752
|
+
* Returns an array of the selected grid cells.
|
|
753
753
|
*
|
|
754
754
|
* @example
|
|
755
755
|
* ```typescript
|
|
@@ -63,7 +63,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
63
63
|
protected _diTransactions: HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
|
|
64
64
|
protected transactionFactory: IgxHierarchicalTransactionFactory;
|
|
65
65
|
/**
|
|
66
|
-
* Sets the child data key of the
|
|
66
|
+
* Sets the child data key of the tree grid.
|
|
67
67
|
* ```html
|
|
68
68
|
* <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" [autoGenerate]="true"></igx-tree-grid>
|
|
69
69
|
* ```
|
|
@@ -72,7 +72,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
72
72
|
*/
|
|
73
73
|
childDataKey: string;
|
|
74
74
|
/**
|
|
75
|
-
* Sets the foreign key of the
|
|
75
|
+
* Sets the foreign key of the tree grid.
|
|
76
76
|
* ```html
|
|
77
77
|
* <igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [autoGenerate]="true">
|
|
78
78
|
* </igx-tree-grid>
|
|
@@ -227,7 +227,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
227
227
|
*/
|
|
228
228
|
get transactions(): HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
|
|
229
229
|
/**
|
|
230
|
-
* Sets the count of levels to be expanded in the
|
|
230
|
+
* Sets the count of levels to be expanded in the tree grid. By default it is
|
|
231
231
|
* set to `Infinity` which means all levels would be expanded.
|
|
232
232
|
* ```html
|
|
233
233
|
* <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" expansionDepth="1" [autoGenerate]="true"></igx-tree-grid>
|
|
@@ -291,7 +291,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
291
291
|
*/
|
|
292
292
|
refreshGridState(args?: IRowDataEventArgs): void;
|
|
293
293
|
/**
|
|
294
|
-
* Creates a new
|
|
294
|
+
* Creates a new tree grid row with the given data. If a parentRowID is not specified, the newly created
|
|
295
295
|
* row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches
|
|
296
296
|
* the specified parentRowID. If the parentRowID does not exist, an error would be thrown.
|
|
297
297
|
* ```typescript
|
|
@@ -369,7 +369,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
369
369
|
/** @hidden */
|
|
370
370
|
deleteRowById(rowId: any): any;
|
|
371
371
|
/**
|
|
372
|
-
* Returns the
|
|
372
|
+
* Returns the tree grid row by index.
|
|
373
373
|
*
|
|
374
374
|
* @example
|
|
375
375
|
* ```typescript
|
|
@@ -395,13 +395,13 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
395
395
|
*/
|
|
396
396
|
allRows(): RowType[];
|
|
397
397
|
/**
|
|
398
|
-
* Returns the collection of
|
|
398
|
+
* Returns the collection of tree grid rows for current page.
|
|
399
399
|
*
|
|
400
400
|
* @hidden @internal
|
|
401
401
|
*/
|
|
402
402
|
dataRows(): RowType[];
|
|
403
403
|
/**
|
|
404
|
-
* Returns an array of the selected
|
|
404
|
+
* Returns an array of the selected grid cells.
|
|
405
405
|
*
|
|
406
406
|
* @example
|
|
407
407
|
* ```typescript
|
|
@@ -197,8 +197,8 @@ interface IgxIconLoadedEvent {
|
|
|
197
197
|
/**
|
|
198
198
|
* **Ignite UI for Angular Icon Service** -
|
|
199
199
|
*
|
|
200
|
-
* The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with
|
|
201
|
-
* In addition it could be used to associate a custom class to be applied on
|
|
200
|
+
* The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with icon.
|
|
201
|
+
* In addition it could be used to associate a custom class to be applied on icon according to given font-family.
|
|
202
202
|
*
|
|
203
203
|
* Example:
|
|
204
204
|
* ```typescript
|
|
@@ -245,7 +245,7 @@ declare class IgxIconService {
|
|
|
245
245
|
*/
|
|
246
246
|
set defaultFamily(family: IconFamily);
|
|
247
247
|
/**
|
|
248
|
-
* Registers a custom class to be applied to
|
|
248
|
+
* Registers a custom class to be applied to icon for a given font-family.
|
|
249
249
|
* ```typescript
|
|
250
250
|
* this.iconService.registerFamilyAlias('material', 'material-icons');
|
|
251
251
|
* ```
|
|
@@ -264,7 +264,7 @@ declare class IgxIconService {
|
|
|
264
264
|
/** @hidden @internal */
|
|
265
265
|
setRefsByTheme(theme: IgxTheme): void;
|
|
266
266
|
/**
|
|
267
|
-
* Creates a family to className relationship that is applied to the
|
|
267
|
+
* Creates a family to className relationship that is applied to the icon
|
|
268
268
|
* whenever that family name is used.
|
|
269
269
|
* ```typescript
|
|
270
270
|
* this.iconService.setFamily('material', { className: 'material-icons', type: 'liga' });
|