igniteui-webcomponents-grids 7.1.0 → 7.2.0-beta.1
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/custom-elements.json +24487 -10990
- package/grids/3rdpartylicenses.txt +158 -524
- package/grids/combined.js +63752 -62828
- package/grids/lib/igc-action-strip-component.d.ts +0 -39
- package/grids/lib/igc-base-exporter.d.ts +1 -25
- package/grids/lib/igc-base-toolbar-directive.d.ts +0 -1
- package/grids/lib/igc-boolean-filtering-operand.d.ts +0 -2
- package/grids/lib/igc-column-component.d.ts +0 -489
- package/grids/lib/igc-column-exporting-event-args.d.ts +0 -5
- package/grids/lib/igc-column-group-component.d.ts +0 -55
- package/grids/lib/igc-column-layout-component.d.ts +0 -12
- package/grids/lib/igc-column-toggled-event-args.d.ts +1 -1
- package/grids/lib/igc-columns-auto-generated-event-args.d.ts +0 -2
- package/grids/lib/igc-csv-exporter-options.d.ts +0 -10
- package/grids/lib/igc-csv-exporter-service.d.ts +1 -23
- package/grids/lib/igc-data-clone-strategy.d.ts +0 -1
- package/grids/lib/igc-date-filtering-operand.d.ts +0 -2
- package/grids/lib/igc-date-summary-operand.d.ts +1 -38
- package/grids/lib/igc-dimensions-change.d.ts +1 -0
- package/grids/lib/igc-excel-exporter-options.d.ts +0 -27
- package/grids/lib/igc-excel-exporter-service.d.ts +1 -22
- package/grids/lib/igc-exporter-event-args.d.ts +12 -16
- package/grids/lib/igc-exporter-options-base.d.ts +4 -63
- package/grids/lib/igc-expression-tree.d.ts +1 -0
- package/grids/lib/igc-field-type.d.ts +0 -2
- package/grids/lib/igc-filtering-expressions-tree.d.ts +2 -0
- package/grids/lib/igc-filtering-operand.d.ts +0 -4
- package/grids/lib/igc-filtering-operation.d.ts +0 -2
- package/grids/lib/igc-grid-actions-base-directive.d.ts +0 -6
- package/grids/lib/igc-grid-base-component.d.ts +305 -0
- package/grids/lib/igc-grid-base-directive.d.ts +28 -1131
- package/grids/lib/igc-grid-component.d.ts +18 -512
- package/grids/lib/igc-grid-created-event-args.d.ts +4 -4
- package/grids/lib/igc-grid-editing-actions-component.d.ts +0 -7
- package/grids/lib/igc-grid-pinning-actions-component.d.ts +0 -12
- package/grids/lib/igc-grid-resource-strings.d.ts +1 -0
- package/grids/lib/igc-grid-state-base-directive.d.ts +0 -6
- package/grids/lib/igc-grid-state-component.d.ts +0 -5
- package/grids/lib/igc-grid-toolbar-actions-component.d.ts +0 -10
- package/grids/lib/igc-grid-toolbar-advanced-filtering-component.d.ts +0 -10
- package/grids/lib/igc-grid-toolbar-component.d.ts +0 -14
- package/grids/lib/igc-grid-toolbar-export-event-args.d.ts +2 -2
- package/grids/lib/igc-grid-toolbar-exporter-component.d.ts +0 -8
- package/grids/lib/igc-grid-toolbar-hiding-component.d.ts +0 -9
- package/grids/lib/igc-grid-toolbar-pinning-component.d.ts +0 -9
- package/grids/lib/igc-grid-toolbar-title-component.d.ts +0 -8
- package/grids/lib/igc-hierarchical-grid-base-component.d.ts +156 -0
- package/grids/lib/igc-hierarchical-grid-base-directive.d.ts +0 -20
- package/grids/lib/igc-hierarchical-grid-component.d.ts +28 -172
- package/grids/lib/igc-number-filtering-operand.d.ts +0 -2
- package/grids/lib/igc-number-summary-operand.d.ts +1 -53
- package/grids/lib/igc-overlay-outlet-directive.d.ts +0 -3
- package/grids/lib/igc-paginator-component.d.ts +2 -81
- package/grids/lib/igc-pinning-config.d.ts +2 -0
- package/grids/lib/igc-pivot-aggregation.d.ts +19 -0
- package/grids/lib/igc-pivot-aggregator.d.ts +3 -2
- package/grids/lib/igc-pivot-data-selector-component.d.ts +0 -87
- package/grids/lib/igc-pivot-date-dimension.d.ts +0 -3
- package/grids/lib/igc-pivot-grid-component.d.ts +0 -163
- package/grids/lib/igc-pivot-value.d.ts +1 -1
- package/grids/lib/igc-position-settings.d.ts +4 -0
- package/grids/lib/igc-position-strategy.d.ts +1 -4
- package/grids/lib/igc-query-builder-component.d.ts +1 -14
- package/grids/lib/igc-query-builder-header-component.d.ts +1 -13
- package/grids/lib/igc-row-data-cancelable-event-args.d.ts +28 -0
- package/grids/lib/igc-row-directive.d.ts +1 -55
- package/grids/lib/igc-row-island-base-component.d.ts +76 -0
- package/grids/lib/igc-row-island-component.d.ts +68 -1132
- package/grids/lib/igc-scroll-strategy.d.ts +1 -7
- package/grids/lib/igc-string-filtering-operand.d.ts +0 -4
- package/grids/lib/igc-summary-operand.d.ts +1 -33
- package/grids/lib/igc-summary-result.d.ts +0 -9
- package/grids/lib/igc-time-summary-operand.d.ts +0 -11
- package/grids/lib/igc-tree-grid-base-component.d.ts +226 -0
- package/grids/lib/igc-tree-grid-component.d.ts +23 -341
- package/grids/lib/igc-validation-errors.d.ts +4 -0
- package/grids/lib/index.d.ts +60 -55
- package/grids/lib/pivot-row-layout-type.d.ts +1 -1
- package/grids/lib/pivot-summary-position.d.ts +1 -1
- package/grids/themes/dark/bootstrap.css +1 -1
- package/grids/themes/dark/fluent.css +1 -1
- package/grids/themes/dark/indigo.css +1 -1
- package/grids/themes/dark/material.css +1 -1
- package/grids/themes/light/bootstrap.css +1 -1
- package/grids/themes/light/fluent.css +1 -1
- package/grids/themes/light/indigo.css +1 -1
- package/grids/themes/light/material.css +1 -1
- package/package.json +1 -1
- package/vscode.html-custom-data.json +1 -1
- package/web-types.json +1 -1
|
@@ -12,7 +12,6 @@ import { IgcPinColumnEventArgs } from './igc-pin-column-event-args';
|
|
|
12
12
|
import { IgcGridEditEventArgs } from './igc-grid-edit-event-args';
|
|
13
13
|
import { IgcGridEditDoneEventArgs } from './igc-grid-edit-done-event-args';
|
|
14
14
|
import { IgcColumnComponent } from './igc-column-component';
|
|
15
|
-
import { IgcColumnsAutoGeneratedEventArgs } from './igc-columns-auto-generated-event-args';
|
|
16
15
|
import { IgcSortingEventArgs } from './igc-sorting-event-args';
|
|
17
16
|
import { IgcSortingExpression } from './igc-sorting-expression';
|
|
18
17
|
import { IgcFilteringEventArgs } from './igc-filtering-event-args';
|
|
@@ -39,7 +38,6 @@ import { IgcGridTemplateContext } from './igc-grid-template-context';
|
|
|
39
38
|
import { IgcRenderFunction } from './common';
|
|
40
39
|
import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
|
|
41
40
|
import { IgcClipboardOptions } from './igc-clipboard-options';
|
|
42
|
-
import { IgcActionStripToken } from './igc-action-strip-token';
|
|
43
41
|
import { IgcGridRowDragGhostContext } from './igc-grid-row-drag-ghost-context';
|
|
44
42
|
import { IgcGridRowEditTextTemplateContext } from './igc-grid-row-edit-text-template-context';
|
|
45
43
|
import { IgcGridEmptyTemplateContext } from './igc-grid-empty-template-context';
|
|
@@ -95,9 +93,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
95
93
|
|
|
96
94
|
/**
|
|
97
95
|
* Gets/Sets the display time for the row adding snackbar notification.
|
|
98
|
-
*
|
|
99
|
-
* @remarks
|
|
100
|
-
* By default it is 6000ms.
|
|
101
96
|
*/
|
|
102
97
|
public set snackbarDisplayTime(value: number);
|
|
103
98
|
public get snackbarDisplayTime(): number;
|
|
@@ -106,13 +101,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
106
101
|
|
|
107
102
|
/**
|
|
108
103
|
* Gets/Sets whether to auto-generate the columns.
|
|
109
|
-
*
|
|
110
|
-
* @remarks
|
|
111
|
-
* The default value is false. When set to true, it will override all columns declared through code or in markup.
|
|
112
|
-
* @example
|
|
113
|
-
* ```html
|
|
114
|
-
* <igx-grid [data]="Data" [autoGenerate]="true"></igx-grid>
|
|
115
|
-
* ```
|
|
116
104
|
*/
|
|
117
105
|
public set autoGenerate(value: boolean);
|
|
118
106
|
public get autoGenerate(): boolean;
|
|
@@ -121,17 +109,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
121
109
|
|
|
122
110
|
/**
|
|
123
111
|
* Gets/Sets a list of property keys to be excluded from the generated column collection
|
|
124
|
-
* @remarks
|
|
125
|
-
* The collection is only used during initialization and changing it will not cause any changes in the generated columns at runtime
|
|
126
|
-
* unless the grid is destroyed and recreated. To modify the columns visible in the UI at runtime, please use their
|
|
127
|
-
* [hidden](https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/classes/IgxColumnComponent.html#hidden) property.
|
|
128
|
-
* @example
|
|
129
|
-
* ```html
|
|
130
|
-
* <igx-grid data=[Data] [autoGenerate]="true" [autoGenerateExclude]="['ProductName', 'Count']"></igx-grid>
|
|
131
|
-
* ```
|
|
132
|
-
* ```typescript
|
|
133
|
-
* const Data = [{ 'Id': '1', 'ProductName': 'name1', 'Description': 'description1', 'Count': 5 }]
|
|
134
|
-
* ```
|
|
135
112
|
*/
|
|
136
113
|
public set autoGenerateExclude(value: string[]);
|
|
137
114
|
public get autoGenerateExclude(): string[];
|
|
@@ -140,7 +117,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
140
117
|
|
|
141
118
|
/**
|
|
142
119
|
* Controls whether columns moving is enabled in the grid.
|
|
143
|
-
*
|
|
144
120
|
*/
|
|
145
121
|
public set moving(value: boolean);
|
|
146
122
|
public get moving(): boolean;
|
|
@@ -149,17 +125,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
149
125
|
|
|
150
126
|
/**
|
|
151
127
|
* Gets/Sets a custom template when empty.
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* ```html
|
|
155
|
-
* <ng-template igxGridEmpty>
|
|
156
|
-
* <!-- content to show when the grid is empty -->
|
|
157
|
-
* </ng-template>
|
|
158
|
-
* ```
|
|
159
|
-
* Or
|
|
160
|
-
* ```html
|
|
161
|
-
* <igx-grid [id]="'igx-grid-1'" [data]="Data" [emptyGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
|
|
162
|
-
* ```
|
|
163
128
|
*/
|
|
164
129
|
public set emptyGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
|
|
165
130
|
public get emptyGridTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
|
|
@@ -168,11 +133,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
168
133
|
|
|
169
134
|
/**
|
|
170
135
|
* Gets/Sets a custom template for adding row UI when grid is empty.
|
|
171
|
-
*
|
|
172
|
-
* @example
|
|
173
|
-
* ```html
|
|
174
|
-
* <igx-grid [id]="'igx-grid-1'" [data]="Data" [addRowEmptyTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
|
|
175
|
-
* ```
|
|
176
136
|
*/
|
|
177
137
|
public set addRowEmptyTemplate(value: IgcRenderFunction<void>);
|
|
178
138
|
public get addRowEmptyTemplate(): IgcRenderFunction<void>;
|
|
@@ -181,17 +141,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
181
141
|
|
|
182
142
|
/**
|
|
183
143
|
* Gets/Sets a custom template when loading.
|
|
184
|
-
*
|
|
185
|
-
* @example
|
|
186
|
-
* ```html
|
|
187
|
-
* <ng-template igxGridLoading>
|
|
188
|
-
* <!-- content to show when the grid is loading -->
|
|
189
|
-
* </ng-template>
|
|
190
|
-
* ```
|
|
191
|
-
* Or
|
|
192
|
-
* ```html
|
|
193
|
-
* <igx-grid [id]="'igx-grid-1'" [data]="Data" [loadingGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
|
|
194
|
-
* ```
|
|
195
144
|
*/
|
|
196
145
|
public set loadingGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
|
|
197
146
|
public get loadingGridTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
|
|
@@ -199,7 +148,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
199
148
|
|
|
200
149
|
|
|
201
150
|
/**
|
|
202
|
-
* Get/Set
|
|
151
|
+
* Get/Set summary row height
|
|
203
152
|
*/
|
|
204
153
|
public set summaryRowHeight(value: number);
|
|
205
154
|
public get summaryRowHeight(): number;
|
|
@@ -208,11 +157,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
208
157
|
|
|
209
158
|
/**
|
|
210
159
|
* Gets/Sets the data clone strategy of the grid when in edit mode.
|
|
211
|
-
*
|
|
212
|
-
* @example
|
|
213
|
-
* ```html
|
|
214
|
-
* <igx-grid #grid [data]="localData" [dataCloneStrategy]="customCloneStrategy"></igx-grid>
|
|
215
|
-
* ```
|
|
216
160
|
*/
|
|
217
161
|
public set dataCloneStrategy(value: IgcDataCloneStrategy);
|
|
218
162
|
public get dataCloneStrategy(): IgcDataCloneStrategy;
|
|
@@ -233,15 +177,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
233
177
|
* Accepts an object literal, containing key-value pairs,
|
|
234
178
|
* where the key is the name of the CSS class and the value is
|
|
235
179
|
* either a callback function that returns a boolean, or boolean, like so:
|
|
236
|
-
* ```typescript
|
|
237
|
-
* callback = (row: RowType) => { return row.selected > 6; }
|
|
238
|
-
* rowClasses = { 'className' : this.callback };
|
|
239
|
-
* ```
|
|
240
|
-
* ```html
|
|
241
|
-
* <igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>
|
|
242
|
-
* ```
|
|
243
|
-
*
|
|
244
|
-
* @memberof IgxColumnComponent
|
|
245
180
|
*/
|
|
246
181
|
public set rowClasses(value: any);
|
|
247
182
|
public get rowClasses(): any;
|
|
@@ -253,17 +188,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
253
188
|
* Sets conditional style properties on the grid row element.
|
|
254
189
|
* It accepts an object literal where the keys are
|
|
255
190
|
* the style properties and the value is an expression to be evaluated.
|
|
256
|
-
* ```typescript
|
|
257
|
-
* styles = {
|
|
258
|
-
* background: 'yellow',
|
|
259
|
-
* color: (row: RowType) => row.selected : 'red': 'white'
|
|
260
|
-
* }
|
|
261
|
-
* ```
|
|
262
|
-
* ```html
|
|
263
|
-
* <igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>
|
|
264
|
-
* ```
|
|
265
|
-
*
|
|
266
|
-
* @memberof IgxColumnComponent
|
|
267
191
|
*/
|
|
268
192
|
public set rowStyles(value: any);
|
|
269
193
|
public get rowStyles(): any;
|
|
@@ -272,11 +196,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
272
196
|
|
|
273
197
|
/**
|
|
274
198
|
* Gets/Sets the primary key.
|
|
275
|
-
*
|
|
276
|
-
* @example
|
|
277
|
-
* ```html
|
|
278
|
-
* <igx-grid #grid [data]="localData" [primaryKey]="'ProductID'" [autoGenerate]="true"></igx-grid>
|
|
279
|
-
* ```
|
|
280
199
|
*/
|
|
281
200
|
public set primaryKey(value: string);
|
|
282
201
|
public get primaryKey(): string;
|
|
@@ -296,18 +215,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
296
215
|
|
|
297
216
|
|
|
298
217
|
|
|
299
|
-
/* contentChildren */
|
|
300
|
-
/* blazorInclude */
|
|
301
|
-
/* blazorTreatAsCollection */
|
|
302
|
-
/* blazorCollectionName: ActionStripCollection */
|
|
303
|
-
/* blazorCollectionItemName: ActionStrip */
|
|
304
|
-
/* ngQueryListName: actionStripComponents */
|
|
305
|
-
/** @hidden @internal */
|
|
306
|
-
public set actionStripComponents(value: IgcActionStripToken[]);
|
|
307
|
-
public get actionStripComponents(): IgcActionStripToken[];
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
218
|
|
|
312
219
|
/**
|
|
313
220
|
* Gets the custom template, if any, used for row drag ghost.
|
|
@@ -427,11 +334,9 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
427
334
|
|
|
428
335
|
|
|
429
336
|
|
|
337
|
+
/* treatAsRef */
|
|
430
338
|
/**
|
|
431
339
|
* Gets/Sets the resource strings.
|
|
432
|
-
*
|
|
433
|
-
* @remarks
|
|
434
|
-
* By default it uses EN resources.
|
|
435
340
|
*/
|
|
436
341
|
public set resourceStrings(value: IgcGridResourceStrings);
|
|
437
342
|
public get resourceStrings(): IgcGridResourceStrings;
|
|
@@ -439,14 +344,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
439
344
|
|
|
440
345
|
|
|
441
346
|
/**
|
|
442
|
-
* Gets/Sets the filtering logic of the
|
|
443
|
-
*
|
|
444
|
-
* @remarks
|
|
445
|
-
* The default is AND.
|
|
446
|
-
* @example
|
|
447
|
-
* ```html
|
|
448
|
-
* <igx-grid [data]="Data" [autoGenerate]="true" [filteringLogic]="filtering"></igx-grid>
|
|
449
|
-
* ```
|
|
347
|
+
* Gets/Sets the filtering logic of the grid.
|
|
450
348
|
*/
|
|
451
349
|
public set filteringLogic(value: FilteringLogic);
|
|
452
350
|
public get filteringLogic(): FilteringLogic;
|
|
@@ -456,13 +354,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
456
354
|
/* mustSetInCodePlatforms: WebComponents;Blazor */
|
|
457
355
|
/**
|
|
458
356
|
* Gets/Sets the filtering state.
|
|
459
|
-
*
|
|
460
|
-
* @example
|
|
461
|
-
* ```html
|
|
462
|
-
* <igx-grid #grid [data]="Data" [autoGenerate]="true" [(filteringExpressionsTree)]="model.filteringExpressions"></igx-grid>
|
|
463
|
-
* ```
|
|
464
|
-
* @remarks
|
|
465
|
-
* Supports two-way binding.
|
|
466
357
|
*/
|
|
467
358
|
public set filteringExpressionsTree(value: IgcFilteringExpressionsTree);
|
|
468
359
|
public get filteringExpressionsTree(): IgcFilteringExpressionsTree;
|
|
@@ -471,12 +362,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
471
362
|
|
|
472
363
|
/**
|
|
473
364
|
* Gets/Sets the advanced filtering state.
|
|
474
|
-
*
|
|
475
|
-
* @example
|
|
476
|
-
* ```typescript
|
|
477
|
-
* let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;
|
|
478
|
-
* this.grid.advancedFilteringExpressionsTree = logic;
|
|
479
|
-
* ```
|
|
480
365
|
*/
|
|
481
366
|
public set advancedFilteringExpressionsTree(value: IgcFilteringExpressionsTree);
|
|
482
367
|
public get advancedFilteringExpressionsTree(): IgcFilteringExpressionsTree;
|
|
@@ -485,9 +370,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
485
370
|
|
|
486
371
|
/**
|
|
487
372
|
* Gets/Sets the locale.
|
|
488
|
-
*
|
|
489
|
-
* @remarks
|
|
490
|
-
* If not set, returns browser's language.
|
|
491
373
|
*/
|
|
492
374
|
public set locale(value: string);
|
|
493
375
|
public get locale(): string;
|
|
@@ -501,9 +383,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
501
383
|
|
|
502
384
|
/**
|
|
503
385
|
* Gets/Sets if the row selectors are hidden.
|
|
504
|
-
*
|
|
505
|
-
* @remarks
|
|
506
|
-
* By default row selectors are shown
|
|
507
386
|
*/
|
|
508
387
|
public set hideRowSelectors(value: boolean);
|
|
509
388
|
public get hideRowSelectors(): boolean;
|
|
@@ -512,11 +391,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
512
391
|
|
|
513
392
|
/**
|
|
514
393
|
* Gets/Sets whether rows can be moved.
|
|
515
|
-
*
|
|
516
|
-
* @example
|
|
517
|
-
* ```html
|
|
518
|
-
* <igx-grid #grid [rowDraggable]="true"></igx-grid>
|
|
519
|
-
* ```
|
|
520
394
|
*/
|
|
521
395
|
public set rowDraggable(value: boolean);
|
|
522
396
|
public get rowDraggable(): boolean;
|
|
@@ -525,11 +399,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
525
399
|
|
|
526
400
|
/**
|
|
527
401
|
* Gets/Sets the trigger for validators used when editing the grid.
|
|
528
|
-
*
|
|
529
|
-
* @example
|
|
530
|
-
* ```html
|
|
531
|
-
* <igx-grid #grid validationTrigger='blur'></igx-grid>
|
|
532
|
-
* ```
|
|
533
402
|
*/
|
|
534
403
|
public set validationTrigger(value: GridValidationTrigger);
|
|
535
404
|
public get validationTrigger(): GridValidationTrigger;
|
|
@@ -538,13 +407,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
538
407
|
|
|
539
408
|
/**
|
|
540
409
|
* Gets/Sets whether the rows are editable.
|
|
541
|
-
*
|
|
542
|
-
* @remarks
|
|
543
|
-
* By default it is set to false.
|
|
544
|
-
* @example
|
|
545
|
-
* ```html
|
|
546
|
-
* <igx-grid #grid [rowEditable]="true" [primaryKey]="'ProductID'" ></igx-grid>
|
|
547
|
-
* ```
|
|
548
410
|
*/
|
|
549
411
|
public set rowEditable(value: boolean);
|
|
550
412
|
public get rowEditable(): boolean;
|
|
@@ -553,11 +415,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
553
415
|
|
|
554
416
|
/**
|
|
555
417
|
* Gets/Sets the height.
|
|
556
|
-
*
|
|
557
|
-
* @example
|
|
558
|
-
* ```html
|
|
559
|
-
* <igx-grid #grid [data]="Data" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
560
|
-
* ```
|
|
561
418
|
*/
|
|
562
419
|
public set height(value: string);
|
|
563
420
|
public get height(): string;
|
|
@@ -566,11 +423,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
566
423
|
|
|
567
424
|
/**
|
|
568
425
|
* Gets/Sets the width of the grid.
|
|
569
|
-
*
|
|
570
|
-
* @example
|
|
571
|
-
* ```typescript
|
|
572
|
-
* let gridWidth = this.grid.width;
|
|
573
|
-
* ```
|
|
574
426
|
*/
|
|
575
427
|
public set width(value: string);
|
|
576
428
|
public get width(): string;
|
|
@@ -579,11 +431,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
579
431
|
|
|
580
432
|
/**
|
|
581
433
|
* Gets/Sets the row height.
|
|
582
|
-
*
|
|
583
|
-
* @example
|
|
584
|
-
* ```html
|
|
585
|
-
* <igx-grid #grid [data]="localData" [rowHeight]="100" [autoGenerate]="true"></igx-grid>
|
|
586
|
-
* ```
|
|
587
434
|
*/
|
|
588
435
|
public set rowHeight(value: number);
|
|
589
436
|
public get rowHeight(): number;
|
|
@@ -592,11 +439,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
592
439
|
|
|
593
440
|
/**
|
|
594
441
|
* Gets/Sets the default width of the columns.
|
|
595
|
-
*
|
|
596
|
-
* @example
|
|
597
|
-
* ```html
|
|
598
|
-
* <igx-grid #grid [data]="localData" [columnWidth]="100" [autoGenerate]="true"></igx-grid>
|
|
599
|
-
* ```
|
|
600
442
|
*/
|
|
601
443
|
public set columnWidth(value: string);
|
|
602
444
|
public get columnWidth(): string;
|
|
@@ -605,11 +447,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
605
447
|
|
|
606
448
|
/**
|
|
607
449
|
* Get/Sets the message displayed when there are no records.
|
|
608
|
-
*
|
|
609
|
-
* @example
|
|
610
|
-
* ```html
|
|
611
|
-
* <igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>
|
|
612
|
-
* ```
|
|
613
450
|
*/
|
|
614
451
|
public set emptyGridMessage(value: string);
|
|
615
452
|
public get emptyGridMessage(): string;
|
|
@@ -618,11 +455,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
618
455
|
|
|
619
456
|
/**
|
|
620
457
|
* Gets/Sets whether the grid is going to show a loading indicator.
|
|
621
|
-
*
|
|
622
|
-
* @example
|
|
623
|
-
* ```html
|
|
624
|
-
* <igx-grid #grid [data]="Data" [isLoading]="true" [autoGenerate]="true"></igx-grid>
|
|
625
|
-
* ```
|
|
626
458
|
*/
|
|
627
459
|
public set isLoading(value: boolean);
|
|
628
460
|
public get isLoading(): boolean;
|
|
@@ -631,15 +463,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
631
463
|
|
|
632
464
|
/**
|
|
633
465
|
* Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid
|
|
634
|
-
*
|
|
635
|
-
* @remarks
|
|
636
|
-
* This will allow to bind the grid to remote data and having auto-generated columns at the same time.
|
|
637
|
-
* Note that after generating the columns, this property would be disabled to avoid re-creating
|
|
638
|
-
* columns each time a new data is assigned.
|
|
639
|
-
* @example
|
|
640
|
-
* ```typescript
|
|
641
|
-
* this.grid.shouldGenerate = true;
|
|
642
|
-
* ```
|
|
643
466
|
* @deprecated Column re-creation now relies on `autoGenerate` instead.
|
|
644
467
|
*/
|
|
645
468
|
public set shouldGenerate(value: boolean);
|
|
@@ -649,11 +472,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
649
472
|
|
|
650
473
|
/**
|
|
651
474
|
* Gets/Sets the message displayed when there are no records and the grid is filtered.
|
|
652
|
-
*
|
|
653
|
-
* @example
|
|
654
|
-
* ```html
|
|
655
|
-
* <igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>
|
|
656
|
-
* ```
|
|
657
475
|
*/
|
|
658
476
|
public set emptyFilteredGridMessage(value: string);
|
|
659
477
|
public get emptyFilteredGridMessage(): string;
|
|
@@ -663,14 +481,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
663
481
|
/* mustSetInCodePlatforms: WebComponents;Blazor;React */
|
|
664
482
|
/**
|
|
665
483
|
* Gets/Sets the initial pinning configuration.
|
|
666
|
-
*
|
|
667
|
-
* @remarks
|
|
668
|
-
* Allows to apply pinning the columns to the start or the end.
|
|
669
|
-
* Note that pinning to both sides at a time is not allowed.
|
|
670
|
-
* @example
|
|
671
|
-
* ```html
|
|
672
|
-
* <igx-grid [pinning]="pinningConfig"></igx-grid>
|
|
673
|
-
* ```
|
|
674
484
|
*/
|
|
675
485
|
public set pinning(value: IgcPinningConfig);
|
|
676
486
|
public get pinning(): IgcPinningConfig;
|
|
@@ -679,11 +489,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
679
489
|
|
|
680
490
|
/**
|
|
681
491
|
* Gets/Sets if the filtering is enabled.
|
|
682
|
-
*
|
|
683
|
-
* @example
|
|
684
|
-
* ```html
|
|
685
|
-
* <igx-grid #grid [data]="localData" [allowFiltering]="true" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
686
|
-
* ```
|
|
687
492
|
*/
|
|
688
493
|
public set allowFiltering(value: boolean);
|
|
689
494
|
public get allowFiltering(): boolean;
|
|
@@ -692,11 +497,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
692
497
|
|
|
693
498
|
/**
|
|
694
499
|
* Gets/Sets a value indicating whether the advanced filtering is enabled.
|
|
695
|
-
*
|
|
696
|
-
* @example
|
|
697
|
-
* ```html
|
|
698
|
-
* <igx-grid #grid [data]="localData" [allowAdvancedFiltering]="true" [autoGenerate]="true"></igx-grid>
|
|
699
|
-
* ```
|
|
700
500
|
*/
|
|
701
501
|
public set allowAdvancedFiltering(value: boolean);
|
|
702
502
|
public get allowAdvancedFiltering(): boolean;
|
|
@@ -705,13 +505,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
705
505
|
|
|
706
506
|
/**
|
|
707
507
|
* Gets/Sets the filter mode.
|
|
708
|
-
*
|
|
709
|
-
* @example
|
|
710
|
-
* ```html
|
|
711
|
-
* <igx-grid #grid [data]="localData" [filterMode]="'quickFilter'" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
712
|
-
* ```
|
|
713
|
-
* @remarks
|
|
714
|
-
* By default it's set to FilterMode.quickFilter.
|
|
715
508
|
*/
|
|
716
509
|
public set filterMode(value: FilterMode);
|
|
717
510
|
public get filterMode(): FilterMode;
|
|
@@ -720,13 +513,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
720
513
|
|
|
721
514
|
/**
|
|
722
515
|
* Gets/Sets the summary position.
|
|
723
|
-
*
|
|
724
|
-
* @example
|
|
725
|
-
* ```html
|
|
726
|
-
* <igx-grid #grid [data]="localData" summaryPosition="top" [autoGenerate]="true"></igx-grid>
|
|
727
|
-
* ```
|
|
728
|
-
* @remarks
|
|
729
|
-
* By default it is bottom.
|
|
730
516
|
*/
|
|
731
517
|
public set summaryPosition(value: GridSummaryPosition);
|
|
732
518
|
public get summaryPosition(): GridSummaryPosition;
|
|
@@ -735,13 +521,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
735
521
|
|
|
736
522
|
/**
|
|
737
523
|
* Gets/Sets the summary calculation mode.
|
|
738
|
-
*
|
|
739
|
-
* @example
|
|
740
|
-
* ```html
|
|
741
|
-
* <igx-grid #grid [data]="localData" summaryCalculationMode="rootLevelOnly" [autoGenerate]="true"></igx-grid>
|
|
742
|
-
* ```
|
|
743
|
-
* @remarks
|
|
744
|
-
* By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.
|
|
745
524
|
*/
|
|
746
525
|
public set summaryCalculationMode(value: GridSummaryCalculationMode);
|
|
747
526
|
public get summaryCalculationMode(): GridSummaryCalculationMode;
|
|
@@ -750,14 +529,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
750
529
|
|
|
751
530
|
/**
|
|
752
531
|
* Controls whether the summary row is visible when groupBy/parent row is collapsed.
|
|
753
|
-
*
|
|
754
|
-
* @example
|
|
755
|
-
* ```html
|
|
756
|
-
* <igx-grid #grid [data]="localData" [showSummaryOnCollapse]="true" [autoGenerate]="true"></igx-grid>
|
|
757
|
-
* ```
|
|
758
|
-
* @remarks
|
|
759
|
-
* By default showSummaryOnCollapse is set to 'false' which means that the summary row is not visible
|
|
760
|
-
* when the groupBy/parent row is collapsed.
|
|
761
532
|
*/
|
|
762
533
|
public set showSummaryOnCollapse(value: boolean);
|
|
763
534
|
public get showSummaryOnCollapse(): boolean;
|
|
@@ -766,11 +537,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
766
537
|
|
|
767
538
|
/**
|
|
768
539
|
* Gets/Sets the filtering strategy of the grid.
|
|
769
|
-
*
|
|
770
|
-
* @example
|
|
771
|
-
* ```html
|
|
772
|
-
* <igx-grid #grid [data]="localData" [filterStrategy]="filterStrategy"></igx-grid>
|
|
773
|
-
* ```
|
|
774
540
|
*/
|
|
775
541
|
public set filterStrategy(value: IgcFilteringStrategy);
|
|
776
542
|
public get filterStrategy(): IgcFilteringStrategy;
|
|
@@ -779,11 +545,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
779
545
|
|
|
780
546
|
/**
|
|
781
547
|
* Gets/Sets the sorting strategy of the grid.
|
|
782
|
-
*
|
|
783
|
-
* @example
|
|
784
|
-
* ```html
|
|
785
|
-
* <igx-grid #grid [data]="localData" [sortStrategy]="sortStrategy"></igx-grid>
|
|
786
|
-
* ```
|
|
787
548
|
*/
|
|
788
549
|
public set sortStrategy(value: IgcGridSortingStrategy);
|
|
789
550
|
public get sortStrategy(): IgcGridSortingStrategy;
|
|
@@ -793,11 +554,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
793
554
|
/* csSuppress */
|
|
794
555
|
/**
|
|
795
556
|
* Gets/Sets the merge strategy of the grid.
|
|
796
|
-
*
|
|
797
|
-
* @example
|
|
798
|
-
* ```html
|
|
799
|
-
* <igx-grid #grid [data]="localData" [mergeStrategy]="mergeStrategy"></igx-grid>
|
|
800
|
-
* ```
|
|
801
557
|
*/
|
|
802
558
|
public set mergeStrategy(value: IgcGridMergeStrategy);
|
|
803
559
|
public get mergeStrategy(): IgcGridMergeStrategy;
|
|
@@ -807,15 +563,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
807
563
|
/**
|
|
808
564
|
* Gets/Sets the sorting options - single or multiple sorting.
|
|
809
565
|
* Accepts an `ISortingOptions` object with any of the `mode` properties.
|
|
810
|
-
*
|
|
811
|
-
* @example
|
|
812
|
-
* ```typescript
|
|
813
|
-
* const _sortingOptions: ISortingOptions = {
|
|
814
|
-
* mode: 'single'
|
|
815
|
-
* }
|
|
816
|
-
* ```html
|
|
817
|
-
* <igx-grid [sortingOptions]="sortingOptions"><igx-grid>
|
|
818
|
-
* ```
|
|
819
566
|
*/
|
|
820
567
|
public set sortingOptions(value: IgcSortingOptions);
|
|
821
568
|
public get sortingOptions(): IgcSortingOptions;
|
|
@@ -828,13 +575,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
828
575
|
/* blazorPrimitiveValue */
|
|
829
576
|
/**
|
|
830
577
|
* Gets/Sets the current selection state.
|
|
831
|
-
*
|
|
832
|
-
* @remarks
|
|
833
|
-
* Represents the selected rows' IDs (primary key or rowData)
|
|
834
|
-
* @example
|
|
835
|
-
* ```html
|
|
836
|
-
* <igx-grid [data]="localData" primaryKey="ID" rowSelection="multiple" [selectedRows]="[0, 1, 2]"><igx-grid>
|
|
837
|
-
* ```
|
|
838
578
|
*/
|
|
839
579
|
/* @tsTwoWayProperty (true, "SelectedRowsChange", "Detail", false) */
|
|
840
580
|
/* @blazorSynthesizeTwoWayBind */
|
|
@@ -845,12 +585,7 @@ public set selectedRows(value: any[]);
|
|
|
845
585
|
|
|
846
586
|
/* csSuppress */
|
|
847
587
|
/**
|
|
848
|
-
* A list of
|
|
849
|
-
*
|
|
850
|
-
* @example
|
|
851
|
-
* ```typescript
|
|
852
|
-
* const rowList = this.grid.rowList;
|
|
853
|
-
* ```
|
|
588
|
+
* A list of grid row.
|
|
854
589
|
*/
|
|
855
590
|
public get rowList(): IgcRowDirective[];
|
|
856
591
|
|
|
@@ -858,12 +593,7 @@ public set selectedRows(value: any[]);
|
|
|
858
593
|
|
|
859
594
|
/* csSuppress */
|
|
860
595
|
/**
|
|
861
|
-
* A list of currently rendered
|
|
862
|
-
*
|
|
863
|
-
* @example
|
|
864
|
-
* ```typescript
|
|
865
|
-
* const dataList = this.grid.dataRowList;
|
|
866
|
-
* ```
|
|
596
|
+
* A list of currently rendered grid row's.
|
|
867
597
|
*/
|
|
868
598
|
public get dataRowList(): IgcRowDirective[];
|
|
869
599
|
|
|
@@ -896,13 +626,6 @@ public set selectedRows(value: any[]);
|
|
|
896
626
|
/* mustSetInCodePlatforms: WebComponents;Blazor;React */
|
|
897
627
|
/**
|
|
898
628
|
* Gets/Sets the sorting state.
|
|
899
|
-
*
|
|
900
|
-
* @remarks
|
|
901
|
-
* Supports two-way data binding.
|
|
902
|
-
* @example
|
|
903
|
-
* ```html
|
|
904
|
-
* <igx-grid #grid [data]="Data" [autoGenerate]="true" [(sortingExpressions)]="model.sortingExpressions"></igx-grid>
|
|
905
|
-
* ```
|
|
906
629
|
*/
|
|
907
630
|
public set sortingExpressions(value: IgcSortingExpression[]);
|
|
908
631
|
public get sortingExpressions(): IgcSortingExpression[];
|
|
@@ -911,11 +634,6 @@ public set selectedRows(value: any[]);
|
|
|
911
634
|
|
|
912
635
|
/**
|
|
913
636
|
* Gets the number of hidden columns.
|
|
914
|
-
*
|
|
915
|
-
* @example
|
|
916
|
-
* ```typescript
|
|
917
|
-
* const hiddenCol = this.grid.hiddenColumnsCount;
|
|
918
|
-
* ``
|
|
919
637
|
*/
|
|
920
638
|
public get hiddenColumnsCount(): number;
|
|
921
639
|
|
|
@@ -932,12 +650,6 @@ public set selectedRows(value: any[]);
|
|
|
932
650
|
* Gets/Sets whether the grid has batch editing enabled.
|
|
933
651
|
* When batch editing is enabled, changes are not made directly to the underlying data.
|
|
934
652
|
* Instead, they are stored as transactions, which can later be committed w/ the `commit` method.
|
|
935
|
-
*
|
|
936
|
-
* @example
|
|
937
|
-
* ```html
|
|
938
|
-
* <igx-grid [batchEditing]="true" [data]="someData">
|
|
939
|
-
* </igx-grid>
|
|
940
|
-
* ```
|
|
941
653
|
*/
|
|
942
654
|
public set batchEditing(value: boolean);
|
|
943
655
|
public get batchEditing(): boolean;
|
|
@@ -954,9 +666,6 @@ public set selectedRows(value: any[]);
|
|
|
954
666
|
|
|
955
667
|
/**
|
|
956
668
|
* Gets/Sets cell selection mode.
|
|
957
|
-
*
|
|
958
|
-
* @remarks
|
|
959
|
-
* By default the cell selection mode is multiple
|
|
960
669
|
* @param selectionMode: GridSelectionMode
|
|
961
670
|
*/
|
|
962
671
|
public set cellSelection(value: GridSelectionMode);
|
|
@@ -966,7 +675,6 @@ public set selectedRows(value: any[]);
|
|
|
966
675
|
|
|
967
676
|
/**
|
|
968
677
|
* Gets/Sets cell merge mode.
|
|
969
|
-
*
|
|
970
678
|
*/
|
|
971
679
|
public set cellMergeMode(value: GridCellMergeMode);
|
|
972
680
|
public get cellMergeMode(): GridCellMergeMode;
|
|
@@ -975,10 +683,6 @@ public set selectedRows(value: any[]);
|
|
|
975
683
|
|
|
976
684
|
/**
|
|
977
685
|
* Gets/Sets row selection mode
|
|
978
|
-
*
|
|
979
|
-
* @remarks
|
|
980
|
-
* By default the row selection mode is 'none'
|
|
981
|
-
* Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple'
|
|
982
686
|
*/
|
|
983
687
|
public set rowSelection(value: GridSelectionMode);
|
|
984
688
|
public get rowSelection(): GridSelectionMode;
|
|
@@ -987,9 +691,6 @@ public set selectedRows(value: any[]);
|
|
|
987
691
|
|
|
988
692
|
/**
|
|
989
693
|
* Gets/Sets column selection mode
|
|
990
|
-
*
|
|
991
|
-
* @remarks
|
|
992
|
-
* By default the row selection mode is none
|
|
993
694
|
* @param selectionMode: GridSelectionMode
|
|
994
695
|
*/
|
|
995
696
|
public set columnSelection(value: GridSelectionMode);
|
|
@@ -1006,11 +707,6 @@ public set selectedRows(value: any[]);
|
|
|
1006
707
|
|
|
1007
708
|
/**
|
|
1008
709
|
* Returns an array of objects containing the filtered data.
|
|
1009
|
-
*
|
|
1010
|
-
* @example
|
|
1011
|
-
* ```typescript
|
|
1012
|
-
* let filteredData = this.grid.filteredData;
|
|
1013
|
-
* ```
|
|
1014
710
|
*/
|
|
1015
711
|
public get filteredData(): any;
|
|
1016
712
|
|
|
@@ -1018,11 +714,6 @@ public set selectedRows(value: any[]);
|
|
|
1018
714
|
|
|
1019
715
|
/**
|
|
1020
716
|
* Returns an array containing the filtered sorted data.
|
|
1021
|
-
*
|
|
1022
|
-
* @example
|
|
1023
|
-
* ```typescript
|
|
1024
|
-
* const filteredSortedData = this.grid1.filteredSortedData;
|
|
1025
|
-
* ```
|
|
1026
717
|
*/
|
|
1027
718
|
public get filteredSortedData(): any[];
|
|
1028
719
|
|
|
@@ -1030,13 +721,6 @@ public set selectedRows(value: any[]);
|
|
|
1030
721
|
|
|
1031
722
|
/**
|
|
1032
723
|
* Returns the state of the grid virtualization.
|
|
1033
|
-
*
|
|
1034
|
-
* @remarks
|
|
1035
|
-
* Includes the start index and how many records are rendered.
|
|
1036
|
-
* @example
|
|
1037
|
-
* ```typescript
|
|
1038
|
-
* const gridVirtState = this.grid1.virtualizationState;
|
|
1039
|
-
* ```
|
|
1040
724
|
*/
|
|
1041
725
|
public get virtualizationState(): IgcForOfState;
|
|
1042
726
|
|
|
@@ -1045,15 +729,6 @@ public set selectedRows(value: any[]);
|
|
|
1045
729
|
/* blazorCSSuppress */
|
|
1046
730
|
/**
|
|
1047
731
|
* Gets/Sets a list of key-value pairs [row ID, expansion state].
|
|
1048
|
-
*
|
|
1049
|
-
* @remarks
|
|
1050
|
-
* Includes only states that differ from the default one.
|
|
1051
|
-
* Supports two-way binding.
|
|
1052
|
-
* @example
|
|
1053
|
-
* ```html
|
|
1054
|
-
* <igx-grid #grid [data]="data" [(expansionStates)]="model.expansionStates">
|
|
1055
|
-
* </igx-grid>
|
|
1056
|
-
* ```
|
|
1057
732
|
*/
|
|
1058
733
|
public set expansionStates(value: Map<any, boolean>);
|
|
1059
734
|
public get expansionStates(): Map<any, boolean>;
|
|
@@ -1062,10 +737,6 @@ public set selectedRows(value: any[]);
|
|
|
1062
737
|
|
|
1063
738
|
/**
|
|
1064
739
|
* Gets/Sets the outlet used to attach the grid's overlays to.
|
|
1065
|
-
*
|
|
1066
|
-
* @remarks
|
|
1067
|
-
* If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
|
|
1068
|
-
*
|
|
1069
740
|
* @deprecated Overlays now use the HTML Popover API and no longer move to the document body by default, so using outlet is also no longer needed.
|
|
1070
741
|
* body by default, so using outlet is also no longer needed.
|
|
1071
742
|
*/
|
|
@@ -1077,59 +748,34 @@ public set selectedRows(value: any[]);
|
|
|
1077
748
|
|
|
1078
749
|
/**
|
|
1079
750
|
* Gets the default row height.
|
|
1080
|
-
*
|
|
1081
|
-
* @example
|
|
1082
|
-
* ```typescript
|
|
1083
|
-
* const rowHeigh = this.grid.defaultRowHeight;
|
|
1084
|
-
* ```
|
|
1085
751
|
*/
|
|
1086
752
|
public get defaultRowHeight(): number;
|
|
1087
753
|
|
|
1088
754
|
|
|
1089
755
|
|
|
1090
756
|
/**
|
|
1091
|
-
* Gets an array of
|
|
1092
|
-
*
|
|
1093
|
-
* @example
|
|
1094
|
-
* ```typescript
|
|
1095
|
-
* const colums = this.grid.columns.
|
|
1096
|
-
* ```
|
|
757
|
+
* Gets an array of columns.
|
|
1097
758
|
*/
|
|
1098
759
|
public get columns(): IgcColumnComponent[];
|
|
1099
760
|
|
|
1100
761
|
|
|
1101
762
|
|
|
1102
763
|
/**
|
|
1103
|
-
* Gets an array of the pinned
|
|
1104
|
-
*
|
|
1105
|
-
* @example
|
|
1106
|
-
* ```typescript
|
|
1107
|
-
* const pinnedColumns = this.grid.pinnedColumns.
|
|
1108
|
-
* ```
|
|
764
|
+
* Gets an array of the pinned columns.
|
|
1109
765
|
*/
|
|
1110
766
|
public get pinnedColumns(): IgcColumnComponent[];
|
|
1111
767
|
|
|
1112
768
|
|
|
1113
769
|
|
|
1114
770
|
/**
|
|
1115
|
-
* Gets an array of the pinned to the left
|
|
1116
|
-
*
|
|
1117
|
-
* @example
|
|
1118
|
-
* ```typescript
|
|
1119
|
-
* const pinnedColumns = this.grid.pinnedStartColumns.
|
|
1120
|
-
* ```
|
|
771
|
+
* Gets an array of the pinned to the left columns.
|
|
1121
772
|
*/
|
|
1122
773
|
public get pinnedStartColumns(): IgcColumnComponent[];
|
|
1123
774
|
|
|
1124
775
|
|
|
1125
776
|
|
|
1126
777
|
/**
|
|
1127
|
-
* Gets an array of the pinned to the right
|
|
1128
|
-
*
|
|
1129
|
-
* @example
|
|
1130
|
-
* ```typescript
|
|
1131
|
-
* const pinnedColumns = this.grid.pinnedEndColumns.
|
|
1132
|
-
* ```
|
|
778
|
+
* Gets an array of the pinned to the right columns.
|
|
1133
779
|
*/
|
|
1134
780
|
public get pinnedEndColumns(): IgcColumnComponent[];
|
|
1135
781
|
|
|
@@ -1137,36 +783,21 @@ public set selectedRows(value: any[]);
|
|
|
1137
783
|
|
|
1138
784
|
/* csSuppress */
|
|
1139
785
|
/**
|
|
1140
|
-
* Gets an array of the pinned
|
|
1141
|
-
*
|
|
1142
|
-
* @example
|
|
1143
|
-
* ```typescript
|
|
1144
|
-
* const pinnedRow = this.grid.pinnedRows;
|
|
1145
|
-
* ```
|
|
786
|
+
* Gets an array of the pinned rows.
|
|
1146
787
|
*/
|
|
1147
788
|
public get pinnedRows(): IgcGridRowComponent[];
|
|
1148
789
|
|
|
1149
790
|
|
|
1150
791
|
|
|
1151
792
|
/**
|
|
1152
|
-
* Gets an array of unpinned
|
|
1153
|
-
*
|
|
1154
|
-
* @example
|
|
1155
|
-
* ```typescript
|
|
1156
|
-
* const unpinnedColumns = this.grid.unpinnedColumns.
|
|
1157
|
-
* ```
|
|
793
|
+
* Gets an array of unpinned columns.
|
|
1158
794
|
*/
|
|
1159
795
|
public get unpinnedColumns(): IgcColumnComponent[];
|
|
1160
796
|
|
|
1161
797
|
|
|
1162
798
|
|
|
1163
799
|
/**
|
|
1164
|
-
* Returns an array of visible
|
|
1165
|
-
*
|
|
1166
|
-
* @example
|
|
1167
|
-
* ```typescript
|
|
1168
|
-
* const visibleColumns = this.grid.visibleColumns.
|
|
1169
|
-
* ```
|
|
800
|
+
* Returns an array of visible columns.
|
|
1170
801
|
*/
|
|
1171
802
|
public get visibleColumns(): IgcColumnComponent[];
|
|
1172
803
|
|
|
@@ -1174,13 +805,6 @@ public set selectedRows(value: any[]);
|
|
|
1174
805
|
|
|
1175
806
|
/**
|
|
1176
807
|
* Returns the total number of records.
|
|
1177
|
-
*
|
|
1178
|
-
* @remarks
|
|
1179
|
-
* Only functions when paging is enabled.
|
|
1180
|
-
* @example
|
|
1181
|
-
* ```typescript
|
|
1182
|
-
* const totalRecords = this.grid.totalRecords;
|
|
1183
|
-
* ```
|
|
1184
808
|
*/
|
|
1185
809
|
public set totalRecords(value: number);
|
|
1186
810
|
public get totalRecords(): number;
|
|
@@ -1189,11 +813,6 @@ public set selectedRows(value: any[]);
|
|
|
1189
813
|
|
|
1190
814
|
/**
|
|
1191
815
|
* Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.
|
|
1192
|
-
*
|
|
1193
|
-
* @example
|
|
1194
|
-
* ```typescript
|
|
1195
|
-
* const dataView = this.grid.dataView;
|
|
1196
|
-
* ```
|
|
1197
816
|
*/
|
|
1198
817
|
public get dataView(): any[];
|
|
1199
818
|
|
|
@@ -1201,9 +820,6 @@ public set selectedRows(value: any[]);
|
|
|
1201
820
|
|
|
1202
821
|
/**
|
|
1203
822
|
* Gets/Sets whether clicking over a row should select/deselect it
|
|
1204
|
-
*
|
|
1205
|
-
* @remarks
|
|
1206
|
-
* By default it is set to true
|
|
1207
823
|
* @param enabled: boolean
|
|
1208
824
|
*/
|
|
1209
825
|
public set selectRowOnClick(value: boolean);
|
|
@@ -1213,7 +829,6 @@ public set selectedRows(value: any[]);
|
|
|
1213
829
|
|
|
1214
830
|
/**
|
|
1215
831
|
* Returns whether the record is pinned or not.
|
|
1216
|
-
*
|
|
1217
832
|
* @param rowIndex Index of the record in the `filteredSortedData` collection.
|
|
1218
833
|
*/
|
|
1219
834
|
public isRecordPinnedByIndex(rowIndex: number): void;
|
|
@@ -1222,14 +837,6 @@ public set selectedRows(value: any[]);
|
|
|
1222
837
|
|
|
1223
838
|
/**
|
|
1224
839
|
* Toggles the specified column's visibility.
|
|
1225
|
-
*
|
|
1226
|
-
* @example
|
|
1227
|
-
* ```typescript
|
|
1228
|
-
* this.grid1.toggleColumnVisibility({
|
|
1229
|
-
* column: this.grid1.columns[0],
|
|
1230
|
-
* newValue: true
|
|
1231
|
-
* });
|
|
1232
|
-
* ```
|
|
1233
840
|
*/
|
|
1234
841
|
public toggleColumnVisibility(args: IgcColumnVisibilityChangedEventArgs): void;
|
|
1235
842
|
|
|
@@ -1237,11 +844,6 @@ public set selectedRows(value: any[]);
|
|
|
1237
844
|
|
|
1238
845
|
/**
|
|
1239
846
|
* Expands all rows.
|
|
1240
|
-
*
|
|
1241
|
-
* @example
|
|
1242
|
-
* ```typescript
|
|
1243
|
-
* this.grid.expandAll();
|
|
1244
|
-
* ```
|
|
1245
847
|
*/
|
|
1246
848
|
public expandAll(): void;
|
|
1247
849
|
|
|
@@ -1249,11 +851,6 @@ public set selectedRows(value: any[]);
|
|
|
1249
851
|
|
|
1250
852
|
/**
|
|
1251
853
|
* Collapses all rows.
|
|
1252
|
-
*
|
|
1253
|
-
* @example
|
|
1254
|
-
* ```typescript
|
|
1255
|
-
* this.grid.collapseAll();
|
|
1256
|
-
* ```
|
|
1257
854
|
*/
|
|
1258
855
|
public collapseAll(): void;
|
|
1259
856
|
|
|
@@ -1261,13 +858,6 @@ public set selectedRows(value: any[]);
|
|
|
1261
858
|
|
|
1262
859
|
/**
|
|
1263
860
|
* Expands the row by its id.
|
|
1264
|
-
*
|
|
1265
|
-
* @remarks
|
|
1266
|
-
* ID is either the primaryKey value or the data record instance.
|
|
1267
|
-
* @example
|
|
1268
|
-
* ```typescript
|
|
1269
|
-
* this.grid.expandRow(rowID);
|
|
1270
|
-
* ```
|
|
1271
861
|
* @param rowID The row id - primaryKey value or the data record instance.
|
|
1272
862
|
*/
|
|
1273
863
|
public expandRow(rowID: any): void;
|
|
@@ -1276,13 +866,6 @@ public set selectedRows(value: any[]);
|
|
|
1276
866
|
|
|
1277
867
|
/**
|
|
1278
868
|
* Collapses the row by its id.
|
|
1279
|
-
*
|
|
1280
|
-
* @remarks
|
|
1281
|
-
* ID is either the primaryKey value or the data record instance.
|
|
1282
|
-
* @example
|
|
1283
|
-
* ```typescript
|
|
1284
|
-
* this.grid.collapseRow(rowID);
|
|
1285
|
-
* ```
|
|
1286
869
|
* @param rowID The row id - primaryKey value or the data record instance.
|
|
1287
870
|
*/
|
|
1288
871
|
public collapseRow(rowID: any): void;
|
|
@@ -1292,13 +875,6 @@ public set selectedRows(value: any[]);
|
|
|
1292
875
|
|
|
1293
876
|
/**
|
|
1294
877
|
* Toggles the row by its id.
|
|
1295
|
-
*
|
|
1296
|
-
* @remarks
|
|
1297
|
-
* ID is either the primaryKey value or the data record instance.
|
|
1298
|
-
* @example
|
|
1299
|
-
* ```typescript
|
|
1300
|
-
* this.grid.toggleRow(rowID);
|
|
1301
|
-
* ```
|
|
1302
878
|
* @param rowID The row id - primaryKey value or the data record instance.
|
|
1303
879
|
*/
|
|
1304
880
|
public toggleRow(rowID: any): void;
|
|
@@ -1306,19 +882,14 @@ public set selectedRows(value: any[]);
|
|
|
1306
882
|
|
|
1307
883
|
|
|
1308
884
|
/**
|
|
1309
|
-
* Gets the `width` to be set on
|
|
885
|
+
* Gets the `width` to be set on grid header group.
|
|
1310
886
|
*/
|
|
1311
887
|
public getHeaderGroupWidth(column: IgcColumnComponent): string;
|
|
1312
888
|
|
|
1313
889
|
|
|
1314
890
|
|
|
1315
891
|
/**
|
|
1316
|
-
* Returns the
|
|
1317
|
-
*
|
|
1318
|
-
* @example
|
|
1319
|
-
* ```typescript
|
|
1320
|
-
* const myCol = this.grid1.getColumnByName("ID");
|
|
1321
|
-
* ```
|
|
892
|
+
* Returns the column by field name.
|
|
1322
893
|
* @param name
|
|
1323
894
|
*/
|
|
1324
895
|
public getColumnByName(name: string): IgcColumnComponent;
|
|
@@ -1331,11 +902,6 @@ public set selectedRows(value: any[]);
|
|
|
1331
902
|
|
|
1332
903
|
/**
|
|
1333
904
|
* Recalculates all widths of columns that have size set to `auto`.
|
|
1334
|
-
*
|
|
1335
|
-
* @example
|
|
1336
|
-
* ```typescript
|
|
1337
|
-
* this.grid1.recalculateAutoSizes();
|
|
1338
|
-
* ```
|
|
1339
905
|
*/
|
|
1340
906
|
public recalculateAutoSizes(): void;
|
|
1341
907
|
|
|
@@ -1343,41 +909,15 @@ public set selectedRows(value: any[]);
|
|
|
1343
909
|
|
|
1344
910
|
/**
|
|
1345
911
|
* Places a column before or after the specified target column.
|
|
1346
|
-
*
|
|
1347
|
-
* @example
|
|
1348
|
-
* ```typescript
|
|
1349
|
-
* grid.moveColumn(column, target);
|
|
1350
|
-
* ```
|
|
1351
912
|
*/
|
|
1352
913
|
public moveColumn(column: IgcColumnComponent, target: IgcColumnComponent, pos?: DropPosition): void;
|
|
1353
914
|
|
|
1354
915
|
|
|
1355
916
|
|
|
1356
917
|
/**
|
|
1357
|
-
* Triggers change detection for the
|
|
918
|
+
* Triggers change detection for the grid.
|
|
1358
919
|
* Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed.
|
|
1359
920
|
* May degrade performance if used when not needed, or if misused:
|
|
1360
|
-
* ```typescript
|
|
1361
|
-
* // DON'Ts:
|
|
1362
|
-
* // don't call markForCheck from inside a loop
|
|
1363
|
-
* // don't call markForCheck when a primitive has changed
|
|
1364
|
-
* grid.data.forEach(rec => {
|
|
1365
|
-
* rec = newValue;
|
|
1366
|
-
* grid.markForCheck();
|
|
1367
|
-
* });
|
|
1368
|
-
*
|
|
1369
|
-
* // DOs
|
|
1370
|
-
* // call markForCheck after updating a nested property
|
|
1371
|
-
* grid.data.forEach(rec => {
|
|
1372
|
-
* rec.nestedProp1.nestedProp2 = newValue;
|
|
1373
|
-
* });
|
|
1374
|
-
* grid.markForCheck();
|
|
1375
|
-
* ```
|
|
1376
|
-
*
|
|
1377
|
-
* @example
|
|
1378
|
-
* ```typescript
|
|
1379
|
-
* grid.markForCheck();
|
|
1380
|
-
* ```
|
|
1381
921
|
*/
|
|
1382
922
|
public markForCheck(): void;
|
|
1383
923
|
|
|
@@ -1385,12 +925,7 @@ public set selectedRows(value: any[]);
|
|
|
1385
925
|
|
|
1386
926
|
/* csSuppress */
|
|
1387
927
|
/**
|
|
1388
|
-
* Creates a new
|
|
1389
|
-
*
|
|
1390
|
-
* @example
|
|
1391
|
-
* ```typescript
|
|
1392
|
-
* this.grid1.addRow(record);
|
|
1393
|
-
* ```
|
|
928
|
+
* Creates a new grid row and adds the data record to the end of the data source.
|
|
1394
929
|
* @param data
|
|
1395
930
|
*/
|
|
1396
931
|
public addRow(data: any): void;
|
|
@@ -1399,15 +934,7 @@ public set selectedRows(value: any[]);
|
|
|
1399
934
|
|
|
1400
935
|
/* blazorCSSuppress */
|
|
1401
936
|
/**
|
|
1402
|
-
* Removes the
|
|
1403
|
-
*
|
|
1404
|
-
* @remarks
|
|
1405
|
-
* Requires that the `primaryKey` property is set.
|
|
1406
|
-
* The method accept rowSelector as a parameter, which is the rowID.
|
|
1407
|
-
* @example
|
|
1408
|
-
* ```typescript
|
|
1409
|
-
* this.grid1.deleteRow(0);
|
|
1410
|
-
* ```
|
|
937
|
+
* Removes the grid row and the corresponding data record by primary key.
|
|
1411
938
|
* @param rowSelector
|
|
1412
939
|
*/
|
|
1413
940
|
public deleteRow(rowSelector: any): any;
|
|
@@ -1416,14 +943,7 @@ public set selectedRows(value: any[]);
|
|
|
1416
943
|
|
|
1417
944
|
/* blazorCSSuppress */
|
|
1418
945
|
/**
|
|
1419
|
-
* Updates the
|
|
1420
|
-
*
|
|
1421
|
-
* @remarks
|
|
1422
|
-
* Requires that the `primaryKey` property is set.
|
|
1423
|
-
* @example
|
|
1424
|
-
* ```typescript
|
|
1425
|
-
* this.gridWithPK.updateCell('Updated', 1, 'ProductName');
|
|
1426
|
-
* ```
|
|
946
|
+
* Updates the grid row and the corresponding data record by primary key.
|
|
1427
947
|
* @param value the new value which is to be set.
|
|
1428
948
|
* @param rowSelector corresponds to rowID.
|
|
1429
949
|
* @param column corresponds to column field.
|
|
@@ -1434,18 +954,7 @@ public set selectedRows(value: any[]);
|
|
|
1434
954
|
|
|
1435
955
|
/* blazorCSSuppress */
|
|
1436
956
|
/**
|
|
1437
|
-
* Updates the
|
|
1438
|
-
*
|
|
1439
|
-
* @remarks
|
|
1440
|
-
* The row is specified by
|
|
1441
|
-
* rowSelector parameter and the data source record with the passed value.
|
|
1442
|
-
* This method will apply requested update only if primary key is specified in the grid.
|
|
1443
|
-
* @example
|
|
1444
|
-
* ```typescript
|
|
1445
|
-
* grid.updateRow({
|
|
1446
|
-
* ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
|
|
1447
|
-
* }, 1);
|
|
1448
|
-
* ```
|
|
957
|
+
* Updates the grid row
|
|
1449
958
|
* @param value–
|
|
1450
959
|
* @param rowSelector correspond to rowID
|
|
1451
960
|
*/
|
|
@@ -1456,13 +965,6 @@ public set selectedRows(value: any[]);
|
|
|
1456
965
|
|
|
1457
966
|
/**
|
|
1458
967
|
* Returns the data that is contained in the row component.
|
|
1459
|
-
*
|
|
1460
|
-
* @remarks
|
|
1461
|
-
* If the primary key is not specified the row selector match the row data.
|
|
1462
|
-
* @example
|
|
1463
|
-
* ```typescript
|
|
1464
|
-
* const data = grid.getRowData(94741);
|
|
1465
|
-
* ```
|
|
1466
968
|
* @param rowSelector correspond to rowID
|
|
1467
969
|
*/
|
|
1468
970
|
public getRowData(rowSelector: any): any;
|
|
@@ -1470,28 +972,14 @@ public set selectedRows(value: any[]);
|
|
|
1470
972
|
|
|
1471
973
|
|
|
1472
974
|
/**
|
|
1473
|
-
* Sort a single
|
|
1474
|
-
*
|
|
1475
|
-
* @remarks
|
|
1476
|
-
* Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.
|
|
1477
|
-
* @example
|
|
1478
|
-
* ```typescript
|
|
1479
|
-
* this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
|
|
1480
|
-
* ```
|
|
975
|
+
* Sort a single column.
|
|
1481
976
|
*/
|
|
1482
977
|
public sort(expression: IgcSortingExpression[]): void;
|
|
1483
978
|
|
|
1484
979
|
|
|
1485
980
|
|
|
1486
981
|
/**
|
|
1487
|
-
* Filters a single
|
|
1488
|
-
*
|
|
1489
|
-
* @example
|
|
1490
|
-
* ```typescript
|
|
1491
|
-
* public filter(term) {
|
|
1492
|
-
* this.grid.filter("ProductName", term, IgxStringFilteringOperand.instance().condition("contains"));
|
|
1493
|
-
* }
|
|
1494
|
-
* ```
|
|
982
|
+
* Filters a single column.
|
|
1495
983
|
* @param name
|
|
1496
984
|
* @param value
|
|
1497
985
|
* @param conditionOrExpressionTree
|
|
@@ -1502,12 +990,7 @@ public set selectedRows(value: any[]);
|
|
|
1502
990
|
|
|
1503
991
|
|
|
1504
992
|
/**
|
|
1505
|
-
* Filters all the
|
|
1506
|
-
*
|
|
1507
|
-
* @example
|
|
1508
|
-
* ```typescript
|
|
1509
|
-
* grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));
|
|
1510
|
-
* ```
|
|
993
|
+
* Filters all the column in the grid with the same condition.
|
|
1511
994
|
* @param value
|
|
1512
995
|
* @param condition
|
|
1513
996
|
* @param ignoreCase
|
|
@@ -1519,18 +1002,6 @@ public set selectedRows(value: any[]);
|
|
|
1519
1002
|
|
|
1520
1003
|
/**
|
|
1521
1004
|
* Enables summaries for the specified column and applies your customSummary.
|
|
1522
|
-
*
|
|
1523
|
-
* @remarks
|
|
1524
|
-
* If you do not provide the customSummary, then the default summary for the column data type will be applied.
|
|
1525
|
-
* @example
|
|
1526
|
-
* ```typescript
|
|
1527
|
-
* grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);
|
|
1528
|
-
* ```
|
|
1529
|
-
* Enable summaries for the listed columns.
|
|
1530
|
-
* @example
|
|
1531
|
-
* ```typescript
|
|
1532
|
-
* grid.enableSummaries('ProductName');
|
|
1533
|
-
* ```
|
|
1534
1005
|
* @param rest
|
|
1535
1006
|
*/
|
|
1536
1007
|
public enableSummaries(rest: any[]): void;
|
|
@@ -1539,31 +1010,13 @@ public set selectedRows(value: any[]);
|
|
|
1539
1010
|
|
|
1540
1011
|
/**
|
|
1541
1012
|
* Disable summaries for the specified column.
|
|
1542
|
-
*
|
|
1543
|
-
* @example
|
|
1544
|
-
* ```typescript
|
|
1545
|
-
* grid.disableSummaries('ProductName');
|
|
1546
|
-
* ```
|
|
1547
|
-
* @remarks
|
|
1548
|
-
* Disable summaries for the listed columns.
|
|
1549
|
-
* @example
|
|
1550
|
-
* ```typescript
|
|
1551
|
-
* grid.disableSummaries([{ fieldName: 'ProductName' }]);
|
|
1552
|
-
* ```
|
|
1553
1013
|
*/
|
|
1554
1014
|
public disableSummaries(rest: any[]): void;
|
|
1555
1015
|
|
|
1556
1016
|
|
|
1557
1017
|
|
|
1558
1018
|
/**
|
|
1559
|
-
* If name is provided, clears the filtering state of the corresponding
|
|
1560
|
-
*
|
|
1561
|
-
* @remarks
|
|
1562
|
-
* Otherwise clears the filtering state of all `IgxColumnComponent`s.
|
|
1563
|
-
* @example
|
|
1564
|
-
* ```typescript
|
|
1565
|
-
* this.grid.clearFilter();
|
|
1566
|
-
* ```
|
|
1019
|
+
* If name is provided, clears the filtering state of the corresponding column.
|
|
1567
1020
|
* @param name
|
|
1568
1021
|
*/
|
|
1569
1022
|
public clearFilter(name?: string): void;
|
|
@@ -1571,14 +1024,7 @@ public set selectedRows(value: any[]);
|
|
|
1571
1024
|
|
|
1572
1025
|
|
|
1573
1026
|
/**
|
|
1574
|
-
* If name is provided, clears the sorting state of the corresponding
|
|
1575
|
-
*
|
|
1576
|
-
* @remarks
|
|
1577
|
-
* otherwise clears the sorting state of all `IgxColumnComponent`.
|
|
1578
|
-
* @example
|
|
1579
|
-
* ```typescript
|
|
1580
|
-
* this.grid.clearSort();
|
|
1581
|
-
* ```
|
|
1027
|
+
* If name is provided, clears the sorting state of the corresponding column.
|
|
1582
1028
|
* @param name
|
|
1583
1029
|
*/
|
|
1584
1030
|
public clearSort(name?: string): void;
|
|
@@ -1589,13 +1035,6 @@ public set selectedRows(value: any[]);
|
|
|
1589
1035
|
|
|
1590
1036
|
/**
|
|
1591
1037
|
* Pins a column by field name.
|
|
1592
|
-
*
|
|
1593
|
-
* @remarks
|
|
1594
|
-
* Returns whether the operation is successful.
|
|
1595
|
-
* @example
|
|
1596
|
-
* ```typescript
|
|
1597
|
-
* this.grid.pinColumn("ID");
|
|
1598
|
-
* ```
|
|
1599
1038
|
* @param columnName
|
|
1600
1039
|
* @param index
|
|
1601
1040
|
* @param pinningPosition
|
|
@@ -1606,11 +1045,6 @@ public set selectedRows(value: any[]);
|
|
|
1606
1045
|
|
|
1607
1046
|
/**
|
|
1608
1047
|
* Unpins a column by field name. Returns whether the operation is successful.
|
|
1609
|
-
*
|
|
1610
|
-
* @example
|
|
1611
|
-
* ```typescript
|
|
1612
|
-
* this.grid.pinColumn("ID");
|
|
1613
|
-
* ```
|
|
1614
1048
|
* @param columnName
|
|
1615
1049
|
* @param index
|
|
1616
1050
|
*/
|
|
@@ -1621,13 +1055,6 @@ public set selectedRows(value: any[]);
|
|
|
1621
1055
|
/* csSuppress */
|
|
1622
1056
|
/**
|
|
1623
1057
|
* Pin the row by its id.
|
|
1624
|
-
*
|
|
1625
|
-
* @remarks
|
|
1626
|
-
* ID is either the primaryKey value or the data record instance.
|
|
1627
|
-
* @example
|
|
1628
|
-
* ```typescript
|
|
1629
|
-
* this.grid.pinRow(rowID);
|
|
1630
|
-
* ```
|
|
1631
1058
|
* @param rowID The row id - primaryKey value or the data record instance.
|
|
1632
1059
|
* @param index The index at which to insert the row in the pinned collection.
|
|
1633
1060
|
*/
|
|
@@ -1638,13 +1065,6 @@ public set selectedRows(value: any[]);
|
|
|
1638
1065
|
/* csSuppress */
|
|
1639
1066
|
/**
|
|
1640
1067
|
* Unpin the row by its id.
|
|
1641
|
-
*
|
|
1642
|
-
* @remarks
|
|
1643
|
-
* ID is either the primaryKey value or the data record instance.
|
|
1644
|
-
* @example
|
|
1645
|
-
* ```typescript
|
|
1646
|
-
* this.grid.unpinRow(rowID);
|
|
1647
|
-
* ```
|
|
1648
1068
|
* @param rowID The row id - primaryKey value or the data record instance.
|
|
1649
1069
|
*/
|
|
1650
1070
|
public unpinRow(rowID: any, row?: IgcRowType): boolean;
|
|
@@ -1653,13 +1073,6 @@ public set selectedRows(value: any[]);
|
|
|
1653
1073
|
|
|
1654
1074
|
/**
|
|
1655
1075
|
* Recalculates grid width/height dimensions.
|
|
1656
|
-
*
|
|
1657
|
-
* @remarks
|
|
1658
|
-
* Should be run when changing DOM elements dimentions manually that affect the grid's size.
|
|
1659
|
-
* @example
|
|
1660
|
-
* ```typescript
|
|
1661
|
-
* this.grid.reflow();
|
|
1662
|
-
* ```
|
|
1663
1076
|
*/
|
|
1664
1077
|
public reflow(): void;
|
|
1665
1078
|
|
|
@@ -1667,13 +1080,6 @@ public set selectedRows(value: any[]);
|
|
|
1667
1080
|
|
|
1668
1081
|
/**
|
|
1669
1082
|
* Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
|
|
1670
|
-
*
|
|
1671
|
-
* @remarks
|
|
1672
|
-
* Returns how many times the grid contains the string.
|
|
1673
|
-
* @example
|
|
1674
|
-
* ```typescript
|
|
1675
|
-
* this.grid.findNext("financial");
|
|
1676
|
-
* ```
|
|
1677
1083
|
* @param text the string to search.
|
|
1678
1084
|
* @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
|
|
1679
1085
|
* @param exactMatch optionally, if the text should match the entire value (defaults to false).
|
|
@@ -1684,13 +1090,6 @@ public set selectedRows(value: any[]);
|
|
|
1684
1090
|
|
|
1685
1091
|
/**
|
|
1686
1092
|
* Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
|
|
1687
|
-
*
|
|
1688
|
-
* @remarks
|
|
1689
|
-
* Returns how many times the grid contains the string.
|
|
1690
|
-
* @example
|
|
1691
|
-
* ```typescript
|
|
1692
|
-
* this.grid.findPrev("financial");
|
|
1693
|
-
* ```
|
|
1694
1093
|
* @param text the string to search.
|
|
1695
1094
|
* @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
|
|
1696
1095
|
* @param exactMatch optionally, if the text should match the entire value (defaults to false).
|
|
@@ -1701,13 +1100,6 @@ public set selectedRows(value: any[]);
|
|
|
1701
1100
|
|
|
1702
1101
|
/**
|
|
1703
1102
|
* Reapplies the existing search.
|
|
1704
|
-
*
|
|
1705
|
-
* @remarks
|
|
1706
|
-
* Returns how many times the grid contains the last search.
|
|
1707
|
-
* @example
|
|
1708
|
-
* ```typescript
|
|
1709
|
-
* this.grid.refreshSearch();
|
|
1710
|
-
* ```
|
|
1711
1103
|
* @param updateActiveInfo
|
|
1712
1104
|
*/
|
|
1713
1105
|
public refreshSearch(updateActiveInfo?: boolean, endEdit?: boolean): number;
|
|
@@ -1716,11 +1108,6 @@ public set selectedRows(value: any[]);
|
|
|
1716
1108
|
|
|
1717
1109
|
/**
|
|
1718
1110
|
* Removes all the highlights in the cell.
|
|
1719
|
-
*
|
|
1720
|
-
* @example
|
|
1721
|
-
* ```typescript
|
|
1722
|
-
* this.grid.clearSearch();
|
|
1723
|
-
* ```
|
|
1724
1111
|
*/
|
|
1725
1112
|
public clearSearch(): void;
|
|
1726
1113
|
|
|
@@ -1728,11 +1115,6 @@ public set selectedRows(value: any[]);
|
|
|
1728
1115
|
|
|
1729
1116
|
/**
|
|
1730
1117
|
* Gets calculated width of the pinned areas.
|
|
1731
|
-
*
|
|
1732
|
-
* @example
|
|
1733
|
-
* ```typescript
|
|
1734
|
-
* const pinnedWidth = this.grid.getPinnedStartWidth();
|
|
1735
|
-
* ```
|
|
1736
1118
|
* @param takeHidden If we should take into account the hidden columns in the pinned area.
|
|
1737
1119
|
*/
|
|
1738
1120
|
public getPinnedStartWidth(takeHidden?: boolean): void;
|
|
@@ -1741,11 +1123,6 @@ public set selectedRows(value: any[]);
|
|
|
1741
1123
|
|
|
1742
1124
|
/**
|
|
1743
1125
|
* Gets calculated width of the pinned areas.
|
|
1744
|
-
*
|
|
1745
|
-
* @example
|
|
1746
|
-
* ```typescript
|
|
1747
|
-
* const pinnedWidth = this.grid.getPinnedEndWidth();
|
|
1748
|
-
* ```
|
|
1749
1126
|
* @param takeHidden If we should take into account the hidden columns in the pinned area.
|
|
1750
1127
|
*/
|
|
1751
1128
|
public getPinnedEndWidth(takeHidden?: boolean): void;
|
|
@@ -1754,11 +1131,6 @@ public set selectedRows(value: any[]);
|
|
|
1754
1131
|
|
|
1755
1132
|
/**
|
|
1756
1133
|
* Select specified rows by ID.
|
|
1757
|
-
*
|
|
1758
|
-
* @example
|
|
1759
|
-
* ```typescript
|
|
1760
|
-
* this.grid.selectRows([1,2,5], true);
|
|
1761
|
-
* ```
|
|
1762
1134
|
* @param rowIDs
|
|
1763
1135
|
* @param clearCurrentSelection if true clears the current selection
|
|
1764
1136
|
*/
|
|
@@ -1768,11 +1140,6 @@ public set selectedRows(value: any[]);
|
|
|
1768
1140
|
|
|
1769
1141
|
/**
|
|
1770
1142
|
* Deselect specified rows by ID.
|
|
1771
|
-
*
|
|
1772
|
-
* @example
|
|
1773
|
-
* ```typescript
|
|
1774
|
-
* this.grid.deselectRows([1,2,5]);
|
|
1775
|
-
* ```
|
|
1776
1143
|
* @param rowIDs
|
|
1777
1144
|
*/
|
|
1778
1145
|
public deselectRows(rowIDs: any[]): void;
|
|
@@ -1781,15 +1148,6 @@ public set selectedRows(value: any[]);
|
|
|
1781
1148
|
|
|
1782
1149
|
/**
|
|
1783
1150
|
* Selects all rows
|
|
1784
|
-
*
|
|
1785
|
-
* @remarks
|
|
1786
|
-
* By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
|
|
1787
|
-
* If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.
|
|
1788
|
-
* @example
|
|
1789
|
-
* ```typescript
|
|
1790
|
-
* this.grid.selectAllRows();
|
|
1791
|
-
* this.grid.selectAllRows(false);
|
|
1792
|
-
* ```
|
|
1793
1151
|
* @param onlyFilterData
|
|
1794
1152
|
*/
|
|
1795
1153
|
public selectAllRows(onlyFilterData?: boolean): void;
|
|
@@ -1798,14 +1156,6 @@ public set selectedRows(value: any[]);
|
|
|
1798
1156
|
|
|
1799
1157
|
/**
|
|
1800
1158
|
* Deselects all rows
|
|
1801
|
-
*
|
|
1802
|
-
* @remarks
|
|
1803
|
-
* By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
|
|
1804
|
-
* If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows.
|
|
1805
|
-
* @example
|
|
1806
|
-
* ```typescript
|
|
1807
|
-
* this.grid.deselectAllRows();
|
|
1808
|
-
* ```
|
|
1809
1159
|
* @param onlyFilterData
|
|
1810
1160
|
*/
|
|
1811
1161
|
public deselectAllRows(onlyFilterData?: boolean): void;
|
|
@@ -1814,10 +1164,6 @@ public set selectedRows(value: any[]);
|
|
|
1814
1164
|
|
|
1815
1165
|
/**
|
|
1816
1166
|
* Deselect selected cells.
|
|
1817
|
-
* @example
|
|
1818
|
-
* ```typescript
|
|
1819
|
-
* this.grid.clearCellSelection();
|
|
1820
|
-
* ```
|
|
1821
1167
|
*/
|
|
1822
1168
|
public clearCellSelection(): void;
|
|
1823
1169
|
|
|
@@ -1838,12 +1184,7 @@ public set selectedRows(value: any[]);
|
|
|
1838
1184
|
|
|
1839
1185
|
|
|
1840
1186
|
/**
|
|
1841
|
-
*
|
|
1842
1187
|
* Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.
|
|
1843
|
-
*
|
|
1844
|
-
* @remarks
|
|
1845
|
-
* If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
|
|
1846
|
-
* If `headers` is enabled, it will use the column header (if any) instead of the column field.
|
|
1847
1188
|
*/
|
|
1848
1189
|
public getSelectedData(formatters?: boolean, headers?: boolean): void;
|
|
1849
1190
|
|
|
@@ -1851,12 +1192,6 @@ public set selectedRows(value: any[]);
|
|
|
1851
1192
|
|
|
1852
1193
|
/**
|
|
1853
1194
|
* Get current selected columns.
|
|
1854
|
-
*
|
|
1855
|
-
* @example
|
|
1856
|
-
* Returns an array with selected columns
|
|
1857
|
-
* ```typescript
|
|
1858
|
-
* const selectedColumns = this.grid.selectedColumns();
|
|
1859
|
-
* ```
|
|
1860
1195
|
*/
|
|
1861
1196
|
public selectedColumns(): IgcColumnComponent[];
|
|
1862
1197
|
|
|
@@ -1864,11 +1199,6 @@ public set selectedRows(value: any[]);
|
|
|
1864
1199
|
|
|
1865
1200
|
/**
|
|
1866
1201
|
* Select specified columns.
|
|
1867
|
-
*
|
|
1868
|
-
* @example
|
|
1869
|
-
* ```typescript
|
|
1870
|
-
* this.grid.selectColumns(['ID','Name'], true);
|
|
1871
|
-
* ```
|
|
1872
1202
|
* @param columns
|
|
1873
1203
|
* @param clearCurrentSelection if true clears the current selection
|
|
1874
1204
|
*/
|
|
@@ -1878,11 +1208,6 @@ public set selectedRows(value: any[]);
|
|
|
1878
1208
|
|
|
1879
1209
|
/**
|
|
1880
1210
|
* Deselect specified columns by field.
|
|
1881
|
-
*
|
|
1882
|
-
* @example
|
|
1883
|
-
* ```typescript
|
|
1884
|
-
* this.grid.deselectColumns(['ID','Name']);
|
|
1885
|
-
* ```
|
|
1886
1211
|
* @param columns
|
|
1887
1212
|
*/
|
|
1888
1213
|
public deselectColumns(columns: string[] | IgcColumnComponent[]): void;
|
|
@@ -1891,11 +1216,6 @@ public set selectedRows(value: any[]);
|
|
|
1891
1216
|
|
|
1892
1217
|
/**
|
|
1893
1218
|
* Deselects all columns
|
|
1894
|
-
*
|
|
1895
|
-
* @example
|
|
1896
|
-
* ```typescript
|
|
1897
|
-
* this.grid.deselectAllColumns();
|
|
1898
|
-
* ```
|
|
1899
1219
|
*/
|
|
1900
1220
|
public deselectAllColumns(): void;
|
|
1901
1221
|
|
|
@@ -1903,23 +1223,13 @@ public set selectedRows(value: any[]);
|
|
|
1903
1223
|
|
|
1904
1224
|
/**
|
|
1905
1225
|
* Selects all columns
|
|
1906
|
-
*
|
|
1907
|
-
* @example
|
|
1908
|
-
* ```typescript
|
|
1909
|
-
* this.grid.deselectAllColumns();
|
|
1910
|
-
* ```
|
|
1911
1226
|
*/
|
|
1912
1227
|
public selectAllColumns(): void;
|
|
1913
1228
|
|
|
1914
1229
|
|
|
1915
1230
|
|
|
1916
1231
|
/**
|
|
1917
|
-
*
|
|
1918
1232
|
* Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.
|
|
1919
|
-
*
|
|
1920
|
-
* @remarks
|
|
1921
|
-
* If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
|
|
1922
|
-
* If `headers` is enabled, it will use the column header (if any) instead of the column field.
|
|
1923
1233
|
*/
|
|
1924
1234
|
public getSelectedColumnsData(formatters?: boolean, headers?: boolean): void;
|
|
1925
1235
|
|
|
@@ -1928,14 +1238,6 @@ public set selectedRows(value: any[]);
|
|
|
1928
1238
|
/* blazorCsSuppress */
|
|
1929
1239
|
/**
|
|
1930
1240
|
* Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.
|
|
1931
|
-
*
|
|
1932
|
-
* @remarks
|
|
1933
|
-
* Also can execute a custom logic over the target element,
|
|
1934
|
-
* through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }
|
|
1935
|
-
* @example
|
|
1936
|
-
* ```typescript
|
|
1937
|
-
* this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });
|
|
1938
|
-
* ```
|
|
1939
1241
|
*/
|
|
1940
1242
|
public navigateTo(rowIndex: number, visibleColIndex?: number, cb?: any): void;
|
|
1941
1243
|
|
|
@@ -1945,14 +1247,6 @@ public set selectedRows(value: any[]);
|
|
|
1945
1247
|
/**
|
|
1946
1248
|
* Returns `ICellPosition` which defines the next cell,
|
|
1947
1249
|
* according to the current position, that match specific criteria.
|
|
1948
|
-
*
|
|
1949
|
-
* @remarks
|
|
1950
|
-
* You can pass callback function as a third parameter of `getPreviousCell` method.
|
|
1951
|
-
* The callback function accepts IgxColumnComponent as a param
|
|
1952
|
-
* @example
|
|
1953
|
-
* ```typescript
|
|
1954
|
-
* const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
|
|
1955
|
-
* ```
|
|
1956
1250
|
*/
|
|
1957
1251
|
public getNextCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
|
|
1958
1252
|
|
|
@@ -1962,14 +1256,6 @@ public set selectedRows(value: any[]);
|
|
|
1962
1256
|
/**
|
|
1963
1257
|
* Returns `ICellPosition` which defines the previous cell,
|
|
1964
1258
|
* according to the current position, that match specific criteria.
|
|
1965
|
-
*
|
|
1966
|
-
* @remarks
|
|
1967
|
-
* You can pass callback function as a third parameter of `getPreviousCell` method.
|
|
1968
|
-
* The callback function accepts IgxColumnComponent as a param
|
|
1969
|
-
* @example
|
|
1970
|
-
* ```typescript
|
|
1971
|
-
* const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
|
|
1972
|
-
* ```
|
|
1973
1259
|
*/
|
|
1974
1260
|
public getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
|
|
1975
1261
|
|
|
@@ -1984,7 +1270,6 @@ public set selectedRows(value: any[]);
|
|
|
1984
1270
|
|
|
1985
1271
|
/**
|
|
1986
1272
|
* Closes the advanced filtering dialog.
|
|
1987
|
-
*
|
|
1988
1273
|
* @param applyChanges indicates whether the changes should be applied
|
|
1989
1274
|
*/
|
|
1990
1275
|
public closeAdvancedFilteringDialog(applyChanges: boolean): void;
|
|
@@ -1993,13 +1278,6 @@ public set selectedRows(value: any[]);
|
|
|
1993
1278
|
|
|
1994
1279
|
/**
|
|
1995
1280
|
* Finishes the row transactions on the current row and returns whether the grid editing was canceled.
|
|
1996
|
-
*
|
|
1997
|
-
* @remarks
|
|
1998
|
-
* If `commit === true`, passes them from the pending state to the data (or transaction service)
|
|
1999
|
-
* @example
|
|
2000
|
-
* ```html
|
|
2001
|
-
* <button type="button" igxButton (click)="grid.endEdit(true)">Commit Row</button>
|
|
2002
|
-
* ```
|
|
2003
1281
|
* @param commit
|
|
2004
1282
|
*/
|
|
2005
1283
|
// TODO: Facade for crud service refactoring. To be removed
|
|
@@ -2011,17 +1289,6 @@ public set selectedRows(value: any[]);
|
|
|
2011
1289
|
|
|
2012
1290
|
/**
|
|
2013
1291
|
* Enters add mode by spawning the UI under the specified row by rowID.
|
|
2014
|
-
*
|
|
2015
|
-
* @remarks
|
|
2016
|
-
* If null is passed as rowID, the row adding UI is spawned as the first record in the data view
|
|
2017
|
-
* @remarks
|
|
2018
|
-
* Spawning the UI to add a child for a record only works if you provide a rowID
|
|
2019
|
-
* @example
|
|
2020
|
-
* ```typescript
|
|
2021
|
-
* this.grid.beginAddRowById('ALFKI');
|
|
2022
|
-
* this.grid.beginAddRowById('ALFKI', true);
|
|
2023
|
-
* this.grid.beginAddRowById(null);
|
|
2024
|
-
* ```
|
|
2025
1292
|
* @param rowID - The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
|
|
2026
1293
|
* @param asChild - Whether the record should be added as a child. Only applicable to igxTreeGrid.
|
|
2027
1294
|
*/
|
|
@@ -2032,13 +1299,6 @@ public set selectedRows(value: any[]);
|
|
|
2032
1299
|
/* csSuppress */
|
|
2033
1300
|
/**
|
|
2034
1301
|
* Enters add mode by spawning the UI at the specified index.
|
|
2035
|
-
*
|
|
2036
|
-
* @remarks
|
|
2037
|
-
* Accepted values for index are integers from 0 to this.grid.dataView.length
|
|
2038
|
-
* @example
|
|
2039
|
-
* ```typescript
|
|
2040
|
-
* this.grid.beginAddRowByIndex(0);
|
|
2041
|
-
* ```
|
|
2042
1302
|
* @param index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
|
|
2043
1303
|
*/
|
|
2044
1304
|
public beginAddRowByIndex(index: number): void;
|
|
@@ -2049,610 +1309,257 @@ export declare interface IgcGridBaseDirectiveEventMap {
|
|
|
2049
1309
|
|
|
2050
1310
|
/**
|
|
2051
1311
|
* Emitted after filtering is performed.
|
|
2052
|
-
*
|
|
2053
|
-
* @remarks
|
|
2054
|
-
* Returns the filtering expressions tree of the column for which filtering was performed.
|
|
2055
|
-
* @example
|
|
2056
|
-
* ```html
|
|
2057
|
-
* <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
|
|
2058
|
-
* (filteringExpressionsTreeChange)="filteringExprTreeChange($event)"></igx-grid>
|
|
2059
|
-
* ```
|
|
2060
1312
|
*/
|
|
2061
1313
|
filteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
|
|
2062
1314
|
|
|
2063
1315
|
/**
|
|
2064
1316
|
* Emitted after advanced filtering is performed.
|
|
2065
|
-
*
|
|
2066
|
-
* @remarks
|
|
2067
|
-
* Returns the advanced filtering expressions tree.
|
|
2068
|
-
* @example
|
|
2069
|
-
* ```html
|
|
2070
|
-
* <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
|
|
2071
|
-
* (advancedFilteringExpressionsTreeChange)="advancedFilteringExprTreeChange($event)"></igx-grid>
|
|
2072
|
-
* ```
|
|
2073
1317
|
*/
|
|
2074
1318
|
advancedFilteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
|
|
2075
1319
|
|
|
2076
1320
|
/**
|
|
2077
1321
|
* Emitted when grid is scrolled horizontally/vertically.
|
|
2078
|
-
*
|
|
2079
|
-
* @example
|
|
2080
|
-
* ```html
|
|
2081
|
-
* <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
|
|
2082
|
-
* (gridScroll)="onScroll($event)"></igx-grid>
|
|
2083
|
-
* ```
|
|
2084
1322
|
*/
|
|
2085
1323
|
gridScroll: CustomEvent<IgcGridScrollEventArgs>;
|
|
2086
1324
|
|
|
2087
1325
|
/**
|
|
2088
1326
|
* Emitted when a cell is clicked.
|
|
2089
|
-
*
|
|
2090
|
-
* @remarks
|
|
2091
|
-
* Returns the `IgxGridCell`.
|
|
2092
|
-
* @example
|
|
2093
|
-
* ```html
|
|
2094
|
-
* <igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2095
|
-
* ```
|
|
2096
1327
|
*/
|
|
2097
1328
|
cellClick: CustomEvent<IgcGridCellEventArgs>;
|
|
2098
1329
|
|
|
2099
1330
|
/**
|
|
2100
1331
|
* Emitted when a row is clicked.
|
|
2101
|
-
*
|
|
2102
|
-
* @remarks
|
|
2103
|
-
* Returns the `IgxGridRow`.
|
|
2104
|
-
* @example
|
|
2105
|
-
* ```html
|
|
2106
|
-
* <igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2107
|
-
* ```
|
|
2108
1332
|
*/
|
|
2109
1333
|
rowClick: CustomEvent<IgcGridRowEventArgs>;
|
|
2110
1334
|
|
|
2111
1335
|
/**
|
|
2112
1336
|
* Emitted when formGroup is created on edit of row/cell.
|
|
2113
|
-
*
|
|
2114
|
-
* @example
|
|
2115
|
-
* ```html
|
|
2116
|
-
* <igx-grid #grid (formGroupCreated)="formGroupCreated($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2117
|
-
* ```
|
|
2118
1337
|
*/
|
|
2119
1338
|
formGroupCreated: CustomEvent<IgcGridFormGroupCreatedEventArgs>;
|
|
2120
1339
|
|
|
2121
1340
|
/**
|
|
2122
1341
|
* Emitted when grid's validation status changes.
|
|
2123
|
-
*
|
|
2124
|
-
* @example
|
|
2125
|
-
* ```html
|
|
2126
|
-
* <igx-grid #grid (validationStatusChange)="validationStatusChange($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2127
|
-
* ```
|
|
2128
1342
|
*/
|
|
2129
1343
|
validationStatusChange: CustomEvent<IgcGridValidationStatusEventArgs>;
|
|
2130
1344
|
|
|
2131
1345
|
/**
|
|
2132
1346
|
* Emitted when a cell is selected.
|
|
2133
|
-
*
|
|
2134
|
-
* @remarks
|
|
2135
|
-
* Returns the `IgxGridCell`.
|
|
2136
|
-
* @example
|
|
2137
|
-
* ```html
|
|
2138
|
-
* <igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2139
|
-
* ```
|
|
2140
1347
|
*/
|
|
2141
1348
|
selected: CustomEvent<IgcGridCellEventArgs>;
|
|
2142
1349
|
|
|
2143
1350
|
/**
|
|
2144
|
-
* Emitted when
|
|
2145
|
-
*
|
|
2146
|
-
* @example
|
|
2147
|
-
* ```html
|
|
2148
|
-
* <igx-grid #grid (rowSelectionChanging)="rowSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
|
|
2149
|
-
* ```
|
|
1351
|
+
* Emitted when grid row is selected.
|
|
2150
1352
|
*/
|
|
2151
1353
|
rowSelectionChanging: CustomEvent<IgcRowSelectionEventArgs>;
|
|
2152
1354
|
|
|
2153
1355
|
/**
|
|
2154
|
-
* Emitted when
|
|
2155
|
-
*
|
|
2156
|
-
* @example
|
|
2157
|
-
* ```html
|
|
2158
|
-
* <igx-grid #grid (columnSelectionChanging)="columnSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
|
|
2159
|
-
* ```
|
|
1356
|
+
* Emitted when column is selected.
|
|
2160
1357
|
*/
|
|
2161
1358
|
columnSelectionChanging: CustomEvent<IgcColumnSelectionEventArgs>;
|
|
2162
1359
|
|
|
2163
1360
|
/**
|
|
2164
|
-
* Emitted before
|
|
2165
|
-
*
|
|
2166
|
-
* @remarks
|
|
2167
|
-
* The index at which to insert the column may be changed through the `insertAtIndex` property.
|
|
2168
|
-
* @example
|
|
2169
|
-
* ```typescript
|
|
2170
|
-
* public columnPinning(event) {
|
|
2171
|
-
* if (event.column.field === "Name") {
|
|
2172
|
-
* event.insertAtIndex = 0;
|
|
2173
|
-
* }
|
|
2174
|
-
* }
|
|
2175
|
-
* ```
|
|
1361
|
+
* Emitted before column is pinned.
|
|
2176
1362
|
*/
|
|
2177
1363
|
columnPin: CustomEvent<IgcPinColumnCancellableEventArgs>;
|
|
2178
1364
|
|
|
2179
1365
|
/**
|
|
2180
|
-
* Emitted after
|
|
2181
|
-
*
|
|
2182
|
-
* @remarks
|
|
2183
|
-
* The index that the column is inserted at may be changed through the `insertAtIndex` property.
|
|
2184
|
-
* @example
|
|
2185
|
-
* ```typescript
|
|
2186
|
-
* public columnPinning(event) {
|
|
2187
|
-
* if (event.column.field === "Name") {
|
|
2188
|
-
* event.insertAtIndex = 0;
|
|
2189
|
-
* }
|
|
2190
|
-
* }
|
|
2191
|
-
* ```
|
|
1366
|
+
* Emitted after column is pinned.
|
|
2192
1367
|
*/
|
|
2193
1368
|
columnPinned: CustomEvent<IgcPinColumnEventArgs>;
|
|
2194
1369
|
|
|
2195
1370
|
/**
|
|
2196
1371
|
* Emitted when cell enters edit mode.
|
|
2197
|
-
*
|
|
2198
|
-
* @remarks
|
|
2199
|
-
* This event is cancelable.
|
|
2200
|
-
* @example
|
|
2201
|
-
* ```html
|
|
2202
|
-
* <igx-grid #grid3 (cellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
|
|
2203
|
-
* </igx-grid>
|
|
2204
|
-
* ```
|
|
2205
1372
|
*/
|
|
2206
1373
|
cellEditEnter: CustomEvent<IgcGridEditEventArgs>;
|
|
2207
1374
|
|
|
2208
1375
|
/**
|
|
2209
1376
|
* Emitted when cell exits edit mode.
|
|
2210
|
-
*
|
|
2211
|
-
* @example
|
|
2212
|
-
* ```html
|
|
2213
|
-
* <igx-grid #grid3 (cellEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'">
|
|
2214
|
-
* </igx-grid>
|
|
2215
|
-
* ```
|
|
2216
1377
|
*/
|
|
2217
1378
|
cellEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
|
|
2218
1379
|
|
|
2219
1380
|
/**
|
|
2220
1381
|
* Emitted when cell has been edited.
|
|
2221
|
-
*
|
|
2222
|
-
* @remarks
|
|
2223
|
-
* Event is fired after editing is completed, when the cell is exiting edit mode.
|
|
2224
|
-
* This event is cancelable.
|
|
2225
|
-
* @example
|
|
2226
|
-
* ```html
|
|
2227
|
-
* <igx-grid #grid3 (cellEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
|
|
2228
|
-
* </igx-grid>
|
|
2229
|
-
* ```
|
|
2230
1382
|
*/
|
|
2231
1383
|
cellEdit: CustomEvent<IgcGridEditEventArgs>;
|
|
2232
1384
|
|
|
2233
1385
|
/* blazorCSSuppress */
|
|
2234
1386
|
/**
|
|
2235
1387
|
* Emitted after cell has been edited and editing has been committed.
|
|
2236
|
-
*
|
|
2237
|
-
* @example
|
|
2238
|
-
* ```html
|
|
2239
|
-
* <igx-grid #grid3 (cellEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
|
|
2240
|
-
* </igx-grid>
|
|
2241
|
-
* ```
|
|
2242
1388
|
*/
|
|
2243
1389
|
cellEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
|
|
2244
1390
|
|
|
2245
1391
|
/**
|
|
2246
1392
|
* Emitted when a row enters edit mode.
|
|
2247
|
-
*
|
|
2248
|
-
* @remarks
|
|
2249
|
-
* Emitted when [rowEditable]="true".
|
|
2250
|
-
* This event is cancelable.
|
|
2251
|
-
* @example
|
|
2252
|
-
* ```html
|
|
2253
|
-
* <igx-grid #grid3 (rowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
|
|
2254
|
-
* </igx-grid>
|
|
2255
|
-
* ```
|
|
2256
1393
|
*/
|
|
2257
1394
|
rowEditEnter: CustomEvent<IgcGridEditEventArgs>;
|
|
2258
1395
|
|
|
2259
1396
|
/**
|
|
2260
1397
|
* Emitted when exiting edit mode for a row.
|
|
2261
|
-
*
|
|
2262
|
-
* @remarks
|
|
2263
|
-
* Emitted when [rowEditable]="true" & `endEdit(true)` is called.
|
|
2264
|
-
* Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
|
|
2265
|
-
* performing paging operation, column resizing, pinning, moving or hitting `Done`
|
|
2266
|
-
* button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
|
|
2267
|
-
* This event is cancelable.
|
|
2268
|
-
* @example
|
|
2269
|
-
* ```html
|
|
2270
|
-
* <igx-grid #grid3 (rowEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
|
|
2271
|
-
* </igx-grid>
|
|
2272
|
-
* ```
|
|
2273
1398
|
*/
|
|
2274
1399
|
rowEdit: CustomEvent<IgcGridEditEventArgs>;
|
|
2275
1400
|
|
|
2276
1401
|
/**
|
|
2277
1402
|
* Emitted after exiting edit mode for a row and editing has been committed.
|
|
2278
|
-
*
|
|
2279
|
-
* @remarks
|
|
2280
|
-
* Emitted when [rowEditable]="true" & `endEdit(true)` is called.
|
|
2281
|
-
* Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
|
|
2282
|
-
* performing paging operation, column resizing, pinning, moving or hitting `Done`
|
|
2283
|
-
* button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
|
|
2284
|
-
* @example
|
|
2285
|
-
* ```html
|
|
2286
|
-
* <igx-grid #grid3 (rowEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
|
|
2287
|
-
* </igx-grid>
|
|
2288
|
-
* ```
|
|
2289
1403
|
*/
|
|
2290
1404
|
rowEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
|
|
2291
1405
|
|
|
2292
1406
|
/**
|
|
2293
1407
|
* Emitted when row editing is canceled.
|
|
2294
|
-
*
|
|
2295
|
-
* @remarks
|
|
2296
|
-
* Emits when [rowEditable]="true" & `endEdit(false)` is called.
|
|
2297
|
-
* Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button
|
|
2298
|
-
* in the row editing overlay.
|
|
2299
|
-
* @example
|
|
2300
|
-
* ```html
|
|
2301
|
-
* <igx-grid #grid3 (rowEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
|
|
2302
|
-
* </igx-grid>
|
|
2303
|
-
* ```
|
|
2304
1408
|
*/
|
|
2305
1409
|
rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
|
|
2306
1410
|
|
|
2307
1411
|
/**
|
|
2308
1412
|
* Emitted when a column is initialized.
|
|
2309
|
-
*
|
|
2310
|
-
* @remarks
|
|
2311
|
-
* Returns the column object.
|
|
2312
|
-
* @example
|
|
2313
|
-
* ```html
|
|
2314
|
-
* <igx-grid #grid [data]="localData" (columnInit)="initColumns($event)" [autoGenerate]="true"></igx-grid>
|
|
2315
|
-
* ```
|
|
2316
1413
|
*/
|
|
2317
1414
|
columnInit: CustomEvent<IgcColumnComponent>;
|
|
2318
1415
|
|
|
2319
|
-
/* blazorInclude */
|
|
2320
|
-
/**
|
|
2321
|
-
* @hidden @internal
|
|
2322
|
-
*/
|
|
2323
|
-
columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
|
|
2324
|
-
|
|
2325
1416
|
/**
|
|
2326
1417
|
* Emitted before sorting expressions are applied.
|
|
2327
|
-
*
|
|
2328
|
-
* @remarks
|
|
2329
|
-
* Returns an `ISortingEventArgs` object. `sortingExpressions` key holds the sorting expressions.
|
|
2330
|
-
* @example
|
|
2331
|
-
* ```html
|
|
2332
|
-
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>
|
|
2333
|
-
* ```
|
|
2334
1418
|
*/
|
|
2335
1419
|
sorting: CustomEvent<IgcSortingEventArgs>;
|
|
2336
1420
|
|
|
2337
1421
|
/**
|
|
2338
1422
|
* Emitted after sorting is completed.
|
|
2339
|
-
*
|
|
2340
|
-
* @remarks
|
|
2341
|
-
* Returns the sorting expression.
|
|
2342
|
-
* @example
|
|
2343
|
-
* ```html
|
|
2344
|
-
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>
|
|
2345
|
-
* ```
|
|
2346
1423
|
*/
|
|
2347
1424
|
sortingDone: CustomEvent<IgcSortingExpression[]>;
|
|
2348
1425
|
|
|
2349
1426
|
/**
|
|
2350
1427
|
* Emitted before filtering expressions are applied.
|
|
2351
|
-
*
|
|
2352
|
-
* @remarks
|
|
2353
|
-
* Returns an `IFilteringEventArgs` object. `filteringExpressions` key holds the filtering expressions for the column.
|
|
2354
|
-
* @example
|
|
2355
|
-
* ```html
|
|
2356
|
-
* <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filtering)="filtering($event)"></igx-grid>
|
|
2357
|
-
* ```
|
|
2358
1428
|
*/
|
|
2359
1429
|
filtering: CustomEvent<IgcFilteringEventArgs>;
|
|
2360
1430
|
|
|
2361
1431
|
/**
|
|
2362
1432
|
* Emitted after filtering is performed through the UI.
|
|
2363
|
-
*
|
|
2364
|
-
* @remarks
|
|
2365
|
-
* Returns the filtering expressions tree of the column for which filtering was performed.
|
|
2366
|
-
* @example
|
|
2367
|
-
* ```html
|
|
2368
|
-
* <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filteringDone)="filteringDone($event)"></igx-grid>
|
|
2369
|
-
* ```
|
|
2370
1433
|
*/
|
|
2371
1434
|
filteringDone: CustomEvent<IgcFilteringExpressionsTree>;
|
|
2372
1435
|
|
|
2373
1436
|
/* blazorCSSuppress */
|
|
2374
1437
|
/**
|
|
2375
1438
|
* Emitted when a row is added.
|
|
2376
|
-
*
|
|
2377
|
-
* @remarks
|
|
2378
|
-
* Returns the data for the new `IgxGridRowComponent` object.
|
|
2379
|
-
* @example
|
|
2380
|
-
* ```html
|
|
2381
|
-
* <igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2382
|
-
* ```
|
|
2383
1439
|
*/
|
|
2384
1440
|
rowAdded: CustomEvent<IgcRowDataEventArgs>;
|
|
2385
1441
|
|
|
2386
1442
|
/* blazorCSSuppress */
|
|
2387
1443
|
/**
|
|
2388
1444
|
* Emitted when a row is deleted.
|
|
2389
|
-
*
|
|
2390
|
-
* @remarks
|
|
2391
|
-
* Returns an `IRowDataEventArgs` object.
|
|
2392
|
-
* @example
|
|
2393
|
-
* ```html
|
|
2394
|
-
* <igx-grid #grid [data]="localData" (rowDeleted)="rowDeleted($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2395
|
-
* ```
|
|
2396
1445
|
*/
|
|
2397
1446
|
rowDeleted: CustomEvent<IgcRowDataEventArgs>;
|
|
2398
1447
|
|
|
2399
1448
|
/**
|
|
2400
1449
|
* Emmited when deleting a row.
|
|
2401
|
-
*
|
|
2402
|
-
* @remarks
|
|
2403
|
-
* This event is cancelable.
|
|
2404
|
-
* Returns an IRowDataCancellableEventArgs` object.
|
|
2405
|
-
* @example
|
|
2406
|
-
* ```html
|
|
2407
|
-
* <igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2408
|
-
* ```
|
|
2409
1450
|
*/
|
|
2410
1451
|
rowDelete: CustomEvent<IgcRowDataCancelableEventArgs>;
|
|
2411
1452
|
|
|
2412
1453
|
/**
|
|
2413
1454
|
* Emmited just before the newly added row is commited.
|
|
2414
|
-
*
|
|
2415
|
-
* @remarks
|
|
2416
|
-
* This event is cancelable.
|
|
2417
|
-
* Returns an IRowDataCancellableEventArgs` object.
|
|
2418
|
-
* @example
|
|
2419
|
-
* ```html
|
|
2420
|
-
* <igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
|
|
2421
|
-
* ```
|
|
2422
1455
|
*/
|
|
2423
1456
|
rowAdd: CustomEvent<IgcRowDataCancelableEventArgs>;
|
|
2424
1457
|
|
|
2425
1458
|
/**
|
|
2426
1459
|
* Emitted after column is resized.
|
|
2427
|
-
*
|
|
2428
|
-
* @remarks
|
|
2429
|
-
* Returns the `IgxColumnComponent` object's old and new width.
|
|
2430
|
-
* @example
|
|
2431
|
-
* ```html
|
|
2432
|
-
* <igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
|
|
2433
|
-
* ```
|
|
2434
1460
|
*/
|
|
2435
1461
|
columnResized: CustomEvent<IgcColumnResizeEventArgs>;
|
|
2436
1462
|
|
|
2437
1463
|
/**
|
|
2438
1464
|
* Emitted when a cell or row is right clicked.
|
|
2439
|
-
*
|
|
2440
|
-
* @remarks
|
|
2441
|
-
* Returns the `IgxGridCell` object if the immediate context menu target is a cell or an `IgxGridRow` otherwise.
|
|
2442
|
-
* ```html
|
|
2443
|
-
* <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
|
|
2444
|
-
* ```
|
|
2445
1465
|
*/
|
|
2446
1466
|
contextMenu: CustomEvent<IgcGridContextMenuEventArgs>;
|
|
2447
1467
|
|
|
2448
1468
|
/**
|
|
2449
1469
|
* Emitted when a cell is double clicked.
|
|
2450
|
-
*
|
|
2451
|
-
* @remarks
|
|
2452
|
-
* Returns the `IgxGridCell` object.
|
|
2453
|
-
* @example
|
|
2454
|
-
* ```html
|
|
2455
|
-
* <igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
|
|
2456
|
-
* ```
|
|
2457
1470
|
*/
|
|
2458
1471
|
doubleClick: CustomEvent<IgcGridCellEventArgs>;
|
|
2459
1472
|
|
|
2460
1473
|
/**
|
|
2461
1474
|
* Emitted before column visibility is changed.
|
|
2462
|
-
*
|
|
2463
|
-
* @remarks
|
|
2464
|
-
* Args: { column: any, newValue: boolean }
|
|
2465
|
-
* @example
|
|
2466
|
-
* ```html
|
|
2467
|
-
* <igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>
|
|
2468
|
-
* ```
|
|
2469
1475
|
*/
|
|
2470
1476
|
columnVisibilityChanging: CustomEvent<IgcColumnVisibilityChangingEventArgs>;
|
|
2471
1477
|
|
|
2472
1478
|
/**
|
|
2473
1479
|
* Emitted after column visibility is changed.
|
|
2474
|
-
*
|
|
2475
|
-
* @remarks
|
|
2476
|
-
* Args: { column: IgxColumnComponent, newValue: boolean }
|
|
2477
|
-
* @example
|
|
2478
|
-
* ```html
|
|
2479
|
-
* <igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>
|
|
2480
|
-
* ```
|
|
2481
1480
|
*/
|
|
2482
1481
|
columnVisibilityChanged: CustomEvent<IgcColumnVisibilityChangedEventArgs>;
|
|
2483
1482
|
|
|
2484
1483
|
/**
|
|
2485
1484
|
* Emitted when column moving starts.
|
|
2486
|
-
*
|
|
2487
|
-
* @remarks
|
|
2488
|
-
* Returns the moved `IgxColumnComponent` object.
|
|
2489
|
-
* @example
|
|
2490
|
-
* ```html
|
|
2491
|
-
* <igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
|
|
2492
|
-
* ```
|
|
2493
1485
|
*/
|
|
2494
1486
|
columnMovingStart: CustomEvent<IgcColumnMovingStartEventArgs>;
|
|
2495
1487
|
|
|
2496
1488
|
/**
|
|
2497
1489
|
* Emitted during the column moving operation.
|
|
2498
|
-
*
|
|
2499
|
-
* @remarks
|
|
2500
|
-
* Returns the source and target `IgxColumnComponent` objects. This event is cancelable.
|
|
2501
|
-
* @example
|
|
2502
|
-
* ```html
|
|
2503
|
-
* <igx-grid (columnMoving)="moving($event)"></igx-grid>
|
|
2504
|
-
* ```
|
|
2505
1490
|
*/
|
|
2506
1491
|
columnMoving: CustomEvent<IgcColumnMovingEventArgs>;
|
|
2507
1492
|
|
|
2508
1493
|
/**
|
|
2509
1494
|
* Emitted when column moving ends.
|
|
2510
|
-
*
|
|
2511
|
-
* @remarks
|
|
2512
|
-
* Returns the source and target `IgxColumnComponent` objects.
|
|
2513
|
-
* @example
|
|
2514
|
-
* ```html
|
|
2515
|
-
* <igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
|
|
2516
|
-
* ```
|
|
2517
1495
|
*/
|
|
2518
1496
|
columnMovingEnd: CustomEvent<IgcColumnMovingEndEventArgs>;
|
|
2519
1497
|
|
|
2520
1498
|
/**
|
|
2521
1499
|
* Emitted when keydown is triggered over element inside grid's body.
|
|
2522
|
-
*
|
|
2523
|
-
* @remarks
|
|
2524
|
-
* This event is fired only if the key combination is supported in the grid.
|
|
2525
|
-
* Return the target type, target object and the original event. This event is cancelable.
|
|
2526
|
-
* @example
|
|
2527
|
-
* ```html
|
|
2528
|
-
* <igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>
|
|
2529
|
-
* ```
|
|
2530
1500
|
*/
|
|
2531
1501
|
gridKeydown: CustomEvent<IgcGridKeydownEventArgs>;
|
|
2532
1502
|
|
|
2533
1503
|
/**
|
|
2534
1504
|
* Emitted when start dragging a row.
|
|
2535
|
-
*
|
|
2536
|
-
* @remarks
|
|
2537
|
-
* Return the dragged row.
|
|
2538
1505
|
*/
|
|
2539
1506
|
rowDragStart: CustomEvent<IgcRowDragStartEventArgs>;
|
|
2540
1507
|
|
|
2541
1508
|
/**
|
|
2542
1509
|
* Emitted when dropping a row.
|
|
2543
|
-
*
|
|
2544
|
-
* @remarks
|
|
2545
|
-
* Return the dropped row.
|
|
2546
1510
|
*/
|
|
2547
1511
|
rowDragEnd: CustomEvent<IgcRowDragEndEventArgs>;
|
|
2548
1512
|
|
|
2549
1513
|
/**
|
|
2550
1514
|
* Emitted when a copy operation is executed.
|
|
2551
|
-
*
|
|
2552
|
-
* @remarks
|
|
2553
|
-
* Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.
|
|
2554
1515
|
*/
|
|
2555
1516
|
gridCopy: CustomEvent<IgcGridClipboardEvent>;
|
|
2556
1517
|
|
|
2557
1518
|
/* blazorCSSuppress */
|
|
2558
1519
|
/**
|
|
2559
1520
|
* Emitted when the rows are expanded or collapsed.
|
|
2560
|
-
*
|
|
2561
|
-
* @example
|
|
2562
|
-
* ```html
|
|
2563
|
-
* <igx-grid [data]="employeeData" (expansionStatesChange)="expansionStatesChange($event)" [autoGenerate]="true"></igx-grid>
|
|
2564
|
-
* ```
|
|
2565
1521
|
*/
|
|
2566
1522
|
expansionStatesChange: CustomEvent<Map<any, boolean>>;
|
|
2567
1523
|
|
|
2568
1524
|
/* blazorInclude */
|
|
2569
1525
|
/**
|
|
2570
1526
|
* Emitted when the rows are selected or deselected.
|
|
2571
|
-
*
|
|
2572
|
-
* @example
|
|
2573
|
-
* ```html
|
|
2574
|
-
* <igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>
|
|
2575
|
-
* ```
|
|
2576
1527
|
*/
|
|
2577
1528
|
selectedRowsChange: CustomEvent<any[]>;
|
|
2578
1529
|
|
|
2579
|
-
/* blazorInclude */
|
|
2580
|
-
/** @hidden @internal */
|
|
2581
|
-
/**
|
|
2582
|
-
* Emitted when content children are resolved and collections in grid are updated.
|
|
2583
|
-
*/
|
|
2584
|
-
childrenResolved: CustomEvent<void>;
|
|
2585
|
-
|
|
2586
1530
|
/**
|
|
2587
1531
|
* Emitted when the expanded state of a row gets changed.
|
|
2588
|
-
*
|
|
2589
|
-
* @example
|
|
2590
|
-
* ```html
|
|
2591
|
-
* <igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>
|
|
2592
|
-
* ```
|
|
2593
1532
|
*/
|
|
2594
1533
|
rowToggle: CustomEvent<IgcRowToggleEventArgs>;
|
|
2595
1534
|
|
|
2596
1535
|
/**
|
|
2597
1536
|
* Emitted when the pinned state of a row is changed.
|
|
2598
|
-
*
|
|
2599
|
-
* @example
|
|
2600
|
-
* ```html
|
|
2601
|
-
* <igx-grid [data]="employeeData" (rowPinning)="rowPin($event)" [autoGenerate]="true"></igx-grid>
|
|
2602
|
-
* ```
|
|
2603
1537
|
*/
|
|
2604
1538
|
rowPinning: CustomEvent<IgcPinRowEventArgs>;
|
|
2605
1539
|
|
|
2606
1540
|
/**
|
|
2607
1541
|
* Emitted when the pinned state of a row is changed.
|
|
2608
|
-
*
|
|
2609
|
-
* @example
|
|
2610
|
-
* ```html
|
|
2611
|
-
* <igx-grid [data]="employeeData" (rowPinned)="rowPin($event)" [autoGenerate]="true"></igx-grid>
|
|
2612
|
-
* ```
|
|
2613
1542
|
*/
|
|
2614
1543
|
rowPinned: CustomEvent<IgcPinRowEventArgs>;
|
|
2615
1544
|
|
|
2616
1545
|
/**
|
|
2617
1546
|
* Emitted when the active node is changed.
|
|
2618
|
-
*
|
|
2619
|
-
* @example
|
|
2620
|
-
* ```
|
|
2621
|
-
* <igx-grid [data]="data" [autoGenerate]="true" (activeNodeChange)="activeNodeChange($event)"></igx-grid>
|
|
2622
|
-
* ```
|
|
2623
1547
|
*/
|
|
2624
1548
|
activeNodeChange: CustomEvent<IgcActiveNodeChangeEventArgs>;
|
|
2625
1549
|
|
|
2626
1550
|
/**
|
|
2627
1551
|
* Emitted before sorting is performed.
|
|
2628
|
-
*
|
|
2629
|
-
* @remarks
|
|
2630
|
-
* Returns the sorting expressions.
|
|
2631
|
-
* @example
|
|
2632
|
-
* ```html
|
|
2633
|
-
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingExpressionsChange)="sortingExprChange($event)"></igx-grid>
|
|
2634
|
-
* ```
|
|
2635
1552
|
*/
|
|
2636
1553
|
sortingExpressionsChange: CustomEvent<IgcSortingExpression[]>;
|
|
2637
1554
|
|
|
2638
1555
|
/**
|
|
2639
1556
|
* Emitted when an export process is initiated by the user.
|
|
2640
|
-
*
|
|
2641
|
-
* @example
|
|
2642
|
-
* ```typescript
|
|
2643
|
-
* toolbarExporting(event: IGridToolbarExportEventArgs){
|
|
2644
|
-
* const toolbarExporting = event;
|
|
2645
|
-
* }
|
|
2646
|
-
* ```
|
|
2647
1557
|
*/
|
|
2648
1558
|
toolbarExporting: CustomEvent<IgcGridToolbarExportEventArgs>;
|
|
2649
1559
|
|
|
2650
1560
|
/* End of toolbar related definitions */
|
|
2651
1561
|
/**
|
|
2652
1562
|
* Emitted when making a range selection.
|
|
2653
|
-
*
|
|
2654
|
-
* @remarks
|
|
2655
|
-
* Range selection can be made either through drag selection or through keyboard selection.
|
|
2656
1563
|
*/
|
|
2657
1564
|
rangeSelected: CustomEvent<IgcGridSelectionRange>;
|
|
2658
1565
|
|
|
@@ -2661,21 +1568,11 @@ rendered: CustomEvent<boolean>;
|
|
|
2661
1568
|
|
|
2662
1569
|
/**
|
|
2663
1570
|
* Emitted before the grid's data view is changed because of a data operation, rebinding, etc.
|
|
2664
|
-
*
|
|
2665
|
-
* @example
|
|
2666
|
-
* ```typescript
|
|
2667
|
-
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanging)='handleDataChangingEvent()'></igx-grid>
|
|
2668
|
-
* ```
|
|
2669
1571
|
*/
|
|
2670
1572
|
dataChanging: CustomEvent<IgcForOfDataChangeEventArgs>;
|
|
2671
1573
|
|
|
2672
1574
|
/**
|
|
2673
1575
|
* Emitted after the grid's data view is changed because of a data operation, rebinding, etc.
|
|
2674
|
-
*
|
|
2675
|
-
* @example
|
|
2676
|
-
* ```typescript
|
|
2677
|
-
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanged)='handleDataChangedEvent()'></igx-grid>
|
|
2678
|
-
* ```
|
|
2679
1576
|
*/
|
|
2680
1577
|
dataChanged: CustomEvent<IgcForOfDataChangeEventArgs>;
|
|
2681
1578
|
|