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
|
@@ -833,7 +833,7 @@ interface AnimationPlayer {
|
|
|
833
833
|
|
|
834
834
|
/**
|
|
835
835
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position)
|
|
836
|
-
* Position strategies determine where to display the component in the provided
|
|
836
|
+
* Position strategies determine where to display the component in the provided overlay.
|
|
837
837
|
*/
|
|
838
838
|
interface IPositionStrategy {
|
|
839
839
|
/**
|
|
@@ -1146,7 +1146,7 @@ declare class IgxOverlayService implements OnDestroy {
|
|
|
1146
1146
|
|
|
1147
1147
|
/**
|
|
1148
1148
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll).
|
|
1149
|
-
* Scroll strategies determines how the scrolling will be handled in the provided
|
|
1149
|
+
* Scroll strategies determines how the scrolling will be handled in the provided overlay.
|
|
1150
1150
|
*/
|
|
1151
1151
|
interface IScrollStrategy {
|
|
1152
1152
|
/**
|
|
@@ -1583,7 +1583,7 @@ declare abstract class IgxActionStripActionsToken {
|
|
|
1583
1583
|
/**
|
|
1584
1584
|
* Templates the default toggle icon in the picker.
|
|
1585
1585
|
*
|
|
1586
|
-
* @remarks Can be applied to
|
|
1586
|
+
* @remarks Can be applied to date picker, time picker, date range picker
|
|
1587
1587
|
*
|
|
1588
1588
|
* @example
|
|
1589
1589
|
* ```html
|
|
@@ -1603,7 +1603,7 @@ declare class IgxPickerToggleComponent {
|
|
|
1603
1603
|
/**
|
|
1604
1604
|
* Templates the default clear icon in the picker.
|
|
1605
1605
|
*
|
|
1606
|
-
* @remarks Can be applied to
|
|
1606
|
+
* @remarks Can be applied to date picker, time picker, date range picker
|
|
1607
1607
|
*
|
|
1608
1608
|
* @example
|
|
1609
1609
|
* ```html
|
|
@@ -1619,9 +1619,9 @@ declare class IgxPickerClearComponent extends IgxPickerToggleComponent {
|
|
|
1619
1619
|
static ɵcmp: i0.ɵɵComponentDeclaration<IgxPickerClearComponent, "igx-picker-clear", never, {}, {}, never, ["*"], true, never>;
|
|
1620
1620
|
}
|
|
1621
1621
|
/**
|
|
1622
|
-
*
|
|
1622
|
+
* Picker actions can be used to re-template the dropdown/dialog action buttons.
|
|
1623
1623
|
*
|
|
1624
|
-
* @remarks Can be applied to
|
|
1624
|
+
* @remarks Can be applied to date picker, time picker, date range picker
|
|
1625
1625
|
*
|
|
1626
1626
|
*/
|
|
1627
1627
|
declare class IgxPickerActionsDirective {
|
|
@@ -2378,7 +2378,7 @@ interface ITreeGridRecord {
|
|
|
2378
2378
|
expanded?: boolean;
|
|
2379
2379
|
}
|
|
2380
2380
|
/**
|
|
2381
|
-
* Stub type for
|
|
2381
|
+
* Stub type for tree grid api - minimal interface for typing in core
|
|
2382
2382
|
*/
|
|
2383
2383
|
interface IgxTreeGridAPIService {
|
|
2384
2384
|
get_row_id(rowData: any): any;
|
|
@@ -3026,7 +3026,7 @@ declare class IgxSorting implements IGridSortingStrategy {
|
|
|
3026
3026
|
private prepareExpressions;
|
|
3027
3027
|
}
|
|
3028
3028
|
/**
|
|
3029
|
-
* Represents a class implementing the IGridGroupingStrategy interface and extending the
|
|
3029
|
+
* Represents a class implementing the IGridGroupingStrategy interface and extending the sorting class.
|
|
3030
3030
|
* It provides a method to group data based on the given grouping state.
|
|
3031
3031
|
*/
|
|
3032
3032
|
declare class IgxGrouping extends IgxSorting implements IGridGroupingStrategy {
|
|
@@ -3061,7 +3061,7 @@ declare class NoopSortingStrategy implements IGridSortingStrategy {
|
|
|
3061
3061
|
sort(data: any[]): any[];
|
|
3062
3062
|
}
|
|
3063
3063
|
/**
|
|
3064
|
-
* Represents a class extending the
|
|
3064
|
+
* Represents a class extending the sorting class
|
|
3065
3065
|
* Provides custom data record sorting.
|
|
3066
3066
|
*/
|
|
3067
3067
|
declare class IgxDataRecordSorting extends IgxSorting {
|
|
@@ -74,7 +74,7 @@ declare abstract class PickerBaseDirective implements IToggleView, EditorProvide
|
|
|
74
74
|
*/
|
|
75
75
|
mode: PickerInteractionMode;
|
|
76
76
|
/**
|
|
77
|
-
* Gets/Sets the orientation of the
|
|
77
|
+
* Gets/Sets the orientation of the date picker header.
|
|
78
78
|
*
|
|
79
79
|
* @example
|
|
80
80
|
* ```html
|
|
@@ -399,7 +399,7 @@ declare class IgxDatePickerComponent extends PickerBaseDirective implements Cont
|
|
|
399
399
|
*/
|
|
400
400
|
id: string;
|
|
401
401
|
/**
|
|
402
|
-
* Gets/Sets the format views of the
|
|
402
|
+
* Gets/Sets the format views of the date picker.
|
|
403
403
|
*
|
|
404
404
|
* @example
|
|
405
405
|
* ```typescript
|
|
@@ -431,7 +431,7 @@ declare class IgxDatePickerComponent extends PickerBaseDirective implements Cont
|
|
|
431
431
|
get specialDates(): DateRangeDescriptor[];
|
|
432
432
|
set specialDates(value: DateRangeDescriptor[]);
|
|
433
433
|
/**
|
|
434
|
-
* Gets/Sets the format options of the
|
|
434
|
+
* Gets/Sets the format options of the date picker.
|
|
435
435
|
*
|
|
436
436
|
* @example
|
|
437
437
|
* ```typescript
|
|
@@ -993,7 +993,7 @@ declare class IgxDateRangePickerComponent extends PickerBaseDirective implements
|
|
|
993
993
|
*/
|
|
994
994
|
get resourceStrings(): IDateRangePickerResourceStrings;
|
|
995
995
|
/**
|
|
996
|
-
* Sets the `placeholder` for single-input
|
|
996
|
+
* Sets the `placeholder` for single-input date range picker.
|
|
997
997
|
*
|
|
998
998
|
* @example
|
|
999
999
|
* ```html
|
|
@@ -150,7 +150,7 @@ declare class IgxButtonDirective extends IgxButtonBaseDirective {
|
|
|
150
150
|
protected emitSelected(): void;
|
|
151
151
|
/**
|
|
152
152
|
* Gets or sets whether the button is selected.
|
|
153
|
-
* Mainly used in the
|
|
153
|
+
* Mainly used in the button group component and it will have no effect if set separately.
|
|
154
154
|
*
|
|
155
155
|
* @example
|
|
156
156
|
* ```html
|
|
@@ -231,7 +231,7 @@ declare class CheckboxBaseDirective implements AfterViewInit {
|
|
|
231
231
|
ngControl: NgControl;
|
|
232
232
|
/**
|
|
233
233
|
* An event that is emitted after the checkbox state is changed.
|
|
234
|
-
* Provides references to the
|
|
234
|
+
* Provides references to the checkbox and the `checked` property as event arguments.
|
|
235
235
|
*/
|
|
236
236
|
readonly change: EventEmitter<IChangeCheckboxEventArgs>;
|
|
237
237
|
/**
|
|
@@ -1243,12 +1243,12 @@ declare class IgxDropDirective implements OnInit, OnDestroy {
|
|
|
1243
1243
|
*/
|
|
1244
1244
|
dropChannel: number | string | number[] | string[];
|
|
1245
1245
|
/**
|
|
1246
|
-
* Sets a drop strategy type that will be executed when an
|
|
1246
|
+
* Sets a drop strategy type that will be executed when an drag element is released inside
|
|
1247
1247
|
* the current drop area. The provided strategies are:
|
|
1248
|
-
* -
|
|
1249
|
-
* -
|
|
1250
|
-
* -
|
|
1251
|
-
* -
|
|
1248
|
+
* - default drop strategy - This is the default base strategy and it doesn't perform any actions.
|
|
1249
|
+
* - append drop strategy - Appends the dropped element to last position as a direct child to the `igxDrop`.
|
|
1250
|
+
* - prepend drop strategy - Prepends the dropped element to first position as a direct child to the `igxDrop`.
|
|
1251
|
+
* - insert drop strategy - If the dropped element is released above a child element of the `igxDrop`, it will be inserted
|
|
1252
1252
|
* at that position. Otherwise the dropped element will be appended if released outside any child of the `igxDrop`.
|
|
1253
1253
|
* ```html
|
|
1254
1254
|
* <div igxDrag>
|
|
@@ -1937,7 +1937,7 @@ declare class IgxForOfDirective<T, U extends T[] = T[]> extends IgxForOfToken<T,
|
|
|
1937
1937
|
* Asserts the correct type of the context for the template that `igxForOf` will render.
|
|
1938
1938
|
*
|
|
1939
1939
|
* The presence of this method is a signal to the Ivy template type-check compiler that the
|
|
1940
|
-
*
|
|
1940
|
+
* ForOf structural directive renders its template with a specific context type.
|
|
1941
1941
|
*/
|
|
1942
1942
|
static ngTemplateContextGuard<T, U extends T[]>(_dir: IgxForOfDirective<T, U>, ctx: any): ctx is IgxForOfContext<T, U>;
|
|
1943
1943
|
/**
|
|
@@ -2251,10 +2251,10 @@ declare class IgxGridForOfDirective<T, U extends T[] = T[]> extends IgxForOfDire
|
|
|
2251
2251
|
dataChanging: EventEmitter<IForOfDataChangeEventArgs>;
|
|
2252
2252
|
/**
|
|
2253
2253
|
* @hidden @internal
|
|
2254
|
-
* Asserts the correct type of the context for the template that
|
|
2254
|
+
* Asserts the correct type of the context for the template that Grid ForOf will render.
|
|
2255
2255
|
*
|
|
2256
2256
|
* The presence of this method is a signal to the Ivy template type-check compiler that the
|
|
2257
|
-
*
|
|
2257
|
+
* Grid ForOf structural directive renders its template with a specific context type.
|
|
2258
2258
|
*/
|
|
2259
2259
|
static ngTemplateContextGuard<T, U extends T[]>(_dir: IgxGridForOfDirective<T, U>, ctx: any): ctx is IgxGridForOfContext<T, U>;
|
|
2260
2260
|
ngOnInit(): void;
|
|
@@ -2290,7 +2290,7 @@ declare class IgxGridForOfDirective<T, U extends T[] = T[]> extends IgxForOfDire
|
|
|
2290
2290
|
*/
|
|
2291
2291
|
type IgxIconButtonType = typeof IgxBaseButtonType[keyof typeof IgxBaseButtonType];
|
|
2292
2292
|
/**
|
|
2293
|
-
* The
|
|
2293
|
+
* The icon button provides a way to use an icon as a fully functional button.
|
|
2294
2294
|
*
|
|
2295
2295
|
* @example
|
|
2296
2296
|
* ```html
|
|
@@ -3215,7 +3215,7 @@ declare class IgxToggleDirective implements IToggleView, OnInit, OnDestroy {
|
|
|
3215
3215
|
*/
|
|
3216
3216
|
get collapsed(): boolean;
|
|
3217
3217
|
/**
|
|
3218
|
-
* Identifier which is registered into
|
|
3218
|
+
* Identifier which is registered into navigation
|
|
3219
3219
|
*
|
|
3220
3220
|
* ```typescript
|
|
3221
3221
|
* let myToggleId = this.toggle.id;
|
|
@@ -3331,7 +3331,7 @@ declare class IgxToggleActionDirective implements OnInit {
|
|
|
3331
3331
|
* <!--set-->
|
|
3332
3332
|
* <div igxToggleAction [igxToggleOutlet]="outlet"></div>
|
|
3333
3333
|
* ```
|
|
3334
|
-
* Where
|
|
3334
|
+
* Where outlet is an instance of overlay outlet or a reference to the element.
|
|
3335
3335
|
*
|
|
3336
3336
|
* @deprecated in version 21.2.0. Overlays now use the HTML Popover API and no longer move to the document
|
|
3337
3337
|
* body by default, so using outlet is also no longer needed - just define the overlay in the intended
|
|
@@ -3819,7 +3819,7 @@ declare class IgxTooltipTargetDirective extends IgxToggleActionDirective impleme
|
|
|
3819
3819
|
*/
|
|
3820
3820
|
private _evaluateStickyState;
|
|
3821
3821
|
/**
|
|
3822
|
-
* Creates (if not already created) an instance of the
|
|
3822
|
+
* Creates (if not already created) an instance of the tooltip close button,
|
|
3823
3823
|
* and assigns it the provided custom template.
|
|
3824
3824
|
*/
|
|
3825
3825
|
private _createCloseTemplate;
|
|
@@ -4201,7 +4201,7 @@ declare abstract class IgxNotificationsDirective extends IgxToggleDirective impl
|
|
|
4201
4201
|
* Gets/Sets the container used for the element.
|
|
4202
4202
|
*
|
|
4203
4203
|
* @remarks
|
|
4204
|
-
*
|
|
4204
|
+
* Outlet is an instance of overlay outlet or a reference to the element.
|
|
4205
4205
|
*
|
|
4206
4206
|
* @deprecated in version 21.2.0. Overlays now use the HTML Popover API and no longer move to the document
|
|
4207
4207
|
* body by default, so using outlet is also no longer needed - just define the component in the intended
|
|
@@ -81,7 +81,7 @@ declare enum Navigate {
|
|
|
81
81
|
Up = -1,
|
|
82
82
|
Down = 1
|
|
83
83
|
}
|
|
84
|
-
/** Key actions that have designated handlers in
|
|
84
|
+
/** Key actions that have designated handlers in drop down */
|
|
85
85
|
declare const DropDownActionKey: {
|
|
86
86
|
readonly ESCAPE: "escape";
|
|
87
87
|
readonly ENTER: "enter";
|
|
@@ -99,7 +99,7 @@ interface ISelectionEventArgs extends CancelableEventArgs, IBaseEventArgs {
|
|
|
99
99
|
newSelection: IgxDropDownItemBaseDirective;
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Interface for an instance of
|
|
102
|
+
* Interface for an instance of drop down navigation
|
|
103
103
|
*
|
|
104
104
|
* @export
|
|
105
105
|
*/
|
|
@@ -279,7 +279,7 @@ declare class IgxDropDownItemBaseDirective implements DoCheck {
|
|
|
279
279
|
* </div>
|
|
280
280
|
* </igx-drop-down-item>
|
|
281
281
|
* ```
|
|
282
|
-
* **NOTE:** Drop-down items inside of a disabled
|
|
282
|
+
* **NOTE:** Drop-down items inside of a disabled drop down group will always count as disabled
|
|
283
283
|
*/
|
|
284
284
|
get disabled(): boolean;
|
|
285
285
|
set disabled(value: boolean);
|
|
@@ -392,7 +392,7 @@ declare class IgxDropDownItemComponent extends IgxDropDownItemBaseDirective {
|
|
|
392
392
|
/**
|
|
393
393
|
* An abstract class, defining a drop-down component, with:
|
|
394
394
|
* Properties for display styles and classes
|
|
395
|
-
* A collection items of type
|
|
395
|
+
* A collection items of type drop down item base
|
|
396
396
|
* Properties and methods for navigating (highlighting/focusing) items from the collection
|
|
397
397
|
* Properties and methods for selecting items from the collection
|
|
398
398
|
*/
|
|
@@ -498,7 +498,7 @@ declare abstract class IgxDropDownBaseDirective implements IDropDownList, OnInit
|
|
|
498
498
|
* @hidden @internal
|
|
499
499
|
* Gets the id of the focused item during dropdown navigation.
|
|
500
500
|
* This is used to update the `aria-activedescendant` attribute of
|
|
501
|
-
* the
|
|
501
|
+
* the drop down navigation host element.
|
|
502
502
|
*/
|
|
503
503
|
get activeDescendant(): string | null;
|
|
504
504
|
/**
|
|
@@ -564,7 +564,7 @@ declare abstract class IgxDropDownBaseDirective implements IDropDownList, OnInit
|
|
|
564
564
|
}
|
|
565
565
|
|
|
566
566
|
/**
|
|
567
|
-
* Navigation Directive that handles keyboard events on its host and controls a targeted
|
|
567
|
+
* Navigation Directive that handles keyboard events on its host and controls a targeted drop down base component
|
|
568
568
|
*/
|
|
569
569
|
declare class IgxDropDownItemNavigationDirective implements IDropDownNavigationDirective {
|
|
570
570
|
dropdown: IgxDropDownBaseDirective;
|
|
@@ -131,7 +131,7 @@ declare abstract class IgxExporterOptionsBase {
|
|
|
131
131
|
*/
|
|
132
132
|
ignoreFiltering: boolean;
|
|
133
133
|
/**
|
|
134
|
-
* Specifies if the exporter should ignore the current column order in the
|
|
134
|
+
* Specifies if the exporter should ignore the current column order in the grid.
|
|
135
135
|
* ```typescript
|
|
136
136
|
* let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder;
|
|
137
137
|
* this.exportOptions.ignoreColumnsOrder = true;
|
|
@@ -141,7 +141,7 @@ declare abstract class IgxExporterOptionsBase {
|
|
|
141
141
|
*/
|
|
142
142
|
ignoreColumnsOrder: boolean;
|
|
143
143
|
/**
|
|
144
|
-
* Specifies whether the exported data should be sorted as in the provided
|
|
144
|
+
* Specifies whether the exported data should be sorted as in the provided grid.
|
|
145
145
|
* When you export grouped data, setting ignoreSorting to true will cause
|
|
146
146
|
* the grouping to fail because it relies on the sorting of the records.
|
|
147
147
|
* ```typescript
|
|
@@ -153,7 +153,7 @@ declare abstract class IgxExporterOptionsBase {
|
|
|
153
153
|
*/
|
|
154
154
|
ignoreSorting: boolean;
|
|
155
155
|
/**
|
|
156
|
-
* Specifies whether the exported data should be grouped as in the provided
|
|
156
|
+
* Specifies whether the exported data should be grouped as in the provided grid.
|
|
157
157
|
* ```typescript
|
|
158
158
|
* let ignoreGrouping = this.exportOptions.ignoreGrouping;
|
|
159
159
|
* this.exportOptions.ignoreGrouping = true;
|
|
@@ -163,7 +163,7 @@ declare abstract class IgxExporterOptionsBase {
|
|
|
163
163
|
*/
|
|
164
164
|
ignoreGrouping: boolean;
|
|
165
165
|
/**
|
|
166
|
-
* Specifies whether the exported data should include multi column headers as in the provided
|
|
166
|
+
* Specifies whether the exported data should include multi column headers as in the provided grid.
|
|
167
167
|
* ```typescript
|
|
168
168
|
* let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders;
|
|
169
169
|
* this.exportOptions.ignoreMultiColumnHeaders = true;
|
|
@@ -379,7 +379,7 @@ declare abstract class IgxBaseExporter {
|
|
|
379
379
|
private ownerGrid;
|
|
380
380
|
private i18nFormatter;
|
|
381
381
|
/**
|
|
382
|
-
* Method for exporting
|
|
382
|
+
* Method for exporting grid component's data.
|
|
383
383
|
* ```typescript
|
|
384
384
|
* this.exporterService.export(this.igxGridForExport, this.exportOptions);
|
|
385
385
|
* ```
|
|
@@ -682,14 +682,14 @@ interface IGridToolbarExportEventArgs extends IBaseEventArgs {
|
|
|
682
682
|
grid: GridType;
|
|
683
683
|
/**
|
|
684
684
|
* The `exporter` is a base service.
|
|
685
|
-
* The type (an abstract class
|
|
685
|
+
* The type (an abstract class base exporter) has it's own properties and methods
|
|
686
686
|
* It is used to define the format and options of the export, the exported element
|
|
687
687
|
* and methods for preparing the data from the elements for exporting
|
|
688
688
|
*/
|
|
689
689
|
exporter: IgxBaseExporter;
|
|
690
690
|
/**
|
|
691
691
|
* Represents the different settings, that can be given to an export
|
|
692
|
-
* The type (an abstract class
|
|
692
|
+
* The type (an abstract class exporter options base) has properties for column settings
|
|
693
693
|
* (whether they should be ignored) as well as method for generating a file name
|
|
694
694
|
*/
|
|
695
695
|
options: IgxExporterOptionsBase;
|
|
@@ -845,7 +845,7 @@ interface IGridScrollEventArgs extends IBaseEventArgs {
|
|
|
845
845
|
}
|
|
846
846
|
/**
|
|
847
847
|
* Event emitted when a checkbox in the checkbox
|
|
848
|
-
* list of an
|
|
848
|
+
* list of an column actions component is clicked.
|
|
849
849
|
*/
|
|
850
850
|
interface IColumnToggledEventArgs extends IBaseEventArgs {
|
|
851
851
|
/** The column that is toggled. */
|
|
@@ -1338,7 +1338,7 @@ interface IPivotAggregator {
|
|
|
1338
1338
|
aggregatorName?: PivotAggregationType;
|
|
1339
1339
|
/**
|
|
1340
1340
|
* Aggregator function can be a custom implementation of `PivotAggregation`, or
|
|
1341
|
-
* use predefined ones from
|
|
1341
|
+
* use predefined ones from pivot aggregate and its variants.
|
|
1342
1342
|
*/
|
|
1343
1343
|
aggregator?: PivotAggregation;
|
|
1344
1344
|
}
|
|
@@ -1415,7 +1415,7 @@ interface IPivotValue {
|
|
|
1415
1415
|
aggregateList?: IPivotAggregator[];
|
|
1416
1416
|
/** Enables/Disables a particular value from pivot aggregation. */
|
|
1417
1417
|
enabled: boolean;
|
|
1418
|
-
/** Allow conditionally styling of the
|
|
1418
|
+
/** Allow conditionally styling of the pivot grid cells. */
|
|
1419
1419
|
styles?: any;
|
|
1420
1420
|
/** Enables a data type specific template of the cells */
|
|
1421
1421
|
dataType?: GridColumnDataType;
|
|
@@ -2666,7 +2666,7 @@ declare abstract class IgxColumnActionsBaseDirective {
|
|
|
2666
2666
|
}
|
|
2667
2667
|
|
|
2668
2668
|
/**
|
|
2669
|
-
* Providing reference to
|
|
2669
|
+
* Providing reference to column actions:
|
|
2670
2670
|
* ```typescript
|
|
2671
2671
|
* @ViewChild('columnActions', { read: IgxColumnActionsComponent })
|
|
2672
2672
|
* public columnActions: IgxColumnActionsComponent;
|
|
@@ -2848,7 +2848,7 @@ declare class IgxColumnActionsComponent implements DoCheck {
|
|
|
2848
2848
|
* Gets the text of the button that unchecks all columns.
|
|
2849
2849
|
*
|
|
2850
2850
|
* @remarks
|
|
2851
|
-
* If unset it is obtained from the
|
|
2851
|
+
* If unset it is obtained from the column actions based derived directive applied.
|
|
2852
2852
|
* @example
|
|
2853
2853
|
* ```typescript
|
|
2854
2854
|
* let uncheckAllText = this.columnActions.uncheckAllText;
|
|
@@ -2868,7 +2868,7 @@ declare class IgxColumnActionsComponent implements DoCheck {
|
|
|
2868
2868
|
* Gets the text of the button that checks all columns.
|
|
2869
2869
|
*
|
|
2870
2870
|
* @remarks
|
|
2871
|
-
* If unset it is obtained from the
|
|
2871
|
+
* If unset it is obtained from the column actions based derived directive applied.
|
|
2872
2872
|
* @example
|
|
2873
2873
|
* ```typescript
|
|
2874
2874
|
* let uncheckAllText = this.columnActions.uncheckAllText;
|
|
@@ -2879,7 +2879,7 @@ declare class IgxColumnActionsComponent implements DoCheck {
|
|
|
2879
2879
|
* Sets the text of the button that checks all columns.
|
|
2880
2880
|
*
|
|
2881
2881
|
* @remarks
|
|
2882
|
-
* If unset it is obtained from the
|
|
2882
|
+
* If unset it is obtained from the column actions based derived directive applied.
|
|
2883
2883
|
* @example
|
|
2884
2884
|
* ```html
|
|
2885
2885
|
* <igx-column-actions [checkAllText]="'Hide All'"></igx-column-actions>
|
|
@@ -3312,7 +3312,7 @@ declare class IgxFilteringService implements OnDestroy {
|
|
|
3312
3312
|
clearFilter(field: string): void;
|
|
3313
3313
|
clear_filter(fieldName: string): void;
|
|
3314
3314
|
/**
|
|
3315
|
-
* Filters all the
|
|
3315
|
+
* Filters all the column in the grid with the same condition.
|
|
3316
3316
|
* @deprecated in version 19.0.0.
|
|
3317
3317
|
*/
|
|
3318
3318
|
filterGlobal(value: any, condition: any, ignoreCase?: any): void;
|
|
@@ -3605,7 +3605,7 @@ declare class IgxSummaryOperand {
|
|
|
3605
3605
|
*/
|
|
3606
3606
|
static count(data: any[]): number;
|
|
3607
3607
|
/**
|
|
3608
|
-
* Executes the static `count` method and returns
|
|
3608
|
+
* Executes the static `count` method and returns summary result[]`.
|
|
3609
3609
|
* ```typescript
|
|
3610
3610
|
* interface IgxSummaryResult {
|
|
3611
3611
|
* key: string;
|
|
@@ -3678,7 +3678,7 @@ declare class IgxNumberSummaryOperand extends IgxSummaryOperand {
|
|
|
3678
3678
|
*/
|
|
3679
3679
|
static average(data: any[]): number;
|
|
3680
3680
|
/**
|
|
3681
|
-
* Executes the static methods and returns
|
|
3681
|
+
* Executes the static methods and returns summary result[]`.
|
|
3682
3682
|
* ```typescript
|
|
3683
3683
|
* interface IgxSummaryResult {
|
|
3684
3684
|
* key: string;
|
|
@@ -3736,7 +3736,7 @@ declare class IgxDateSummaryOperand extends IgxSummaryOperand {
|
|
|
3736
3736
|
*/
|
|
3737
3737
|
static earliest(data: any[]): any;
|
|
3738
3738
|
/**
|
|
3739
|
-
* Executes the static methods and returns
|
|
3739
|
+
* Executes the static methods and returns summary result[]`.
|
|
3740
3740
|
* ```typescript
|
|
3741
3741
|
* interface IgxSummaryResult {
|
|
3742
3742
|
* key: string;
|
|
@@ -6155,6 +6155,7 @@ declare class IgxExcelStyleSearchComponent implements AfterViewInit, OnDestroy {
|
|
|
6155
6155
|
private onActionKeyDown;
|
|
6156
6156
|
private navigateItem;
|
|
6157
6157
|
private isIndexOutOfBounds;
|
|
6158
|
+
private isRemote;
|
|
6158
6159
|
static ɵfac: i0.ɵɵFactoryDeclaration<IgxExcelStyleSearchComponent, never>;
|
|
6159
6160
|
static ɵcmp: i0.ɵɵComponentDeclaration<IgxExcelStyleSearchComponent, "igx-excel-style-search", never, { "id": { "alias": "id"; "required": false; }; }, {}, never, never, true, never>;
|
|
6160
6161
|
}
|
|
@@ -7916,15 +7917,15 @@ declare class IgxGridStateBaseDirective {
|
|
|
7916
7917
|
private applyFeatures;
|
|
7917
7918
|
/**
|
|
7918
7919
|
* This method restores complex objects in the pivot dimensions
|
|
7919
|
-
* Like the
|
|
7920
|
+
* Like the pivot date dimension and filters.
|
|
7920
7921
|
*/
|
|
7921
7922
|
private restoreDimensions;
|
|
7922
7923
|
/**
|
|
7923
|
-
* This method restores the
|
|
7924
|
+
* This method restores the pivot date dimension with its default functions and resource strings.
|
|
7924
7925
|
*/
|
|
7925
7926
|
private restoreDateDimension;
|
|
7926
7927
|
/**
|
|
7927
|
-
* Returns if this is a
|
|
7928
|
+
* Returns if this is a pivot date dimension.
|
|
7928
7929
|
*/
|
|
7929
7930
|
private isDateDimension;
|
|
7930
7931
|
/**
|
|
@@ -8801,7 +8802,7 @@ declare abstract class BaseRow implements RowType {
|
|
|
8801
8802
|
*/
|
|
8802
8803
|
get deleted(): boolean;
|
|
8803
8804
|
/**
|
|
8804
|
-
* Returns if the row has child rows. Always return false for
|
|
8805
|
+
* Returns if the row has child rows. Always return false for grid row.
|
|
8805
8806
|
*/
|
|
8806
8807
|
get hasChildren(): boolean;
|
|
8807
8808
|
/**
|
|
@@ -8899,7 +8900,7 @@ declare class IgxTreeGridRow extends BaseRow implements RowType {
|
|
|
8899
8900
|
*/
|
|
8900
8901
|
get parent(): RowType;
|
|
8901
8902
|
/**
|
|
8902
|
-
* Returns true if child rows exist. Always return false for
|
|
8903
|
+
* Returns true if child rows exist. Always return false for grid row.
|
|
8903
8904
|
*/
|
|
8904
8905
|
get hasChildren(): boolean;
|
|
8905
8906
|
/**
|
|
@@ -8976,7 +8977,7 @@ declare class IgxGroupByRow implements RowType {
|
|
|
8976
8977
|
*/
|
|
8977
8978
|
grid: GridType;
|
|
8978
8979
|
/**
|
|
8979
|
-
* Returns always true, because this is in instance of an
|
|
8980
|
+
* Returns always true, because this is in instance of an group by row.
|
|
8980
8981
|
*/
|
|
8981
8982
|
isGroupByRow: boolean;
|
|
8982
8983
|
/**
|
|
@@ -9040,7 +9041,7 @@ declare class IgxSummaryRow implements RowType {
|
|
|
9040
9041
|
*/
|
|
9041
9042
|
grid: GridType;
|
|
9042
9043
|
/**
|
|
9043
|
-
* Returns always true, because this is in instance of an
|
|
9044
|
+
* Returns always true, because this is in instance of an group by row.
|
|
9044
9045
|
*/
|
|
9045
9046
|
isSummaryRow: boolean;
|
|
9046
9047
|
/**
|
|
@@ -9826,7 +9827,7 @@ declare class RowEditPositionStrategy extends ConnectedPositioningStrategy {
|
|
|
9826
9827
|
}
|
|
9827
9828
|
|
|
9828
9829
|
/**
|
|
9829
|
-
* Providing reference to
|
|
9830
|
+
* Providing reference to grid cell:
|
|
9830
9831
|
* ```typescript
|
|
9831
9832
|
* @ViewChild('grid', { read: IgxGridComponent })
|
|
9832
9833
|
* public grid: IgxGridComponent;
|
|
@@ -10828,7 +10829,7 @@ interface ICsvExportEndedEventArgs extends IBaseEventArgs {
|
|
|
10828
10829
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv)
|
|
10829
10830
|
*
|
|
10830
10831
|
* The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values format from
|
|
10831
|
-
* both raw data (array) or from an
|
|
10832
|
+
* both raw data (array) or from an grid.
|
|
10832
10833
|
*
|
|
10833
10834
|
* Example:
|
|
10834
10835
|
* ```typescript
|
|
@@ -10897,7 +10898,7 @@ interface IExcelExportEndedEventArgs extends IBaseEventArgs {
|
|
|
10897
10898
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html)
|
|
10898
10899
|
*
|
|
10899
10900
|
* The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data
|
|
10900
|
-
* (array) or from an
|
|
10901
|
+
* (array) or from an grid.
|
|
10901
10902
|
*
|
|
10902
10903
|
* Example:
|
|
10903
10904
|
* ```typescript
|
|
@@ -10940,7 +10941,7 @@ interface IPdfExportEndedEventArgs extends IBaseEventArgs {
|
|
|
10940
10941
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_pdf.html)
|
|
10941
10942
|
*
|
|
10942
10943
|
* The Ignite UI for Angular PDF Exporter service can export data in PDF format from both raw data
|
|
10943
|
-
* (array) or from an
|
|
10944
|
+
* (array) or from an grid.
|
|
10944
10945
|
*
|
|
10945
10946
|
* Example:
|
|
10946
10947
|
* ```typescript
|