igniteui-angular 18.0.1 → 18.0.3
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/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 +90 -59
- package/fesm2022/igniteui-angular.mjs.map +1 -1
- 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 +49 -49
- 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/migrations/update-18_0_0/index.js +1 -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/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
|
}
|
|
@@ -63,7 +63,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
|
|
|
63
63
|
rowData: any;
|
|
64
64
|
/**
|
|
65
65
|
* Represents the previous (before editing) value of the edited cell.
|
|
66
|
-
* It's used when the event has been
|
|
66
|
+
* It's used when the event has been stopped/exited.
|
|
67
67
|
*/
|
|
68
68
|
oldValue: any;
|
|
69
69
|
/**
|
|
@@ -89,7 +89,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
|
|
|
89
89
|
owner?: GridType;
|
|
90
90
|
/**
|
|
91
91
|
* Optional
|
|
92
|
-
* Indicates if the editing
|
|
92
|
+
* Indicates if the editing consists of adding a new row
|
|
93
93
|
*/
|
|
94
94
|
isAddRow?: boolean;
|
|
95
95
|
/**
|
|
@@ -143,7 +143,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
|
|
|
143
143
|
insertAtIndex: number;
|
|
144
144
|
/**
|
|
145
145
|
* Returns the actual pin state of the column.
|
|
146
|
-
* If pinning/unpinning is
|
|
146
|
+
* If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
|
|
147
147
|
*/
|
|
148
148
|
isPinned: boolean;
|
|
149
149
|
}
|
|
@@ -151,7 +151,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
|
|
|
151
151
|
* The event arguments before a column's pin state is changed.
|
|
152
152
|
* `insertAtIndex`specifies at which index in the pinned/unpinned area the column is inserted.
|
|
153
153
|
* Can be changed in the `columnPin` event.
|
|
154
|
-
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is
|
|
154
|
+
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is successful,
|
|
155
155
|
* the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
|
|
156
156
|
*/
|
|
157
157
|
export interface IPinColumnCancellableEventArgs extends IPinColumnEventArgs, CancelableEventArgs {
|
|
@@ -178,7 +178,7 @@ export interface IRowDataEventArgs extends IBaseEventArgs {
|
|
|
178
178
|
}
|
|
179
179
|
/** The event arguments when a column is being resized */
|
|
180
180
|
export interface IColumnResizeEventArgs extends IBaseEventArgs {
|
|
181
|
-
/** Represents the
|
|
181
|
+
/** Represents the information of the column that is being resized */
|
|
182
182
|
column: ColumnType;
|
|
183
183
|
/** Represents the old width of the column before the resizing */
|
|
184
184
|
prevWidth: string;
|
|
@@ -221,7 +221,7 @@ export interface IRowSelectionEventArgs extends CancelableEventArgs, IBaseEventA
|
|
|
221
221
|
readonly allRowsSelected?: boolean;
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
|
-
* The event arguments when the selection state of a column is being
|
|
224
|
+
* The event arguments when the selection state of a column is being changed
|
|
225
225
|
* The event is cancelable
|
|
226
226
|
*/
|
|
227
227
|
export interface IColumnSelectionEventArgs extends CancelableEventArgs, IBaseEventArgs {
|
|
@@ -271,8 +271,8 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
|
|
|
271
271
|
*/
|
|
272
272
|
options: IgxExporterOptionsBase;
|
|
273
273
|
/**
|
|
274
|
-
* `cancel` returns whether the event has been
|
|
275
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
274
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
275
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
276
276
|
*/
|
|
277
277
|
cancel: boolean;
|
|
278
278
|
}
|
|
@@ -280,7 +280,7 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
|
|
|
280
280
|
export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
|
|
281
281
|
/**
|
|
282
282
|
* Represents the column that is being moved.
|
|
283
|
-
* The `ColumnType` contains the
|
|
283
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
284
284
|
*/
|
|
285
285
|
source: ColumnType;
|
|
286
286
|
}
|
|
@@ -288,12 +288,12 @@ export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
|
|
|
288
288
|
export interface IColumnMovingEventArgs extends IBaseEventArgs {
|
|
289
289
|
/**
|
|
290
290
|
* Represents the column that is being moved.
|
|
291
|
-
* The `ColumnType` contains the
|
|
291
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
292
292
|
*/
|
|
293
293
|
source: ColumnType;
|
|
294
294
|
/**
|
|
295
|
-
* `cancel` returns whether the event has been
|
|
296
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
295
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
296
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
297
297
|
*/
|
|
298
298
|
cancel: boolean;
|
|
299
299
|
}
|
|
@@ -301,17 +301,17 @@ export interface IColumnMovingEventArgs extends IBaseEventArgs {
|
|
|
301
301
|
export interface IColumnMovingEndEventArgs extends IBaseEventArgs {
|
|
302
302
|
/**
|
|
303
303
|
* The source of the event represents the column that is being moved.
|
|
304
|
-
* The `ColumnType` contains the
|
|
304
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
305
305
|
*/
|
|
306
306
|
source: ColumnType;
|
|
307
307
|
/**
|
|
308
308
|
* The target of the event represents the column, the source is being moved to.
|
|
309
|
-
* The `ColumnType` contains the
|
|
309
|
+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
|
|
310
310
|
*/
|
|
311
311
|
target: ColumnType;
|
|
312
312
|
/**
|
|
313
|
-
* `cancel` returns whether the event has been
|
|
314
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
313
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
314
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
315
315
|
*/
|
|
316
316
|
cancel: boolean;
|
|
317
317
|
}
|
|
@@ -324,12 +324,12 @@ export interface IGridKeydownEventArgs extends IBaseEventArgs {
|
|
|
324
324
|
targetType: GridKeydownTargetType;
|
|
325
325
|
/** Represents the information and details of the object itself */
|
|
326
326
|
target: any;
|
|
327
|
-
/** Represents the original event, that
|
|
327
|
+
/** Represents the original event, that occurred. */
|
|
328
328
|
event: Event;
|
|
329
329
|
/**
|
|
330
330
|
* The event is cancelable
|
|
331
|
-
* `cancel` returns whether the event has been
|
|
332
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
331
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
332
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
333
333
|
*/
|
|
334
334
|
cancel: boolean;
|
|
335
335
|
}
|
|
@@ -338,7 +338,7 @@ export interface ICellPosition {
|
|
|
338
338
|
/** It returns the position (index) of the row, the cell is in */
|
|
339
339
|
rowIndex: number;
|
|
340
340
|
/**
|
|
341
|
-
* It returns the position (index) of the
|
|
341
|
+
* It returns the position (index) of the column, the cell is in
|
|
342
342
|
* Counts only the visible (non hidden) columns
|
|
343
343
|
*/
|
|
344
344
|
visibleColumnIndex: number;
|
|
@@ -366,7 +366,7 @@ export interface IRowDragStartEventArgs extends CancelableEventArgs, IBaseEventA
|
|
|
366
366
|
/** Represents the HTML element itself */
|
|
367
367
|
dragElement: HTMLElement;
|
|
368
368
|
}
|
|
369
|
-
/**
|
|
369
|
+
/** Represents event arguments related to the row's expansion state being changed in a grid */
|
|
370
370
|
export interface IRowToggleEventArgs extends IBaseEventArgs {
|
|
371
371
|
/**
|
|
372
372
|
* Represents the ID of the row that emitted the event (which state is changed)
|
|
@@ -381,13 +381,13 @@ export interface IRowToggleEventArgs extends IBaseEventArgs {
|
|
|
381
381
|
expanded: boolean;
|
|
382
382
|
/**
|
|
383
383
|
* Optional
|
|
384
|
-
* Represents the original event, that has triggered the
|
|
384
|
+
* Represents the original event, that has triggered the expansion/collapse
|
|
385
385
|
*/
|
|
386
386
|
event?: Event;
|
|
387
387
|
/**
|
|
388
388
|
* The event is cancelable
|
|
389
|
-
* `cancel` returns whether the event has been
|
|
390
|
-
* If the value becomes "true", it returns/exits from the method,
|
|
389
|
+
* `cancel` returns whether the event has been intercepted and stopped
|
|
390
|
+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
|
|
391
391
|
*/
|
|
392
392
|
cancel: boolean;
|
|
393
393
|
}
|
|
@@ -430,7 +430,7 @@ export interface IColumnToggledEventArgs extends IBaseEventArgs {
|
|
|
430
430
|
/** The checked state after the action. */
|
|
431
431
|
checked: boolean;
|
|
432
432
|
}
|
|
433
|
-
/**
|
|
433
|
+
/** Emitted when the active node is changed */
|
|
434
434
|
export interface IActiveNodeChangeEventArgs extends IBaseEventArgs {
|
|
435
435
|
/** Represents the row index of the active node */
|
|
436
436
|
row: number;
|
|
@@ -461,7 +461,7 @@ export interface ISortingEventArgs extends IBaseEventArgs, CancelableEventArgs {
|
|
|
461
461
|
sortingExpressions?: ISortingExpression | Array<ISortingExpression>;
|
|
462
462
|
/**
|
|
463
463
|
* Optional
|
|
464
|
-
* Represents the
|
|
464
|
+
* Represents the grouping expressions applied to the grid.
|
|
465
465
|
* It can be a single grouping expression or an array of them
|
|
466
466
|
* The expression contains information like the sorting expression and criteria by which the elements will be grouped
|
|
467
467
|
*/
|
|
@@ -483,7 +483,7 @@ export interface IColumnVisibilityChangedEventArgs extends IBaseEventArgs {
|
|
|
483
483
|
/** Represents the column the event originated from */
|
|
484
484
|
column: any;
|
|
485
485
|
/**
|
|
486
|
-
* The new hidden state that the column will have, if operation is
|
|
486
|
+
* The new hidden state that the column will have, if operation is successful.
|
|
487
487
|
* Will be `true` when hiding and `false` when showing.
|
|
488
488
|
*/
|
|
489
489
|
newValue: boolean;
|
|
@@ -194,12 +194,12 @@ export interface RowType {
|
|
|
194
194
|
expanded?: boolean;
|
|
195
195
|
/**
|
|
196
196
|
* Optional
|
|
197
|
-
*
|
|
197
|
+
* Indicates whether the row is marked for deletion.
|
|
198
198
|
*/
|
|
199
199
|
deleted?: boolean;
|
|
200
200
|
/**
|
|
201
201
|
* Optional
|
|
202
|
-
*
|
|
202
|
+
* Indicates whether the row is currently being edited.
|
|
203
203
|
*/
|
|
204
204
|
inEditMode?: boolean;
|
|
205
205
|
/**
|
|
@@ -215,7 +215,7 @@ export interface RowType {
|
|
|
215
215
|
parent?: RowType;
|
|
216
216
|
/**
|
|
217
217
|
* Optional
|
|
218
|
-
*
|
|
218
|
+
* Indicates whether the current row has any child rows
|
|
219
219
|
*/
|
|
220
220
|
hasChildren?: boolean;
|
|
221
221
|
/**
|
|
@@ -227,7 +227,7 @@ export interface RowType {
|
|
|
227
227
|
addRowUI?: boolean;
|
|
228
228
|
/**
|
|
229
229
|
* Optional
|
|
230
|
-
*
|
|
230
|
+
* Indicates whether the row is currently focused.
|
|
231
231
|
*/
|
|
232
232
|
focused?: boolean;
|
|
233
233
|
/** Represent the grid instance, the row belongs to */
|
|
@@ -282,7 +282,7 @@ export interface FieldType {
|
|
|
282
282
|
* Contains definitions of properties and methods, relevant to a column
|
|
283
283
|
*/
|
|
284
284
|
export interface ColumnType extends FieldType {
|
|
285
|
-
/** Represents the
|
|
285
|
+
/** Represents the instance of the parent `GridType` that contains this column. */
|
|
286
286
|
grid: GridType;
|
|
287
287
|
/** A list, containing all the child columns under this column (if any). */
|
|
288
288
|
children: QueryList<ColumnType>;
|
|
@@ -301,12 +301,12 @@ export interface ColumnType extends FieldType {
|
|
|
301
301
|
validators: any[];
|
|
302
302
|
/**
|
|
303
303
|
* The template reference for the custom header of the column
|
|
304
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
304
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
305
305
|
*/
|
|
306
306
|
headerTemplate: TemplateRef<any>;
|
|
307
307
|
/**
|
|
308
308
|
* The template reference for the collapsible indicator of the column.
|
|
309
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
309
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
310
310
|
*/
|
|
311
311
|
collapsibleIndicatorTemplate?: TemplateRef<any>;
|
|
312
312
|
/** Represents custom CSS classes applied to the header element. When added, they take different styling */
|
|
@@ -318,7 +318,7 @@ export interface ColumnType extends FieldType {
|
|
|
318
318
|
/** Represents custom CSS styles applied to the header group. When added, they take different styling */
|
|
319
319
|
headerGroupStyles: any;
|
|
320
320
|
/**
|
|
321
|
-
* Custom CSS styling,
|
|
321
|
+
* Custom CSS styling, applied to every column
|
|
322
322
|
* calcWidth, minWidthPx, maxWidthPx, minWidth, maxWidth, minWidthPercent, maxWidthPercent, resolvedWidth
|
|
323
323
|
*/
|
|
324
324
|
calcWidth: any;
|
|
@@ -341,12 +341,12 @@ export interface ColumnType extends FieldType {
|
|
|
341
341
|
index: number;
|
|
342
342
|
/**
|
|
343
343
|
* Represents the type of data for the column:
|
|
344
|
-
* string, number,
|
|
344
|
+
* string, number, boolean, currency, date, time, etc.
|
|
345
345
|
*/
|
|
346
346
|
dataType: GridColumnDataType;
|
|
347
347
|
/**
|
|
348
348
|
* The template reference for the custom inline editor of the column
|
|
349
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
349
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
350
350
|
*/
|
|
351
351
|
inlineEditorTemplate: TemplateRef<any>;
|
|
352
352
|
/**
|
|
@@ -367,17 +367,17 @@ export interface ColumnType extends FieldType {
|
|
|
367
367
|
searchable: boolean;
|
|
368
368
|
/** Specifies whether the column belongs to a group of columns. */
|
|
369
369
|
columnGroup: boolean;
|
|
370
|
-
/**
|
|
370
|
+
/** Indicates whether a column can be put in a group. If the value is true, the column can be put in a group */
|
|
371
371
|
groupable: boolean;
|
|
372
|
-
/**
|
|
372
|
+
/** Indicates whether a column can be sorted. If the value is true, the column can be sorted. */
|
|
373
373
|
sortable: boolean;
|
|
374
|
-
/**
|
|
374
|
+
/** Indicates whether a column can be filtered. If the value is true, the column can be filtered */
|
|
375
375
|
filterable: boolean;
|
|
376
|
-
/**
|
|
376
|
+
/** Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible */
|
|
377
377
|
hidden: boolean;
|
|
378
|
-
/**
|
|
378
|
+
/** Indicates whether a column can be pinned. If the value is true, the column cannot be pinned */
|
|
379
379
|
disablePinning: boolean;
|
|
380
|
-
/**
|
|
380
|
+
/** Indicates whether a column can be hidden. If the value is true, the column cannot be hidden */
|
|
381
381
|
disableHiding: boolean;
|
|
382
382
|
/**
|
|
383
383
|
* The sorting strategy used for sorting this column.
|
|
@@ -401,7 +401,7 @@ export interface ColumnType extends FieldType {
|
|
|
401
401
|
summaries: any;
|
|
402
402
|
/**
|
|
403
403
|
* The template reference for a summary of the column
|
|
404
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
404
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
405
405
|
*/
|
|
406
406
|
summaryTemplate: TemplateRef<any>;
|
|
407
407
|
/** Indicates if the column is currently pinned. If the value is true, the column is pinned */
|
|
@@ -426,13 +426,13 @@ export interface ColumnType extends FieldType {
|
|
|
426
426
|
/**
|
|
427
427
|
* Optional
|
|
428
428
|
* The root parent of this column (if any).
|
|
429
|
-
* If there is no root parent, that means the current
|
|
429
|
+
* If there is no root parent, that means the current column is the root parent
|
|
430
430
|
*/
|
|
431
431
|
topLevelParent?: ColumnType;
|
|
432
432
|
/**
|
|
433
433
|
* Optional
|
|
434
434
|
* The immediate parent (right above) column of this column (if any).
|
|
435
|
-
* If there is no parent, that means the current
|
|
435
|
+
* If there is no parent, that means the current column is the root parent
|
|
436
436
|
*/
|
|
437
437
|
parent?: ColumnType;
|
|
438
438
|
pipeArgs: IColumnPipeArgs;
|
|
@@ -451,7 +451,7 @@ export interface ColumnType extends FieldType {
|
|
|
451
451
|
groupingComparer: (a: any, b: any) => number;
|
|
452
452
|
/**
|
|
453
453
|
* Represents a custom template for filtering
|
|
454
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
454
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
455
455
|
*/
|
|
456
456
|
filterCellTemplate: TemplateRef<any>;
|
|
457
457
|
/**
|
|
@@ -465,7 +465,7 @@ export interface ColumnType extends FieldType {
|
|
|
465
465
|
/** A method definition to retrieve the set CSS width of the cells under the column */
|
|
466
466
|
getCellWidth(): string;
|
|
467
467
|
getGridTemplate(isRow: boolean): string;
|
|
468
|
-
/** A method definition to toggle column
|
|
468
|
+
/** A method definition to toggle column visibility (hidden or visible) */
|
|
469
469
|
toggleVisibility(value?: boolean): void;
|
|
470
470
|
populateVisibleIndexes?(): void;
|
|
471
471
|
/** Pins the column at the specified index (if not already pinned). */
|
|
@@ -567,7 +567,7 @@ export interface GridServiceType {
|
|
|
567
567
|
*/
|
|
568
568
|
get_cell_by_visible_index(rowIndex: number, columnIndex: number): any;
|
|
569
569
|
/** Represents a method declaration that sets the expansion state of a group row (used for tree grids)
|
|
570
|
-
* It takes the value for the
|
|
570
|
+
* It takes the value for the expansion as a parameter (expanded or collapsed)
|
|
571
571
|
*/
|
|
572
572
|
set_grouprow_expansion_state?(groupRow: IGroupByRecord, value: boolean): void;
|
|
573
573
|
row_deleted_transaction(id: any): boolean;
|
|
@@ -576,11 +576,11 @@ export interface GridServiceType {
|
|
|
576
576
|
* It takes the row's data and the identifier of the parent row if applicable (used for tree grids)
|
|
577
577
|
*/
|
|
578
578
|
addRowToData(rowData: any, parentID?: any): void;
|
|
579
|
-
/** Represents a method declaration for deleting a row, specified by it's
|
|
579
|
+
/** Represents a method declaration for deleting a row, specified by it's identifier (taken as a parameter) */
|
|
580
580
|
deleteRowById(id: any): any;
|
|
581
|
-
/** Represents a method declaration for retrieving the row's current state of
|
|
581
|
+
/** Represents a method declaration for retrieving the row's current state of expansion (used for tree grids)*/
|
|
582
582
|
get_row_expansion_state(id: any): boolean;
|
|
583
|
-
/** Represents a method declaration for setting a new
|
|
583
|
+
/** Represents a method declaration for setting a new expansion state. It can be triggered by an event */
|
|
584
584
|
set_row_expansion_state(id: any, expanded: boolean, event?: Event): void;
|
|
585
585
|
get_summary_data(): any[];
|
|
586
586
|
prepare_sorting_expression(stateCollections: Array<Array<any>>, expression: ISortingExpression): void;
|
|
@@ -594,7 +594,7 @@ export interface GridServiceType {
|
|
|
594
594
|
* The expressions contains fieldName, sorting directory, whether case should be ignored and optional sorting strategy
|
|
595
595
|
*/
|
|
596
596
|
sort_multiple(expressions: ISortingExpression[]): void;
|
|
597
|
-
/** Represents a method declaration for
|
|
597
|
+
/** Represents a method declaration for resetting the sorting */
|
|
598
598
|
clear_sort(fieldName: string): void;
|
|
599
599
|
/** Represents an event, triggered when the pin state is changed */
|
|
600
600
|
get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean): IPinRowEventArgs;
|
|
@@ -619,7 +619,7 @@ export interface GridServiceType {
|
|
|
619
619
|
* Extends `IGridDataBindable`
|
|
620
620
|
*/
|
|
621
621
|
export interface GridType extends IGridDataBindable {
|
|
622
|
-
/** Represents the locale of the
|
|
622
|
+
/** Represents the locale of the grid: `USD`, `EUR`, `GBP`, `CNY`, `JPY`, etc. */
|
|
623
623
|
locale: string;
|
|
624
624
|
resourceStrings: IGridResourceStrings;
|
|
625
625
|
/** Represents the native HTML element itself */
|
|
@@ -695,7 +695,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
695
695
|
showRowSelectors: boolean;
|
|
696
696
|
/** Indicates whether the grid's element is pinned to the start of the grid */
|
|
697
697
|
isPinningToStart: boolean;
|
|
698
|
-
/**
|
|
698
|
+
/** Indicates if the column of the grid is in drag mode */
|
|
699
699
|
columnInDrag: any;
|
|
700
700
|
/** @hidden @internal */
|
|
701
701
|
/** The width of pinned element */
|
|
@@ -725,60 +725,60 @@ export interface GridType extends IGridDataBindable {
|
|
|
725
725
|
/**
|
|
726
726
|
* Optional
|
|
727
727
|
* The template for grid icons.
|
|
728
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
728
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
729
729
|
*/
|
|
730
730
|
iconTemplate?: TemplateRef<any>;
|
|
731
731
|
/**
|
|
732
732
|
* Optional
|
|
733
733
|
* The template for group-by rows.
|
|
734
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
734
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
735
735
|
*/
|
|
736
736
|
groupRowTemplate?: TemplateRef<IgxGroupByRowTemplateContext>;
|
|
737
737
|
/**
|
|
738
738
|
* Optional
|
|
739
739
|
* The template for the group row selector.
|
|
740
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
740
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
741
741
|
*/
|
|
742
742
|
groupByRowSelectorTemplate?: TemplateRef<IgxGroupByRowSelectorTemplateContext>;
|
|
743
743
|
/**
|
|
744
744
|
* Optional
|
|
745
745
|
* The template for row loading indicators.
|
|
746
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
746
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
747
747
|
*/
|
|
748
748
|
rowLoadingIndicatorTemplate?: TemplateRef<any>;
|
|
749
749
|
/**
|
|
750
750
|
* The template for the header selector.
|
|
751
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
751
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
752
752
|
*/
|
|
753
753
|
headSelectorTemplate: TemplateRef<IgxHeadSelectorTemplateContext>;
|
|
754
754
|
/**
|
|
755
755
|
* The template for row selectors.
|
|
756
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
756
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
757
757
|
*/
|
|
758
758
|
rowSelectorTemplate: TemplateRef<IgxRowSelectorTemplateContext>;
|
|
759
759
|
/**
|
|
760
760
|
* The template for sort header icons.
|
|
761
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
761
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
762
762
|
*/
|
|
763
763
|
sortHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
764
764
|
/**
|
|
765
765
|
* The template for ascending sort header icons.
|
|
766
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
766
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
767
767
|
*/
|
|
768
768
|
sortAscendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
769
769
|
/**
|
|
770
770
|
* The template for descending sort header icons.
|
|
771
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
771
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
772
772
|
*/
|
|
773
773
|
sortDescendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
774
774
|
/**
|
|
775
775
|
* The template for header collapsed indicators.
|
|
776
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
776
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
777
777
|
*/
|
|
778
778
|
headerCollapsedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>;
|
|
779
779
|
/**
|
|
780
780
|
* The template for header expanded indicators.
|
|
781
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
781
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
782
782
|
*/
|
|
783
783
|
headerExpandedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>;
|
|
784
784
|
/** The template for drag indicator icons. Could be of any type */
|
|
@@ -796,7 +796,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
796
796
|
calcHeight: number;
|
|
797
797
|
calcWidth: number;
|
|
798
798
|
outerWidth: number;
|
|
799
|
-
/** The height of each row in the grid. Setting a constant height can solve problems with not showing all
|
|
799
|
+
/** The height of each row in the grid. Setting a constant height can solve problems with not showing all elements when scrolling */
|
|
800
800
|
rowHeight: number;
|
|
801
801
|
multiRowLayoutRowSize: number;
|
|
802
802
|
/** Minimal width for headers */
|
|
@@ -806,7 +806,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
806
806
|
/** The default font size, calculated for each element */
|
|
807
807
|
_baseFontSize?: number;
|
|
808
808
|
scrollSize: number;
|
|
809
|
-
/** The trigger for grid validation. It's value can
|
|
809
|
+
/** The trigger for grid validation. It's value can either be `change` or `blur` */
|
|
810
810
|
validationTrigger: GridValidationTrigger;
|
|
811
811
|
/**
|
|
812
812
|
* The configuration for columns and rows pinning in the grid
|
|
@@ -864,7 +864,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
864
864
|
totalRowsCountAfterFilter: number;
|
|
865
865
|
_totalRecords: number;
|
|
866
866
|
/**
|
|
867
|
-
* Represents the paging of the grid. It can be
|
|
867
|
+
* Represents the paging of the grid. It can be either 'Local' or 'Remote'
|
|
868
868
|
* - Local: Default value; The grid will paginate the data source based on the page
|
|
869
869
|
*/
|
|
870
870
|
pagingMode: GridPagingMode;
|
|
@@ -875,7 +875,7 @@ export interface GridType extends IGridDataBindable {
|
|
|
875
875
|
/** Represents the last search in the grid
|
|
876
876
|
* It contains the search text (the user has entered), the match and some settings for the search
|
|
877
877
|
*/
|
|
878
|
-
lastSearchInfo: ISearchInfo;
|
|
878
|
+
readonly lastSearchInfo: ISearchInfo;
|
|
879
879
|
/** @hidden @internal */
|
|
880
880
|
page: number;
|
|
881
881
|
/** @hidden @internal */
|
|
@@ -909,17 +909,17 @@ export interface GridType extends IGridDataBindable {
|
|
|
909
909
|
document: Document;
|
|
910
910
|
/**
|
|
911
911
|
* The template for expanded row indicators.
|
|
912
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
912
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
913
913
|
*/
|
|
914
914
|
rowExpandedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>;
|
|
915
915
|
/**
|
|
916
916
|
* The template for collapsed row indicators.
|
|
917
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
917
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
918
918
|
*/
|
|
919
919
|
rowCollapsedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>;
|
|
920
920
|
/**
|
|
921
921
|
* The template for header icon
|
|
922
|
-
* It is of type TemplateRef, which represents an embedded template, used to
|
|
922
|
+
* It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
|
|
923
923
|
*/
|
|
924
924
|
excelStyleHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>;
|
|
925
925
|
selectRowOnClick: boolean;
|
|
@@ -1146,12 +1146,12 @@ export interface HierarchicalGridType extends GridType {
|
|
|
1146
1146
|
export interface PivotGridType extends GridType {
|
|
1147
1147
|
/**
|
|
1148
1148
|
* The configuration settings for the pivot grid.
|
|
1149
|
-
* it includes
|
|
1149
|
+
* it includes dimension strategy for rows and columns, filters and data keys
|
|
1150
1150
|
*/
|
|
1151
1151
|
pivotConfiguration: IPivotConfiguration;
|
|
1152
1152
|
/**
|
|
1153
1153
|
* An array of all dimensions (rows and columns) in the pivot grid.
|
|
1154
|
-
* it includes hierarchical level, filters and sorting,
|
|
1154
|
+
* it includes hierarchical level, filters and sorting, dimensional level, etc.
|
|
1155
1155
|
*/
|
|
1156
1156
|
allDimensions: IPivotDimension[];
|
|
1157
1157
|
/** Specifies whether to show the pivot configuration UI in the grid. */
|
|
@@ -1168,7 +1168,7 @@ export interface PivotGridType extends GridType {
|
|
|
1168
1168
|
/** @hidden @internal */
|
|
1169
1169
|
dimensionDataColumns: ColumnType[];
|
|
1170
1170
|
pivotRowWidths: number;
|
|
1171
|
-
/** Represents a method declaration for
|
|
1171
|
+
/** Represents a method declaration for setting up the columns for the pivot grid based on the pivot configuration */
|
|
1172
1172
|
setupColumns(): void;
|
|
1173
1173
|
/** Represents a method declaration that allows toggle of expansion state of a row (taken as a parameter) in the pivot grid */
|
|
1174
1174
|
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
|
/**
|
|
@@ -1760,7 +1760,7 @@ export declare abstract class IgxGridBaseDirective implements GridType, OnInit,
|
|
|
1760
1760
|
/**
|
|
1761
1761
|
* Represents the last search information.
|
|
1762
1762
|
*/
|
|
1763
|
-
lastSearchInfo: ISearchInfo;
|
|
1763
|
+
get lastSearchInfo(): ISearchInfo;
|
|
1764
1764
|
/**
|
|
1765
1765
|
* @hidden @internal
|
|
1766
1766
|
*/
|
|
@@ -1908,6 +1908,7 @@ export declare abstract class IgxGridBaseDirective implements GridType, OnInit,
|
|
|
1908
1908
|
protected _filterStrategy: IFilteringStrategy;
|
|
1909
1909
|
protected _autoGeneratedCols: any[];
|
|
1910
1910
|
protected _dataView: any[];
|
|
1911
|
+
protected _lastSearchInfo: ISearchInfo;
|
|
1911
1912
|
protected gridComputedStyles: any;
|
|
1912
1913
|
/** @hidden @internal */
|
|
1913
1914
|
get paginator(): IgxPaginatorComponent;
|
|
@@ -92,7 +92,7 @@ exports.default = () => (host, context) => __awaiter(void 0, void 0, void 0, fun
|
|
|
92
92
|
return s;
|
|
93
93
|
}
|
|
94
94
|
// ref - https://angular.dev/reference/configs/workspace-config#styles-and-scripts-configuration
|
|
95
|
-
if (s
|
|
95
|
+
if (typeof s === "object" && 'input' in s) {
|
|
96
96
|
return s.input;
|
|
97
97
|
}
|
|
98
98
|
}).filter((s) => s === null || s === void 0 ? void 0 : s.startsWith(srcRoot))[0];
|
package/package.json
CHANGED