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