igniteui-angular 17.2.6 → 17.2.8
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/esm2022/lib/calendar/month-picker/month-picker.component.mjs +9 -1
- package/esm2022/lib/combo/combo.common.mjs +4 -5
- package/esm2022/lib/core/density.mjs +2 -1
- package/esm2022/lib/core/utils.mjs +1 -9
- package/esm2022/lib/directives/for-of/for_of.directive.mjs +2 -2
- package/esm2022/lib/directives/for-of/for_of.sync.service.mjs +6 -1
- package/esm2022/lib/grids/common/events.mjs +1 -1
- package/esm2022/lib/grids/common/grid.interface.mjs +1 -1
- package/esm2022/lib/grids/common/strategy.mjs +2 -2
- package/esm2022/lib/grids/common/types.mjs +1 -1
- package/esm2022/lib/grids/grid-base.directive.mjs +41 -38
- package/esm2022/lib/grids/hierarchical-grid/hierarchical-grid.component.mjs +2 -2
- package/esm2022/lib/simple-combo/simple-combo.component.mjs +33 -8
- package/fesm2022/igniteui-angular.mjs +91 -59
- package/fesm2022/igniteui-angular.mjs.map +1 -1
- package/lib/core/density.d.ts +1 -0
- package/lib/core/styles/components/icon-button/_icon-button-theme.scss +1 -0
- package/lib/core/utils.d.ts +0 -8
- package/lib/grids/common/events.d.ts +30 -30
- package/lib/grids/common/grid.interface.d.ts +48 -48
- package/lib/grids/common/strategy.d.ts +1 -1
- package/lib/grids/common/types.d.ts +2 -2
- package/lib/grids/grid-base.directive.d.ts +2 -1
- package/package.json +1 -1
- package/styles/maps/igniteui-angular-dark.css.map +1 -1
- package/styles/maps/igniteui-angular.css.map +1 -1
- package/styles/maps/igniteui-bootstrap-dark.css.map +1 -1
- package/styles/maps/igniteui-bootstrap-light.css.map +1 -1
- package/styles/maps/igniteui-dark-green.css.map +1 -1
- package/styles/maps/igniteui-fluent-dark-excel.css.map +1 -1
- package/styles/maps/igniteui-fluent-dark-word.css.map +1 -1
- package/styles/maps/igniteui-fluent-dark.css.map +1 -1
- package/styles/maps/igniteui-fluent-light-excel.css.map +1 -1
- package/styles/maps/igniteui-fluent-light-word.css.map +1 -1
- package/styles/maps/igniteui-fluent-light.css.map +1 -1
- package/styles/maps/igniteui-indigo-dark.css.map +1 -1
- package/styles/maps/igniteui-indigo-light.css.map +1 -1
package/lib/core/density.d.ts
CHANGED
|
@@ -82,6 +82,7 @@ export declare class DisplayDensityBase implements DoCheck, OnInit {
|
|
|
82
82
|
protected getComponentDensityClass(baseStyleClass: string): string;
|
|
83
83
|
/**
|
|
84
84
|
* Sets the `--component-size` CSS variable based on the value of Display Density
|
|
85
|
+
* @hidden @internal
|
|
85
86
|
*/
|
|
86
87
|
getComponentSizeStyles(): "var(--ig-size, var(--ig-size-small))" | "var(--ig-size, var(--ig-size-medium))" | "var(--ig-size, var(--ig-size-large))";
|
|
87
88
|
static ɵfac: i0.ɵɵFactoryDeclaration<DisplayDensityBase, [{ optional: true; }, null]>;
|
package/lib/core/utils.d.ts
CHANGED
|
@@ -106,14 +106,6 @@ export declare const isDate: (value: any) => value is Date;
|
|
|
106
106
|
* @hidden
|
|
107
107
|
*/
|
|
108
108
|
export declare const isEqual: (obj1: any, obj2: any) => boolean;
|
|
109
|
-
/**
|
|
110
|
-
* Checks if provided variable is the value NaN
|
|
111
|
-
*
|
|
112
|
-
* @param value Value to check
|
|
113
|
-
* @returns true if provided variable is NaN
|
|
114
|
-
* @hidden
|
|
115
|
-
*/
|
|
116
|
-
export declare const isNaNvalue: (value: any) => boolean;
|
|
117
109
|
/**
|
|
118
110
|
* Utility service taking care of various utility functions such as
|
|
119
111
|
* detecting browser features, general cross browser DOM manipulation, etc.
|
|
@@ -9,11 +9,11 @@ import { ISortingExpression } from '../../data-operations/sorting-strategy';
|
|
|
9
9
|
import { IBaseSearchInfo } from '../../directives/text-highlight/text-highlight.directive';
|
|
10
10
|
/** The event arguments when data from a grid is being copied. */
|
|
11
11
|
export interface IGridClipboardEvent {
|
|
12
|
-
/** `data` can be of any type and
|
|
12
|
+
/** `data` can be of any type and refers to the data that is being copied/stored to the clipboard */
|
|
13
13
|
data: any[];
|
|
14
14
|
/**
|
|
15
|
-
* `cancel` returns whether an external event has
|
|
16
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
15
|
+
* `cancel` returns whether an external event has intercepted the copying
|
|
16
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
17
17
|
*/
|
|
18
18
|
cancel: boolean;
|
|
19
19
|
}
|
|
@@ -60,7 +60,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
|
|
|
60
60
|
rowData: any;
|
|
61
61
|
/**
|
|
62
62
|
* Represents the previous (before editing) value of the edited cell.
|
|
63
|
-
* It's used when the event has been
|
|
63
|
+
* It's used when the event has been stopped/exited.
|
|
64
64
|
*/
|
|
65
65
|
oldValue: any;
|
|
66
66
|
/**
|
|
@@ -86,7 +86,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
|
|
|
86
86
|
owner?: GridType;
|
|
87
87
|
/**
|
|
88
88
|
* Optional
|
|
89
|
-
* Indicates if the editing
|
|
89
|
+
* Indicates if the editing consists of adding a new row
|
|
90
90
|
*/
|
|
91
91
|
isAddRow?: boolean;
|
|
92
92
|
/**
|
|
@@ -140,7 +140,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
|
|
|
140
140
|
insertAtIndex: number;
|
|
141
141
|
/**
|
|
142
142
|
* Returns the actual pin state of the column.
|
|
143
|
-
* If pinning/unpinning is
|
|
143
|
+
* If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
|
|
144
144
|
*/
|
|
145
145
|
isPinned: boolean;
|
|
146
146
|
}
|
|
@@ -148,7 +148,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
|
|
|
148
148
|
* The event arguments before a column's pin state is changed.
|
|
149
149
|
* `insertAtIndex`specifies at which index in the pinned/unpinned area the column is inserted.
|
|
150
150
|
* Can be changed in the `columnPin` event.
|
|
151
|
-
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is
|
|
151
|
+
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is successful,
|
|
152
152
|
* the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
|
|
153
153
|
*/
|
|
154
154
|
export interface IPinColumnCancellableEventArgs extends IPinColumnEventArgs, CancelableEventArgs {
|
|
@@ -175,7 +175,7 @@ export interface IRowDataEventArgs extends IBaseEventArgs {
|
|
|
175
175
|
}
|
|
176
176
|
/** The event arguments when a column is being resized */
|
|
177
177
|
export interface IColumnResizeEventArgs extends IBaseEventArgs {
|
|
178
|
-
/** Represents the
|
|
178
|
+
/** Represents the information of the column that is being resized */
|
|
179
179
|
column: ColumnType;
|
|
180
180
|
/** Represents the old width of the column before the resizing */
|
|
181
181
|
prevWidth: string;
|
|
@@ -218,7 +218,7 @@ export interface IRowSelectionEventArgs extends CancelableEventArgs, IBaseEventA
|
|
|
218
218
|
readonly allRowsSelected?: boolean;
|
|
219
219
|
}
|
|
220
220
|
/**
|
|
221
|
-
* The event arguments when the selection state of a column is being
|
|
221
|
+
* The event arguments when the selection state of a column is being changed
|
|
222
222
|
* The event is cancelable
|
|
223
223
|
*/
|
|
224
224
|
export interface IColumnSelectionEventArgs extends CancelableEventArgs, IBaseEventArgs {
|
|
@@ -268,8 +268,8 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
|
|
|
268
268
|
*/
|
|
269
269
|
options: IgxExporterOptionsBase;
|
|
270
270
|
/**
|
|
271
|
-
* `cancel` returns whether the event has been
|
|
272
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
271
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
272
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
273
273
|
*/
|
|
274
274
|
cancel: boolean;
|
|
275
275
|
}
|
|
@@ -277,7 +277,7 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
|
|
|
277
277
|
export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
|
|
278
278
|
/**
|
|
279
279
|
* Represents the column that is being moved.
|
|
280
|
-
* The `ColumnType` contains the
|
|
280
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
281
281
|
*/
|
|
282
282
|
source: ColumnType;
|
|
283
283
|
}
|
|
@@ -285,12 +285,12 @@ export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
|
|
|
285
285
|
export interface IColumnMovingEventArgs extends IBaseEventArgs {
|
|
286
286
|
/**
|
|
287
287
|
* Represents the column that is being moved.
|
|
288
|
-
* The `ColumnType` contains the
|
|
288
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
289
289
|
*/
|
|
290
290
|
source: ColumnType;
|
|
291
291
|
/**
|
|
292
|
-
* `cancel` returns whether the event has been
|
|
293
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
292
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
293
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
294
294
|
*/
|
|
295
295
|
cancel: boolean;
|
|
296
296
|
}
|
|
@@ -298,17 +298,17 @@ export interface IColumnMovingEventArgs extends IBaseEventArgs {
|
|
|
298
298
|
export interface IColumnMovingEndEventArgs extends IBaseEventArgs {
|
|
299
299
|
/**
|
|
300
300
|
* The source of the event represents the column that is being moved.
|
|
301
|
-
* The `ColumnType` contains the
|
|
301
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
302
302
|
*/
|
|
303
303
|
source: ColumnType;
|
|
304
304
|
/**
|
|
305
305
|
* The target of the event represents the column, the source is being moved to.
|
|
306
|
-
* The `ColumnType` contains the
|
|
306
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
307
307
|
*/
|
|
308
308
|
target: ColumnType;
|
|
309
309
|
/**
|
|
310
|
-
* `cancel` returns whether the event has been
|
|
311
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
310
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
311
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
312
312
|
*/
|
|
313
313
|
cancel: boolean;
|
|
314
314
|
}
|
|
@@ -321,12 +321,12 @@ export interface IGridKeydownEventArgs extends IBaseEventArgs {
|
|
|
321
321
|
targetType: GridKeydownTargetType;
|
|
322
322
|
/** Represents the information and details of the object itself */
|
|
323
323
|
target: any;
|
|
324
|
-
/** Represents the original event, that
|
|
324
|
+
/** Represents the original event, that occurred. */
|
|
325
325
|
event: Event;
|
|
326
326
|
/**
|
|
327
327
|
* The event is cancelable
|
|
328
|
-
* `cancel` returns whether the event has been
|
|
329
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
328
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
329
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
330
330
|
*/
|
|
331
331
|
cancel: boolean;
|
|
332
332
|
}
|
|
@@ -335,7 +335,7 @@ export interface ICellPosition {
|
|
|
335
335
|
/** It returns the position (index) of the row, the cell is in */
|
|
336
336
|
rowIndex: number;
|
|
337
337
|
/**
|
|
338
|
-
* It returns the position (index) of the
|
|
338
|
+
* It returns the position (index) of the column, the cell is in
|
|
339
339
|
* Counts only the visible (non hidden) columns
|
|
340
340
|
*/
|
|
341
341
|
visibleColumnIndex: number;
|
|
@@ -363,7 +363,7 @@ export interface IRowDragStartEventArgs extends CancelableEventArgs, IBaseEventA
|
|
|
363
363
|
/** Represents the HTML element itself */
|
|
364
364
|
dragElement: HTMLElement;
|
|
365
365
|
}
|
|
366
|
-
/**
|
|
366
|
+
/** Represents event arguments related to the row's expansion state being changed in a grid */
|
|
367
367
|
export interface IRowToggleEventArgs extends IBaseEventArgs {
|
|
368
368
|
/**
|
|
369
369
|
* Represents the ID of the row that emitted the event (which state is changed)
|
|
@@ -378,13 +378,13 @@ export interface IRowToggleEventArgs extends IBaseEventArgs {
|
|
|
378
378
|
expanded: boolean;
|
|
379
379
|
/**
|
|
380
380
|
* Optional
|
|
381
|
-
* Represents the original event, that has triggered the
|
|
381
|
+
* Represents the original event, that has triggered the expansion/collapse
|
|
382
382
|
*/
|
|
383
383
|
event?: Event;
|
|
384
384
|
/**
|
|
385
385
|
* The event is cancelable
|
|
386
|
-
* `cancel` returns whether the event has been
|
|
387
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
386
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
387
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
388
388
|
*/
|
|
389
389
|
cancel: boolean;
|
|
390
390
|
}
|
|
@@ -427,7 +427,7 @@ export interface IColumnToggledEventArgs extends IBaseEventArgs {
|
|
|
427
427
|
/** The checked state after the action. */
|
|
428
428
|
checked: boolean;
|
|
429
429
|
}
|
|
430
|
-
/**
|
|
430
|
+
/** Emitted when the active node is changed */
|
|
431
431
|
export interface IActiveNodeChangeEventArgs extends IBaseEventArgs {
|
|
432
432
|
/** Represents the row index of the active node */
|
|
433
433
|
row: number;
|
|
@@ -458,7 +458,7 @@ export interface ISortingEventArgs extends IBaseEventArgs, CancelableEventArgs {
|
|
|
458
458
|
sortingExpressions?: ISortingExpression | Array<ISortingExpression>;
|
|
459
459
|
/**
|
|
460
460
|
* Optional
|
|
461
|
-
* Represents the
|
|
461
|
+
* Represents the grouping expressions applied to the grid.
|
|
462
462
|
* It can be a single grouping expression or an array of them
|
|
463
463
|
* The expression contains information like the sorting expression and criteria by which the elements will be grouped
|
|
464
464
|
*/
|
|
@@ -480,7 +480,7 @@ export interface IColumnVisibilityChangedEventArgs extends IBaseEventArgs {
|
|
|
480
480
|
/** Represents the column the event originated from */
|
|
481
481
|
column: any;
|
|
482
482
|
/**
|
|
483
|
-
* The new hidden state that the column will have, if operation is
|
|
483
|
+
* The new hidden state that the column will have, if operation is successful.
|
|
484
484
|
* Will be `true` when hiding and `false` when showing.
|
|
485
485
|
*/
|
|
486
486
|
newValue: boolean;
|
|
@@ -196,12 +196,12 @@ export interface RowType {
|
|
|
196
196
|
expanded?: boolean;
|
|
197
197
|
/**
|
|
198
198
|
* Optional
|
|
199
|
-
*
|
|
199
|
+
* Indicates whether the row is marked for deletion.
|
|
200
200
|
*/
|
|
201
201
|
deleted?: boolean;
|
|
202
202
|
/**
|
|
203
203
|
* Optional
|
|
204
|
-
*
|
|
204
|
+
* Indicates whether the row is currently being edited.
|
|
205
205
|
*/
|
|
206
206
|
inEditMode?: boolean;
|
|
207
207
|
/**
|
|
@@ -217,7 +217,7 @@ export interface RowType {
|
|
|
217
217
|
parent?: RowType;
|
|
218
218
|
/**
|
|
219
219
|
* Optional
|
|
220
|
-
*
|
|
220
|
+
* Indicates whether the current row has any child rows
|
|
221
221
|
*/
|
|
222
222
|
hasChildren?: boolean;
|
|
223
223
|
/**
|
|
@@ -229,7 +229,7 @@ export interface RowType {
|
|
|
229
229
|
addRowUI?: boolean;
|
|
230
230
|
/**
|
|
231
231
|
* Optional
|
|
232
|
-
*
|
|
232
|
+
* Indicates whether the row is currently focused.
|
|
233
233
|
*/
|
|
234
234
|
focused?: boolean;
|
|
235
235
|
/** Represent the grid instance, the row belongs to */
|
|
@@ -284,7 +284,7 @@ export interface FieldType {
|
|
|
284
284
|
* Contains definitions of properties and methods, relevant to a column
|
|
285
285
|
*/
|
|
286
286
|
export interface ColumnType extends FieldType {
|
|
287
|
-
/** Represents the
|
|
287
|
+
/** Represents the instance of the parent `GridType` that contains this column. */
|
|
288
288
|
grid: GridType;
|
|
289
289
|
/** A list, containing all the child columns under this column (if any). */
|
|
290
290
|
children: QueryList<ColumnType>;
|
|
@@ -303,12 +303,12 @@ export interface ColumnType extends FieldType {
|
|
|
303
303
|
validators: any[];
|
|
304
304
|
/**
|
|
305
305
|
* The template reference for the custom header of the column
|
|
306
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
306
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
307
307
|
*/
|
|
308
308
|
headerTemplate: TemplateRef<any>;
|
|
309
309
|
/**
|
|
310
310
|
* The template reference for the collapsible indicator of the column.
|
|
311
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
311
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
312
312
|
*/
|
|
313
313
|
collapsibleIndicatorTemplate?: TemplateRef<any>;
|
|
314
314
|
/** Represents custom CSS classes applied to the header element. When added, they take different styling */
|
|
@@ -320,7 +320,7 @@ export interface ColumnType extends FieldType {
|
|
|
320
320
|
/** Represents custom CSS styles applied to the header group. When added, they take different styling */
|
|
321
321
|
headerGroupStyles: any;
|
|
322
322
|
/**
|
|
323
|
-
* Custom CSS styling,
|
|
323
|
+
* Custom CSS styling, applied to every column
|
|
324
324
|
* calcWidth, minWidthPx, maxWidthPx, minWidth, maxWidth, minWidthPercent, maxWidthPercent, resolvedWidth
|
|
325
325
|
*/
|
|
326
326
|
calcWidth: any;
|
|
@@ -343,12 +343,12 @@ export interface ColumnType extends FieldType {
|
|
|
343
343
|
index: number;
|
|
344
344
|
/**
|
|
345
345
|
* Represents the type of data for the column:
|
|
346
|
-
* string, number,
|
|
346
|
+
* string, number, boolean, currency, date, time, etc.
|
|
347
347
|
*/
|
|
348
348
|
dataType: GridColumnDataType;
|
|
349
349
|
/**
|
|
350
350
|
* The template reference for the custom inline editor of the column
|
|
351
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
351
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
352
352
|
*/
|
|
353
353
|
inlineEditorTemplate: TemplateRef<any>;
|
|
354
354
|
/**
|
|
@@ -371,17 +371,17 @@ export interface ColumnType extends FieldType {
|
|
|
371
371
|
columnGroup: boolean;
|
|
372
372
|
/** @deprecated in version 13.1.0. Use the Grid's `moving` property instead. */
|
|
373
373
|
movable: boolean;
|
|
374
|
-
/**
|
|
374
|
+
/** Indicates whether a column can be put in a group. If the value is true, the column can be put in a group */
|
|
375
375
|
groupable: boolean;
|
|
376
|
-
/**
|
|
376
|
+
/** Indicates whether a column can be sorted. If the value is true, the column can be sorted. */
|
|
377
377
|
sortable: boolean;
|
|
378
|
-
/**
|
|
378
|
+
/** Indicates whether a column can be filtered. If the value is true, the column can be filtered */
|
|
379
379
|
filterable: boolean;
|
|
380
|
-
/**
|
|
380
|
+
/** Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible */
|
|
381
381
|
hidden: boolean;
|
|
382
|
-
/**
|
|
382
|
+
/** Indicates whether a column can be pinned. If the value is true, the column cannot be pinned */
|
|
383
383
|
disablePinning: boolean;
|
|
384
|
-
/**
|
|
384
|
+
/** Indicates whether a column can be hidden. If the value is true, the column cannot be hidden */
|
|
385
385
|
disableHiding: boolean;
|
|
386
386
|
/**
|
|
387
387
|
* The sorting strategy used for sorting this column.
|
|
@@ -405,7 +405,7 @@ export interface ColumnType extends FieldType {
|
|
|
405
405
|
summaries: any;
|
|
406
406
|
/**
|
|
407
407
|
* The template reference for a summary of the column
|
|
408
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
408
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
409
409
|
*/
|
|
410
410
|
summaryTemplate: TemplateRef<any>;
|
|
411
411
|
/** Indicates if the column is currently pinned. If the value is true, the column is pinned */
|
|
@@ -430,13 +430,13 @@ export interface ColumnType extends FieldType {
|
|
|
430
430
|
/**
|
|
431
431
|
* Optional
|
|
432
432
|
* The root parent of this column (if any).
|
|
433
|
-
* If there is no root parent, that means the current
|
|
433
|
+
* If there is no root parent, that means the current column is the root parent
|
|
434
434
|
*/
|
|
435
435
|
topLevelParent?: ColumnType;
|
|
436
436
|
/**
|
|
437
437
|
* Optional
|
|
438
438
|
* The immediate parent (right above) column of this column (if any).
|
|
439
|
-
* If there is no parent, that means the current
|
|
439
|
+
* If there is no parent, that means the current column is the root parent
|
|
440
440
|
*/
|
|
441
441
|
parent?: ColumnType;
|
|
442
442
|
pipeArgs: IColumnPipeArgs;
|
|
@@ -455,7 +455,7 @@ export interface ColumnType extends FieldType {
|
|
|
455
455
|
groupingComparer: (a: any, b: any) => number;
|
|
456
456
|
/**
|
|
457
457
|
* Represents a custom template for filtering
|
|
458
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
458
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
459
459
|
*/
|
|
460
460
|
filterCellTemplate: TemplateRef<any>;
|
|
461
461
|
/**
|
|
@@ -469,7 +469,7 @@ export interface ColumnType extends FieldType {
|
|
|
469
469
|
/** A method definition to retrieve the set CSS width of the cells under the column */
|
|
470
470
|
getCellWidth(): string;
|
|
471
471
|
getGridTemplate(isRow: boolean): string;
|
|
472
|
-
/** A method definition to toggle column
|
|
472
|
+
/** A method definition to toggle column visibility (hidden or visible) */
|
|
473
473
|
toggleVisibility(value?: boolean): void;
|
|
474
474
|
populateVisibleIndexes?(): void;
|
|
475
475
|
/** Pins the column at the specified index (if not already pinned). */
|
|
@@ -571,7 +571,7 @@ export interface GridServiceType {
|
|
|
571
571
|
*/
|
|
572
572
|
get_cell_by_visible_index(rowIndex: number, columnIndex: number): any;
|
|
573
573
|
/** Represents a method declaration that sets the expansion state of a group row (used for tree grids)
|
|
574
|
-
* It takes the value for the
|
|
574
|
+
* It takes the value for the expansion as a parameter (expanded or collapsed)
|
|
575
575
|
*/
|
|
576
576
|
set_grouprow_expansion_state?(groupRow: IGroupByRecord, value: boolean): void;
|
|
577
577
|
row_deleted_transaction(id: any): boolean;
|
|
@@ -580,11 +580,11 @@ export interface GridServiceType {
|
|
|
580
580
|
* It takes the row's data and the identifier of the parent row if applicable (used for tree grids)
|
|
581
581
|
*/
|
|
582
582
|
addRowToData(rowData: any, parentID?: any): void;
|
|
583
|
-
/** Represents a method declaration for deleting a row, specified by it's
|
|
583
|
+
/** Represents a method declaration for deleting a row, specified by it's identifier (taken as a parameter) */
|
|
584
584
|
deleteRowById(id: any): any;
|
|
585
|
-
/** Represents a method declaration for retrieving the row's current state of
|
|
585
|
+
/** Represents a method declaration for retrieving the row's current state of expansion (used for tree grids)*/
|
|
586
586
|
get_row_expansion_state(id: any): boolean;
|
|
587
|
-
/** Represents a method declaration for setting a new
|
|
587
|
+
/** Represents a method declaration for setting a new expansion state. It can be triggered by an event */
|
|
588
588
|
set_row_expansion_state(id: any, expanded: boolean, event?: Event): void;
|
|
589
589
|
get_summary_data(): any[];
|
|
590
590
|
prepare_sorting_expression(stateCollections: Array<Array<any>>, expression: ISortingExpression): void;
|
|
@@ -598,7 +598,7 @@ export interface GridServiceType {
|
|
|
598
598
|
* The expressions contains fieldName, sorting directory, whether case should be ignored and optional sorting strategy
|
|
599
599
|
*/
|
|
600
600
|
sort_multiple(expressions: ISortingExpression[]): void;
|
|
601
|
-
/** Represents a method declaration for
|
|
601
|
+
/** Represents a method declaration for resetting the sorting */
|
|
602
602
|
clear_sort(fieldName: string): void;
|
|
603
603
|
/** Represents an event, triggered when the pin state is changed */
|
|
604
604
|
get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean): IPinRowEventArgs;
|
|
@@ -699,7 +699,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
699
699
|
showRowSelectors: boolean;
|
|
700
700
|
/** Indicates whether the grid's element is pinned to the start of the grid */
|
|
701
701
|
isPinningToStart: boolean;
|
|
702
|
-
/**
|
|
702
|
+
/** Indicates if the column of the grid is in drag mode */
|
|
703
703
|
columnInDrag: any;
|
|
704
704
|
/** @hidden @internal */
|
|
705
705
|
/** The width of pinned element */
|
|
@@ -729,60 +729,60 @@ export interface GridType extends IGridDataBindable {
|
|
|
729
729
|
/**
|
|
730
730
|
* Optional
|
|
731
731
|
* The template for grid icons.
|
|
732
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
732
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
733
733
|
*/
|
|
734
734
|
iconTemplate?: TemplateRef<any>;
|
|
735
735
|
/**
|
|
736
736
|
* Optional
|
|
737
737
|
* The template for group-by rows.
|
|
738
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
738
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
739
739
|
*/
|
|
740
740
|
groupRowTemplate?: TemplateRef<IgxGroupByRowTemplateContext>;
|
|
741
741
|
/**
|
|
742
742
|
* Optional
|
|
743
743
|
* The template for the group row selector.
|
|
744
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
744
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
745
745
|
*/
|
|
746
746
|
groupByRowSelectorTemplate?: TemplateRef<IgxGroupByRowSelectorTemplateContext>;
|
|
747
747
|
/**
|
|
748
748
|
* Optional
|
|
749
749
|
* The template for row loading indicators.
|
|
750
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
750
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
751
751
|
*/
|
|
752
752
|
rowLoadingIndicatorTemplate?: TemplateRef<any>;
|
|
753
753
|
/**
|
|
754
754
|
* The template for the header selector.
|
|
755
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
755
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
756
756
|
*/
|
|
757
757
|
headSelectorTemplate: TemplateRef<IgxHeadSelectorTemplateContext>;
|
|
758
758
|
/**
|
|
759
759
|
* The template for row selectors.
|
|
760
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
760
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
761
761
|
*/
|
|
762
762
|
rowSelectorTemplate: TemplateRef<IgxRowSelectorTemplateContext>;
|
|
763
763
|
/**
|
|
764
764
|
* The template for sort header icons.
|
|
765
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
765
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
766
766
|
*/
|
|
767
767
|
sortHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
768
768
|
/**
|
|
769
769
|
* The template for ascending sort header icons.
|
|
770
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
770
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
771
771
|
*/
|
|
772
772
|
sortAscendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
773
773
|
/**
|
|
774
774
|
* The template for descending sort header icons.
|
|
775
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
775
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
776
776
|
*/
|
|
777
777
|
sortDescendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
778
778
|
/**
|
|
779
779
|
* The template for header collapsed indicators.
|
|
780
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
780
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
781
781
|
*/
|
|
782
782
|
headerCollapsedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>;
|
|
783
783
|
/**
|
|
784
784
|
* The template for header expanded indicators.
|
|
785
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
785
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
786
786
|
*/
|
|
787
787
|
headerExpandedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>;
|
|
788
788
|
/** The template for drag indicator icons. Could be of any type */
|
|
@@ -800,7 +800,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
800
800
|
calcHeight: number;
|
|
801
801
|
calcWidth: number;
|
|
802
802
|
outerWidth: number;
|
|
803
|
-
/** The height of each row in the grid. Setting a constant height can solve problems with not showing all
|
|
803
|
+
/** The height of each row in the grid. Setting a constant height can solve problems with not showing all elements when scrolling */
|
|
804
804
|
rowHeight: number;
|
|
805
805
|
multiRowLayoutRowSize: number;
|
|
806
806
|
/** Minimal width for headers */
|
|
@@ -810,7 +810,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
810
810
|
/** The default font size, calculated for each element */
|
|
811
811
|
_baseFontSize?: number;
|
|
812
812
|
scrollSize: number;
|
|
813
|
-
/** The trigger for grid validation. It's value can
|
|
813
|
+
/** The trigger for grid validation. It's value can either be `change` or `blur` */
|
|
814
814
|
validationTrigger: GridValidationTrigger;
|
|
815
815
|
/**
|
|
816
816
|
* The configuration for columns and rows pinning in the grid
|
|
@@ -868,7 +868,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
868
868
|
totalRowsCountAfterFilter: number;
|
|
869
869
|
_totalRecords: number;
|
|
870
870
|
/**
|
|
871
|
-
* Represents the paging of the grid. It can be
|
|
871
|
+
* Represents the paging of the grid. It can be either 'Local' or 'Remote'
|
|
872
872
|
* - Local: Default value; The grid will paginate the data source based on the page
|
|
873
873
|
*/
|
|
874
874
|
pagingMode: GridPagingMode;
|
|
@@ -879,7 +879,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
879
879
|
/** Represents the last search in the grid
|
|
880
880
|
* It contains the search text (the user has entered), the match and some settings for the search
|
|
881
881
|
*/
|
|
882
|
-
lastSearchInfo: ISearchInfo;
|
|
882
|
+
readonly lastSearchInfo: ISearchInfo;
|
|
883
883
|
/** @hidden @internal */
|
|
884
884
|
page: number;
|
|
885
885
|
/** @hidden @internal */
|
|
@@ -913,17 +913,17 @@ export interface GridType extends IGridDataBindable {
|
|
|
913
913
|
document: Document;
|
|
914
914
|
/**
|
|
915
915
|
* The template for expanded row indicators.
|
|
916
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
916
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
917
917
|
*/
|
|
918
918
|
rowExpandedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>;
|
|
919
919
|
/**
|
|
920
920
|
* The template for collapsed row indicators.
|
|
921
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
921
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
922
922
|
*/
|
|
923
923
|
rowCollapsedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>;
|
|
924
924
|
/**
|
|
925
925
|
* The template for header icon
|
|
926
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
926
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
927
927
|
*/
|
|
928
928
|
excelStyleHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
929
929
|
selectRowOnClick: boolean;
|
|
@@ -1151,12 +1151,12 @@ export interface HierarchicalGridType extends GridType {
|
|
|
1151
1151
|
export interface PivotGridType extends GridType {
|
|
1152
1152
|
/**
|
|
1153
1153
|
* The configuration settings for the pivot grid.
|
|
1154
|
-
* it includes
|
|
1154
|
+
* it includes dimension strategy for rows and columns, filters and data keys
|
|
1155
1155
|
*/
|
|
1156
1156
|
pivotConfiguration: IPivotConfiguration;
|
|
1157
1157
|
/**
|
|
1158
1158
|
* An array of all dimensions (rows and columns) in the pivot grid.
|
|
1159
|
-
* it includes hierarchical level, filters and sorting,
|
|
1159
|
+
* it includes hierarchical level, filters and sorting, dimensional level, etc.
|
|
1160
1160
|
*/
|
|
1161
1161
|
allDimensions: IPivotDimension[];
|
|
1162
1162
|
/** Specifies whether to show the pivot configuration UI in the grid. */
|
|
@@ -1173,7 +1173,7 @@ export interface PivotGridType extends GridType {
|
|
|
1173
1173
|
/** @hidden @internal */
|
|
1174
1174
|
dimensionDataColumns: ColumnType[];
|
|
1175
1175
|
pivotRowWidths: number;
|
|
1176
|
-
/** Represents a method declaration for
|
|
1176
|
+
/** Represents a method declaration for setting up the columns for the pivot grid based on the pivot configuration */
|
|
1177
1177
|
setupColumns(): void;
|
|
1178
1178
|
/** Represents a method declaration that allows toggle of expansion state of a row (taken as a parameter) in the pivot grid */
|
|
1179
1179
|
toggleRow(rowID: any): void;
|
|
@@ -97,7 +97,7 @@ export declare class NoopSortingStrategy implements IGridSortingStrategy {
|
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* Represents a class extending the IgxSorting class
|
|
100
|
-
*
|
|
100
|
+
* Provides custom data record sorting.
|
|
101
101
|
*/
|
|
102
102
|
export declare class IgxDataRecordSorting extends IgxSorting {
|
|
103
103
|
/**
|
|
@@ -58,9 +58,9 @@ export interface ISelectionKeyboardState {
|
|
|
58
58
|
node: null | ISelectionNode;
|
|
59
59
|
/** Indicates whether the Shift key is currently pressed during the selection. */
|
|
60
60
|
shift: boolean;
|
|
61
|
-
/** The range of the selected cells in the grid. Can be null when
|
|
61
|
+
/** The range of the selected cells in the grid. Can be null when resetting the selection. */
|
|
62
62
|
range: GridSelectionRange;
|
|
63
|
-
/** Indicates whether the selection is currently active (being performed). `False` when
|
|
63
|
+
/** Indicates whether the selection is currently active (being performed). `False` when resetting the selection. */
|
|
64
64
|
active: boolean;
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
@@ -1762,7 +1762,7 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
|
|
|
1762
1762
|
/**
|
|
1763
1763
|
* Represents the last search information.
|
|
1764
1764
|
*/
|
|
1765
|
-
lastSearchInfo: ISearchInfo;
|
|
1765
|
+
get lastSearchInfo(): ISearchInfo;
|
|
1766
1766
|
/**
|
|
1767
1767
|
* @hidden @internal
|
|
1768
1768
|
*/
|
|
@@ -1910,6 +1910,7 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
|
|
|
1910
1910
|
protected _filterStrategy: IFilteringStrategy;
|
|
1911
1911
|
protected _autoGeneratedCols: any[];
|
|
1912
1912
|
protected _dataView: any[];
|
|
1913
|
+
protected _lastSearchInfo: ISearchInfo;
|
|
1913
1914
|
/** @hidden @internal */
|
|
1914
1915
|
get paginator(): IgxPaginatorComponent;
|
|
1915
1916
|
/**
|
package/package.json
CHANGED