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
|
@@ -24,12 +24,9 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
24
24
|
/**
|
|
25
25
|
* **Ignite UI for Angular Column** -
|
|
26
26
|
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid#columns-configuration)
|
|
27
|
-
*
|
|
28
27
|
* The Ignite UI Column is used within an `igx-grid` element to define what data the column will show. Features such as sorting,
|
|
29
28
|
* filtering & editing are enabled at the column level. You can also provide a template containing custom content inside
|
|
30
29
|
* the column using `ng-template` which will be used for all cells within the column.
|
|
31
|
-
*
|
|
32
|
-
* @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, IgxRowIslandComponent, IgxColumnGroupComponent, IgxColumnLayoutComponent
|
|
33
30
|
*/
|
|
34
31
|
|
|
35
32
|
export declare class IgcColumnComponent extends EventEmitterMixin<IgcColumnComponentEventMap, Constructor<LitElement>>(LitElement)
|
|
@@ -45,14 +42,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
45
42
|
|
|
46
43
|
/**
|
|
47
44
|
* Sets/gets the `field` value.
|
|
48
|
-
* ```typescript
|
|
49
|
-
* let columnField = this.column.field;
|
|
50
|
-
* ```
|
|
51
|
-
* ```html
|
|
52
|
-
* <igx-column [field] = "'ID'"></igx-column>
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @memberof IgxColumnComponent
|
|
56
45
|
*/
|
|
57
46
|
public set field(value: string);
|
|
58
47
|
public get field(): string;
|
|
@@ -61,10 +50,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
61
50
|
|
|
62
51
|
/**
|
|
63
52
|
* Sets/gets whether to merge cells in this column.
|
|
64
|
-
* ```html
|
|
65
|
-
* <igx-column [merge]="true"></igx-column>
|
|
66
|
-
* ```
|
|
67
|
-
*
|
|
68
53
|
*/
|
|
69
54
|
public set merge(value: boolean);
|
|
70
55
|
public get merge(): boolean;
|
|
@@ -73,14 +58,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
73
58
|
|
|
74
59
|
/**
|
|
75
60
|
* Sets/gets the `header` value.
|
|
76
|
-
* ```typescript
|
|
77
|
-
* let columnHeader = this.column.header;
|
|
78
|
-
* ```
|
|
79
|
-
* ```html
|
|
80
|
-
* <igx-column [header] = "'ID'"></igx-column>
|
|
81
|
-
* ```
|
|
82
|
-
*
|
|
83
|
-
* @memberof IgxColumnComponent
|
|
84
61
|
*/
|
|
85
62
|
public set header(value: string);
|
|
86
63
|
public get header(): string;
|
|
@@ -88,14 +65,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
88
65
|
|
|
89
66
|
/**
|
|
90
67
|
* Sets/gets the `title` value.
|
|
91
|
-
* ```typescript
|
|
92
|
-
* let title = this.column.title;
|
|
93
|
-
* ```
|
|
94
|
-
* ```html
|
|
95
|
-
* <igx-column [title] = "'Some column tooltip'"></igx-column>
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* @memberof IgxColumnComponent
|
|
99
68
|
*/
|
|
100
69
|
public set title(value: string);
|
|
101
70
|
public get title(): string;
|
|
@@ -104,14 +73,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
104
73
|
/**
|
|
105
74
|
* Sets/gets whether the column is sortable.
|
|
106
75
|
* Default value is `false`.
|
|
107
|
-
* ```typescript
|
|
108
|
-
* let isSortable = this.column.sortable;
|
|
109
|
-
* ```
|
|
110
|
-
* ```html
|
|
111
|
-
* <igx-column [sortable] = "true"></igx-column>
|
|
112
|
-
* ```
|
|
113
|
-
*
|
|
114
|
-
* @memberof IgxColumnComponent
|
|
115
76
|
*/
|
|
116
77
|
public set sortable(value: boolean);
|
|
117
78
|
public get sortable(): boolean;
|
|
@@ -119,11 +80,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
119
80
|
|
|
120
81
|
/**
|
|
121
82
|
* Returns if the column is selectable.
|
|
122
|
-
* ```typescript
|
|
123
|
-
* let columnSelectable = this.column.selectable;
|
|
124
|
-
* ```
|
|
125
|
-
*
|
|
126
|
-
* @memberof IgxColumnComponent
|
|
127
83
|
*/
|
|
128
84
|
public set selectable(value: boolean);
|
|
129
85
|
public get selectable(): boolean;
|
|
@@ -133,14 +89,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
133
89
|
/**
|
|
134
90
|
* Sets/gets whether the column is groupable.
|
|
135
91
|
* Default value is `false`.
|
|
136
|
-
* ```typescript
|
|
137
|
-
* let isGroupable = this.column.groupable;
|
|
138
|
-
* ```
|
|
139
|
-
* ```html
|
|
140
|
-
* <igx-column [groupable] = "true"></igx-column>
|
|
141
|
-
* ```
|
|
142
|
-
*
|
|
143
|
-
* @memberof IgxColumnComponent
|
|
144
92
|
*/
|
|
145
93
|
public set groupable(value: boolean);
|
|
146
94
|
public get groupable(): boolean;
|
|
@@ -149,11 +97,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
149
97
|
/**
|
|
150
98
|
* Gets whether the column is editable.
|
|
151
99
|
* Default value is `false`.
|
|
152
|
-
* ```typescript
|
|
153
|
-
* let isEditable = this.column.editable;
|
|
154
|
-
* ```
|
|
155
|
-
*
|
|
156
|
-
* @memberof IgxColumnComponent
|
|
157
100
|
*/
|
|
158
101
|
public set editable(value: boolean);
|
|
159
102
|
public get editable(): boolean;
|
|
@@ -162,14 +105,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
162
105
|
/**
|
|
163
106
|
* Sets/gets whether the column is filterable.
|
|
164
107
|
* Default value is `true`.
|
|
165
|
-
* ```typescript
|
|
166
|
-
* let isFilterable = this.column.filterable;
|
|
167
|
-
* ```
|
|
168
|
-
* ```html
|
|
169
|
-
* <igx-column [filterable] = "false"></igx-column>
|
|
170
|
-
* ```
|
|
171
|
-
*
|
|
172
|
-
* @memberof IgxColumnComponent
|
|
173
108
|
*/
|
|
174
109
|
public set filterable(value: boolean);
|
|
175
110
|
public get filterable(): boolean;
|
|
@@ -178,14 +113,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
178
113
|
/**
|
|
179
114
|
* Sets/gets whether the column is resizable.
|
|
180
115
|
* Default value is `false`.
|
|
181
|
-
* ```typescript
|
|
182
|
-
* let isResizable = this.column.resizable;
|
|
183
|
-
* ```
|
|
184
|
-
* ```html
|
|
185
|
-
* <igx-column [resizable] = "true"></igx-column>
|
|
186
|
-
* ```
|
|
187
|
-
*
|
|
188
|
-
* @memberof IgxColumnComponent
|
|
189
116
|
*/
|
|
190
117
|
public set resizable(value: boolean);
|
|
191
118
|
public get resizable(): boolean;
|
|
@@ -196,14 +123,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
196
123
|
* Sets/gets whether the column header is included in autosize logic.
|
|
197
124
|
* Useful when template for a column header is sized based on parent, for example a default `div`.
|
|
198
125
|
* Default value is `false`.
|
|
199
|
-
* ```typescript
|
|
200
|
-
* let isResizable = this.column.resizable;
|
|
201
|
-
* ```
|
|
202
|
-
* ```html
|
|
203
|
-
* <igx-column [resizable] = "true"></igx-column>
|
|
204
|
-
* ```
|
|
205
|
-
*
|
|
206
|
-
* @memberof IgxColumnComponent
|
|
207
126
|
*/
|
|
208
127
|
public set autosizeHeader(value: boolean);
|
|
209
128
|
public get autosizeHeader(): boolean;
|
|
@@ -212,11 +131,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
212
131
|
|
|
213
132
|
/**
|
|
214
133
|
* Gets a value indicating whether the summary for the column is enabled.
|
|
215
|
-
* ```typescript
|
|
216
|
-
* let hasSummary = this.column.hasSummary;
|
|
217
|
-
* ```
|
|
218
|
-
*
|
|
219
|
-
* @memberof IgxColumnComponent
|
|
220
134
|
*/
|
|
221
135
|
public set hasSummary(value: boolean);
|
|
222
136
|
public get hasSummary(): boolean;
|
|
@@ -224,11 +138,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
224
138
|
|
|
225
139
|
/**
|
|
226
140
|
* Gets whether the column is hidden.
|
|
227
|
-
* ```typescript
|
|
228
|
-
* let isHidden = this.column.hidden;
|
|
229
|
-
* ```
|
|
230
|
-
*
|
|
231
|
-
* @memberof IgxColumnComponent
|
|
232
141
|
*/
|
|
233
142
|
public set hidden(value: boolean);
|
|
234
143
|
public get hidden(): boolean;
|
|
@@ -237,11 +146,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
237
146
|
|
|
238
147
|
/**
|
|
239
148
|
* Returns if the column is selected.
|
|
240
|
-
* ```typescript
|
|
241
|
-
* let isSelected = this.column.selected;
|
|
242
|
-
* ```
|
|
243
|
-
*
|
|
244
|
-
* @memberof IgxColumnComponent
|
|
245
149
|
*/
|
|
246
150
|
public set selected(value: boolean);
|
|
247
151
|
public get selected(): boolean;
|
|
@@ -250,11 +154,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
250
154
|
|
|
251
155
|
/**
|
|
252
156
|
* Gets whether the hiding is disabled.
|
|
253
|
-
* ```typescript
|
|
254
|
-
* let isHidingDisabled = this.column.disableHiding;
|
|
255
|
-
* ```
|
|
256
|
-
*
|
|
257
|
-
* @memberof IgxColumnComponent
|
|
258
157
|
*/
|
|
259
158
|
public set disableHiding(value: boolean);
|
|
260
159
|
public get disableHiding(): boolean;
|
|
@@ -262,11 +161,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
262
161
|
|
|
263
162
|
/**
|
|
264
163
|
* Gets whether the pinning is disabled.
|
|
265
|
-
* ```typescript
|
|
266
|
-
* let isPinningDisabled = this.column.disablePinning;
|
|
267
|
-
* ```
|
|
268
|
-
*
|
|
269
|
-
* @memberof IgxColumnComponent
|
|
270
164
|
*/
|
|
271
165
|
public set disablePinning(value: boolean);
|
|
272
166
|
public get disablePinning(): boolean;
|
|
@@ -275,11 +169,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
275
169
|
|
|
276
170
|
/**
|
|
277
171
|
* Gets the `width` of the column.
|
|
278
|
-
* ```typescript
|
|
279
|
-
* let columnWidth = this.column.width;
|
|
280
|
-
* ```
|
|
281
|
-
*
|
|
282
|
-
* @memberof IgxColumnComponent
|
|
283
172
|
*/
|
|
284
173
|
public set width(value: string);
|
|
285
174
|
public get width(): string;
|
|
@@ -288,14 +177,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
288
177
|
|
|
289
178
|
/**
|
|
290
179
|
* Sets/gets the maximum `width` of the column.
|
|
291
|
-
* ```typescript
|
|
292
|
-
* let columnMaxWidth = this.column.width;
|
|
293
|
-
* ```
|
|
294
|
-
* ```html
|
|
295
|
-
* <igx-column [maxWidth] = "'150px'"></igx-column>
|
|
296
|
-
* ```
|
|
297
|
-
*
|
|
298
|
-
* @memberof IgxColumnComponent
|
|
299
180
|
*/
|
|
300
181
|
public set maxWidth(value: string);
|
|
301
182
|
public get maxWidth(): string;
|
|
@@ -303,14 +184,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
303
184
|
|
|
304
185
|
/**
|
|
305
186
|
* Sets/gets the class selector of the column header.
|
|
306
|
-
* ```typescript
|
|
307
|
-
* let columnHeaderClass = this.column.headerClasses;
|
|
308
|
-
* ```
|
|
309
|
-
* ```html
|
|
310
|
-
* <igx-column [headerClasses] = "'column-header'"></igx-column>
|
|
311
|
-
* ```
|
|
312
|
-
*
|
|
313
|
-
* @memberof IgxColumnComponent
|
|
314
187
|
*/
|
|
315
188
|
public set headerClasses(value: string);
|
|
316
189
|
public get headerClasses(): string;
|
|
@@ -321,17 +194,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
321
194
|
* Sets conditional style properties on the column header.
|
|
322
195
|
* Similar to `ngStyle` it accepts an object literal where the keys are
|
|
323
196
|
* the style properties and the value is the expression to be evaluated.
|
|
324
|
-
* ```typescript
|
|
325
|
-
* styles = {
|
|
326
|
-
* background: 'royalblue',
|
|
327
|
-
* color: (column) => column.pinned ? 'red': 'inherit'
|
|
328
|
-
* }
|
|
329
|
-
* ```
|
|
330
|
-
* ```html
|
|
331
|
-
* <igx-column [headerStyles]="styles"></igx-column>
|
|
332
|
-
* ```
|
|
333
|
-
*
|
|
334
|
-
* @memberof IgxColumnComponent
|
|
335
197
|
*/
|
|
336
198
|
public set headerStyles(value: any);
|
|
337
199
|
public get headerStyles(): any;
|
|
@@ -340,14 +202,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
340
202
|
|
|
341
203
|
/**
|
|
342
204
|
* Sets/gets the class selector of the column group header.
|
|
343
|
-
* ```typescript
|
|
344
|
-
* let columnHeaderClass = this.column.headerGroupClasses;
|
|
345
|
-
* ```
|
|
346
|
-
* ```html
|
|
347
|
-
* <igx-column [headerGroupClasses] = "'column-group-header'"></igx-column>
|
|
348
|
-
* ```
|
|
349
|
-
*
|
|
350
|
-
* @memberof IgxColumnComponent
|
|
351
205
|
*/
|
|
352
206
|
public set headerGroupClasses(value: string);
|
|
353
207
|
public get headerGroupClasses(): string;
|
|
@@ -358,17 +212,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
358
212
|
* Sets conditional style properties on the column header group wrapper.
|
|
359
213
|
* Similar to `ngStyle` it accepts an object literal where the keys are
|
|
360
214
|
* the style properties and the value is the expression to be evaluated.
|
|
361
|
-
* ```typescript
|
|
362
|
-
* styles = {
|
|
363
|
-
* background: 'royalblue',
|
|
364
|
-
* color: (column) => column.pinned ? 'red': 'inherit'
|
|
365
|
-
* }
|
|
366
|
-
* ```
|
|
367
|
-
* ```html
|
|
368
|
-
* <igx-column [headerGroupStyles]="styles"></igx-column>
|
|
369
|
-
* ```
|
|
370
|
-
*
|
|
371
|
-
* @memberof IgxColumnComponent
|
|
372
215
|
*/
|
|
373
216
|
public set headerGroupStyles(value: any);
|
|
374
217
|
public get headerGroupStyles(): any;
|
|
@@ -382,16 +225,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
382
225
|
* where the key is the name of the CSS class, while the
|
|
383
226
|
* value is either a callback function that returns a boolean,
|
|
384
227
|
* or boolean, like so:
|
|
385
|
-
* ```typescript
|
|
386
|
-
* callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; }
|
|
387
|
-
* cellClasses = { 'className' : this.callback };
|
|
388
|
-
* ```
|
|
389
|
-
* ```html
|
|
390
|
-
* <igx-column [cellClasses] = "cellClasses"></igx-column>
|
|
391
|
-
* <igx-column [cellClasses] = "{'class1' : true }"></igx-column>
|
|
392
|
-
* ```
|
|
393
|
-
*
|
|
394
|
-
* @memberof IgxColumnComponent
|
|
395
228
|
*/
|
|
396
229
|
public set cellClasses(value: any);
|
|
397
230
|
public get cellClasses(): any;
|
|
@@ -404,17 +237,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
404
237
|
* Similar to `ngStyle` it accepts an object literal where the keys are
|
|
405
238
|
* the style properties and the value is the expression to be evaluated.
|
|
406
239
|
* As with `cellClasses` it accepts a callback function.
|
|
407
|
-
* ```typescript
|
|
408
|
-
* styles = {
|
|
409
|
-
* background: 'royalblue',
|
|
410
|
-
* color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit'
|
|
411
|
-
* }
|
|
412
|
-
* ```
|
|
413
|
-
* ```html
|
|
414
|
-
* <igx-column [cellStyles]="styles"></igx-column>
|
|
415
|
-
* ```
|
|
416
|
-
*
|
|
417
|
-
* @memberof IgxColumnComponent
|
|
418
240
|
*/
|
|
419
241
|
public set cellStyles(value: any);
|
|
420
242
|
public get cellStyles(): any;
|
|
@@ -425,36 +247,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
425
247
|
/* blazorOnlyScript */
|
|
426
248
|
/**
|
|
427
249
|
* Applies display format to cell values in the column. Does not modify the underlying data.
|
|
428
|
-
*
|
|
429
|
-
* @remarks
|
|
430
|
-
* Note: As the formatter is used in places like the Excel style filtering dialog, in certain
|
|
431
|
-
* scenarios (remote filtering for example), the row data argument can be `undefined`.
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
* In this example, we check to see if the column name is Salary, and then provide a method as the column formatter
|
|
435
|
-
* to format the value into a currency string.
|
|
436
|
-
*
|
|
437
|
-
* @example
|
|
438
|
-
* ```typescript
|
|
439
|
-
* columnInit(column: IgxColumnComponent) {
|
|
440
|
-
* if (column.field == "Salary") {
|
|
441
|
-
* column.formatter = (salary => this.format(salary));
|
|
442
|
-
* }
|
|
443
|
-
* }
|
|
444
|
-
*
|
|
445
|
-
* format(value: number) : string {
|
|
446
|
-
* return formatCurrency(value, "en-us", "$");
|
|
447
|
-
* }
|
|
448
|
-
* ```
|
|
449
|
-
*
|
|
450
|
-
* @example
|
|
451
|
-
* ```typescript
|
|
452
|
-
* const column = this.grid.getColumnByName('Address');
|
|
453
|
-
* const addressFormatter = (address: string, rowData: any) => data.privacyEnabled ? 'unknown' : address;
|
|
454
|
-
* column.formatter = addressFormatter;
|
|
455
|
-
* ```
|
|
456
|
-
*
|
|
457
|
-
* @memberof IgxColumnComponent
|
|
458
250
|
*/
|
|
459
251
|
public set formatter(value: any);
|
|
460
252
|
public get formatter(): any;
|
|
@@ -466,28 +258,8 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
466
258
|
/* forceCastDelegate */
|
|
467
259
|
/**
|
|
468
260
|
* The summaryFormatter is used to format the display of the column summaries.
|
|
469
|
-
*
|
|
470
261
|
* In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter
|
|
471
262
|
* to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.
|
|
472
|
-
*
|
|
473
|
-
* ```typescript
|
|
474
|
-
* columnInit(column: IgxColumnComponent) {
|
|
475
|
-
* if (column.field == "OrderDate") {
|
|
476
|
-
* column.summaryFormatter = this.summaryFormat;
|
|
477
|
-
* }
|
|
478
|
-
* }
|
|
479
|
-
*
|
|
480
|
-
* summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string {
|
|
481
|
-
* const result = summary.summaryResult;
|
|
482
|
-
* if(summaryResult.key !== 'count' && result !== null && result !== undefined) {
|
|
483
|
-
* const pipe = new DatePipe('fr-FR');
|
|
484
|
-
* return pipe.transform(result,'mediumDate');
|
|
485
|
-
* }
|
|
486
|
-
* return result;
|
|
487
|
-
* }
|
|
488
|
-
* ```
|
|
489
|
-
*
|
|
490
|
-
* @memberof IgxColumnComponent
|
|
491
263
|
*/
|
|
492
264
|
public set summaryFormatter(value: any);
|
|
493
265
|
public get summaryFormatter(): any;
|
|
@@ -497,14 +269,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
497
269
|
/**
|
|
498
270
|
* Sets/gets whether the column filtering should be case sensitive.
|
|
499
271
|
* Default value is `true`.
|
|
500
|
-
* ```typescript
|
|
501
|
-
* let filteringIgnoreCase = this.column.filteringIgnoreCase;
|
|
502
|
-
* ```
|
|
503
|
-
* ```html
|
|
504
|
-
* <igx-column [filteringIgnoreCase] = "false"></igx-column>
|
|
505
|
-
* ```
|
|
506
|
-
*
|
|
507
|
-
* @memberof IgxColumnComponent
|
|
508
272
|
*/
|
|
509
273
|
public set filteringIgnoreCase(value: boolean);
|
|
510
274
|
public get filteringIgnoreCase(): boolean;
|
|
@@ -513,14 +277,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
513
277
|
/**
|
|
514
278
|
* Sets/gets whether the column sorting should be case sensitive.
|
|
515
279
|
* Default value is `true`.
|
|
516
|
-
* ```typescript
|
|
517
|
-
* let sortingIgnoreCase = this.column.sortingIgnoreCase;
|
|
518
|
-
* ```
|
|
519
|
-
* ```html
|
|
520
|
-
* <igx-column [sortingIgnoreCase] = "false"></igx-column>
|
|
521
|
-
* ```
|
|
522
|
-
*
|
|
523
|
-
* @memberof IgxColumnComponent
|
|
524
280
|
*/
|
|
525
281
|
public set sortingIgnoreCase(value: boolean);
|
|
526
282
|
public get sortingIgnoreCase(): boolean;
|
|
@@ -529,14 +285,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
529
285
|
/**
|
|
530
286
|
* Sets/gets whether the column is `searchable`.
|
|
531
287
|
* Default value is `true`.
|
|
532
|
-
* ```typescript
|
|
533
|
-
* let isSearchable = this.column.searchable';
|
|
534
|
-
* ```
|
|
535
|
-
* ```html
|
|
536
|
-
* <igx-column [searchable] = "false"></igx-column>
|
|
537
|
-
* ```
|
|
538
|
-
*
|
|
539
|
-
* @memberof IgxColumnComponent
|
|
540
288
|
*/
|
|
541
289
|
public set searchable(value: boolean);
|
|
542
290
|
public get searchable(): boolean;
|
|
@@ -545,14 +293,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
545
293
|
/**
|
|
546
294
|
* Sets/gets the data type of the column values.
|
|
547
295
|
* Default value is `string`.
|
|
548
|
-
* ```typescript
|
|
549
|
-
* let columnDataType = this.column.dataType;
|
|
550
|
-
* ```
|
|
551
|
-
* ```html
|
|
552
|
-
* <igx-column [dataType] = "'number'"></igx-column>
|
|
553
|
-
* ```
|
|
554
|
-
*
|
|
555
|
-
* @memberof IgxColumnComponent
|
|
556
296
|
*/
|
|
557
297
|
public set dataType(value: GridColumnDataType);
|
|
558
298
|
public get dataType(): GridColumnDataType;
|
|
@@ -562,13 +302,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
562
302
|
/**
|
|
563
303
|
* Row index where the current field should end.
|
|
564
304
|
* The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field
|
|
565
|
-
* ```html
|
|
566
|
-
* <igx-column-layout>
|
|
567
|
-
* <igx-column [rowEnd]="2" [rowStart]="1" [colStart]="1"></igx-column>
|
|
568
|
-
* </igx-column-layout>
|
|
569
|
-
* ```
|
|
570
|
-
*
|
|
571
|
-
* @memberof IgxColumnComponent
|
|
572
305
|
*/
|
|
573
306
|
public set rowEnd(value: number);
|
|
574
307
|
public get rowEnd(): number;
|
|
@@ -578,13 +311,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
578
311
|
/**
|
|
579
312
|
* Column index where the current field should end.
|
|
580
313
|
* The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field
|
|
581
|
-
* ```html
|
|
582
|
-
* <igx-column-layout>
|
|
583
|
-
* <igx-column [colEnd]="3" [rowStart]="1" [colStart]="1"></igx-column>
|
|
584
|
-
* </igx-column-layout>
|
|
585
|
-
* ```
|
|
586
|
-
*
|
|
587
|
-
* @memberof IgxColumnComponent
|
|
588
314
|
*/
|
|
589
315
|
public set colEnd(value: number);
|
|
590
316
|
public get colEnd(): number;
|
|
@@ -593,13 +319,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
593
319
|
|
|
594
320
|
/**
|
|
595
321
|
* Row index from which the field is starting.
|
|
596
|
-
* ```html
|
|
597
|
-
* <igx-column-layout>
|
|
598
|
-
* <igx-column [rowStart]="1" [colStart]="1"></igx-column>
|
|
599
|
-
* </igx-column-layout>
|
|
600
|
-
* ```
|
|
601
|
-
*
|
|
602
|
-
* @memberof IgxColumnComponent
|
|
603
322
|
*/
|
|
604
323
|
public set rowStart(value: number);
|
|
605
324
|
public get rowStart(): number;
|
|
@@ -608,13 +327,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
608
327
|
|
|
609
328
|
/**
|
|
610
329
|
* Column index from which the field is starting.
|
|
611
|
-
* ```html
|
|
612
|
-
* <igx-column-layout>
|
|
613
|
-
* <igx-column [colStart]="1" [rowStart]="1"></igx-column>
|
|
614
|
-
* </igx-column-layout>
|
|
615
|
-
* ```
|
|
616
|
-
*
|
|
617
|
-
* @memberof IgxColumnComponent
|
|
618
330
|
*/
|
|
619
331
|
public set colStart(value: number);
|
|
620
332
|
public get colStart(): number;
|
|
@@ -623,16 +335,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
623
335
|
|
|
624
336
|
/**
|
|
625
337
|
* Sets/gets custom properties provided in additional template context.
|
|
626
|
-
*
|
|
627
|
-
* ```html
|
|
628
|
-
* <igx-column [additionalTemplateContext]="contextObject">
|
|
629
|
-
* <ng-template igxCell let-cell="cell" let-props="additionalTemplateContext">
|
|
630
|
-
* {{ props }}
|
|
631
|
-
* </ng-template>
|
|
632
|
-
* </igx-column>
|
|
633
|
-
* ```
|
|
634
|
-
*
|
|
635
|
-
* @memberof IgxColumnComponent
|
|
636
338
|
*/
|
|
637
339
|
public set additionalTemplateContext(value: any);
|
|
638
340
|
public get additionalTemplateContext(): any;
|
|
@@ -643,14 +345,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
643
345
|
/**
|
|
644
346
|
* Sets/gets the minimum `width` of the column.
|
|
645
347
|
* Default value is `88`;
|
|
646
|
-
* ```typescript
|
|
647
|
-
* let columnMinWidth = this.column.minWidth;
|
|
648
|
-
* ```
|
|
649
|
-
* ```html
|
|
650
|
-
* <igx-column [minWidth] = "'100px'"></igx-column>
|
|
651
|
-
* ```
|
|
652
|
-
*
|
|
653
|
-
* @memberof IgxColumnComponent
|
|
654
348
|
*/
|
|
655
349
|
public set minWidth(value: string);
|
|
656
350
|
public get minWidth(): string;
|
|
@@ -659,11 +353,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
659
353
|
|
|
660
354
|
/**
|
|
661
355
|
* Gets the column index.
|
|
662
|
-
* ```typescript
|
|
663
|
-
* let columnIndex = this.column.index;
|
|
664
|
-
* ```
|
|
665
|
-
*
|
|
666
|
-
* @memberof IgxColumnComponent
|
|
667
356
|
*/
|
|
668
357
|
public get index(): number;
|
|
669
358
|
|
|
@@ -672,8 +361,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
672
361
|
/* mustCoerceToInt */
|
|
673
362
|
/**
|
|
674
363
|
* Gets the pinning position of the column.
|
|
675
|
-
* ```typescript
|
|
676
|
-
* let pinningPosition = this.column.pinningPosition;
|
|
677
364
|
*/
|
|
678
365
|
public set pinningPosition(value: ColumnPinningPosition);
|
|
679
366
|
public get pinningPosition(): ColumnPinningPosition;
|
|
@@ -682,11 +369,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
682
369
|
|
|
683
370
|
/**
|
|
684
371
|
* Gets whether the column is `pinned`.
|
|
685
|
-
* ```typescript
|
|
686
|
-
* let isPinned = this.column.pinned;
|
|
687
|
-
* ```
|
|
688
|
-
*
|
|
689
|
-
* @memberof IgxColumnComponent
|
|
690
372
|
*/
|
|
691
373
|
public set pinned(value: boolean);
|
|
692
374
|
public get pinned(): boolean;
|
|
@@ -696,11 +378,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
696
378
|
/* treatAsRef */
|
|
697
379
|
/**
|
|
698
380
|
* Gets the column `summaries`.
|
|
699
|
-
* ```typescript
|
|
700
|
-
* let columnSummaries = this.column.summaries;
|
|
701
|
-
* ```
|
|
702
|
-
*
|
|
703
|
-
* @memberof IgxColumnComponent
|
|
704
381
|
*/
|
|
705
382
|
public set summaries(value: any);
|
|
706
383
|
public get summaries(): any;
|
|
@@ -710,14 +387,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
710
387
|
/**
|
|
711
388
|
* Sets/gets the summary operands to exclude from display.
|
|
712
389
|
* Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.
|
|
713
|
-
* ```typescript
|
|
714
|
-
* let disabledSummaries = this.column.disabledSummaries;
|
|
715
|
-
* ```
|
|
716
|
-
* ```html
|
|
717
|
-
* <igx-column [disabledSummaries]="['min', 'max', 'average']"></igx-column>
|
|
718
|
-
* ```
|
|
719
|
-
*
|
|
720
|
-
* @memberof IgxColumnComponent
|
|
721
390
|
*/
|
|
722
391
|
public set disabledSummaries(value: string[]);
|
|
723
392
|
public get disabledSummaries(): string[];
|
|
@@ -726,11 +395,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
726
395
|
|
|
727
396
|
/**
|
|
728
397
|
* Gets the column `filters`.
|
|
729
|
-
* ```typescript
|
|
730
|
-
* let columnFilters = this.column.filters'
|
|
731
|
-
* ```
|
|
732
|
-
*
|
|
733
|
-
* @memberof IgxColumnComponent
|
|
734
398
|
*/
|
|
735
399
|
public set filters(value: IgcFilteringOperand);
|
|
736
400
|
public get filters(): IgcFilteringOperand;
|
|
@@ -738,11 +402,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
738
402
|
|
|
739
403
|
/**
|
|
740
404
|
* Gets the column `sortStrategy`.
|
|
741
|
-
* ```typescript
|
|
742
|
-
* let sortStrategy = this.column.sortStrategy
|
|
743
|
-
* ```
|
|
744
|
-
*
|
|
745
|
-
* @memberof IgxColumnComponent
|
|
746
405
|
*/
|
|
747
406
|
public set sortStrategy(value: IgcSortingStrategy);
|
|
748
407
|
public get sortStrategy(): IgcSortingStrategy;
|
|
@@ -750,11 +409,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
750
409
|
|
|
751
410
|
/**
|
|
752
411
|
* Returns a reference to the `summaryTemplate`.
|
|
753
|
-
* ```typescript
|
|
754
|
-
* let summaryTemplate = this.column.summaryTemplate;
|
|
755
|
-
* ```
|
|
756
|
-
*
|
|
757
|
-
* @memberof IgxColumnComponent
|
|
758
412
|
*/
|
|
759
413
|
public set summaryTemplate(value: IgcRenderFunction<IgcSummaryTemplateContext>);
|
|
760
414
|
public get summaryTemplate(): IgcRenderFunction<IgcSummaryTemplateContext>;
|
|
@@ -763,11 +417,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
763
417
|
|
|
764
418
|
/**
|
|
765
419
|
* Returns a reference to the `bodyTemplate`.
|
|
766
|
-
* ```typescript
|
|
767
|
-
* let bodyTemplate = this.column.bodyTemplate;
|
|
768
|
-
* ```
|
|
769
|
-
*
|
|
770
|
-
* @memberof IgxColumnComponent
|
|
771
420
|
*/
|
|
772
421
|
public set bodyTemplate(value: IgcRenderFunction<IgcCellTemplateContext>);
|
|
773
422
|
public get bodyTemplate(): IgcRenderFunction<IgcCellTemplateContext>;
|
|
@@ -775,11 +424,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
775
424
|
|
|
776
425
|
/**
|
|
777
426
|
* Returns a reference to the header template.
|
|
778
|
-
* ```typescript
|
|
779
|
-
* let headerTemplate = this.column.headerTemplate;
|
|
780
|
-
* ```
|
|
781
|
-
*
|
|
782
|
-
* @memberof IgxColumnComponent
|
|
783
427
|
*/
|
|
784
428
|
public set headerTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>);
|
|
785
429
|
public get headerTemplate(): IgcRenderFunction<IgcColumnTemplateContext>;
|
|
@@ -787,11 +431,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
787
431
|
|
|
788
432
|
/**
|
|
789
433
|
* Returns a reference to the inline editor template.
|
|
790
|
-
* ```typescript
|
|
791
|
-
* let inlineEditorTemplate = this.column.inlineEditorTemplate;
|
|
792
|
-
* ```
|
|
793
|
-
*
|
|
794
|
-
* @memberof IgxColumnComponent
|
|
795
434
|
*/
|
|
796
435
|
public set inlineEditorTemplate(value: IgcRenderFunction<IgcCellTemplateContext>);
|
|
797
436
|
public get inlineEditorTemplate(): IgcRenderFunction<IgcCellTemplateContext>;
|
|
@@ -800,9 +439,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
800
439
|
|
|
801
440
|
/**
|
|
802
441
|
* Returns a reference to the validation error template.
|
|
803
|
-
* ```typescript
|
|
804
|
-
* let errorTemplate = this.column.errorTemplate;
|
|
805
|
-
* ```
|
|
806
442
|
*/
|
|
807
443
|
public set errorTemplate(value: IgcRenderFunction<IgcCellTemplateContext>);
|
|
808
444
|
public get errorTemplate(): IgcRenderFunction<IgcCellTemplateContext>;
|
|
@@ -811,11 +447,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
811
447
|
|
|
812
448
|
/**
|
|
813
449
|
* Returns a reference to the `filterCellTemplate`.
|
|
814
|
-
* ```typescript
|
|
815
|
-
* let filterCellTemplate = this.column.filterCellTemplate;
|
|
816
|
-
* ```
|
|
817
|
-
*
|
|
818
|
-
* @memberof IgxColumnComponent
|
|
819
450
|
*/
|
|
820
451
|
public set filterCellTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>);
|
|
821
452
|
public get filterCellTemplate(): IgcRenderFunction<IgcColumnTemplateContext>;
|
|
@@ -825,9 +456,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
825
456
|
/**
|
|
826
457
|
* Gets the column visible index.
|
|
827
458
|
* If the column is not visible, returns `-1`.
|
|
828
|
-
* ```typescript
|
|
829
|
-
* let visibleColumnIndex = this.column.visibleIndex;
|
|
830
|
-
* ```
|
|
831
459
|
*/
|
|
832
460
|
public get visibleIndex(): number;
|
|
833
461
|
|
|
@@ -836,11 +464,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
836
464
|
/* blazorCSSuppress - Blazor doesn't carry over the ColumnType interface + should translate as static bool value */
|
|
837
465
|
/**
|
|
838
466
|
* Returns a boolean indicating if the column is a `ColumnGroup`.
|
|
839
|
-
* ```typescript
|
|
840
|
-
* let columnGroup = this.column.columnGroup;
|
|
841
|
-
* ```
|
|
842
|
-
*
|
|
843
|
-
* @memberof IgxColumnComponent
|
|
844
467
|
*/
|
|
845
468
|
public get columnGroup(): boolean;
|
|
846
469
|
|
|
@@ -849,11 +472,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
849
472
|
/* blazorCSSuppress - Blazor doesn't carry over the ColumnType interface + should translate as static bool value */
|
|
850
473
|
/**
|
|
851
474
|
* Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.
|
|
852
|
-
* ```typescript
|
|
853
|
-
* let columnGroup = this.column.columnGroup;
|
|
854
|
-
* ```
|
|
855
|
-
*
|
|
856
|
-
* @memberof IgxColumnComponent
|
|
857
475
|
*/
|
|
858
476
|
public get columnLayout(): boolean;
|
|
859
477
|
|
|
@@ -861,11 +479,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
861
479
|
|
|
862
480
|
/**
|
|
863
481
|
* Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.
|
|
864
|
-
* ```typescript
|
|
865
|
-
* let columnLayoutChild = this.column.columnLayoutChild;
|
|
866
|
-
* ```
|
|
867
|
-
*
|
|
868
|
-
* @memberof IgxColumnComponent
|
|
869
482
|
*/
|
|
870
483
|
public get columnLayoutChild(): boolean;
|
|
871
484
|
|
|
@@ -881,11 +494,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
881
494
|
/**
|
|
882
495
|
* Returns the level of the column in a column group.
|
|
883
496
|
* Returns `0` if the column doesn't have a `parent`.
|
|
884
|
-
* ```typescript
|
|
885
|
-
* let columnLevel = this.column.level;
|
|
886
|
-
* ```
|
|
887
|
-
*
|
|
888
|
-
* @memberof IgxColumnComponent
|
|
889
497
|
*/
|
|
890
498
|
public get level(): number;
|
|
891
499
|
|
|
@@ -893,13 +501,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
893
501
|
|
|
894
502
|
/**
|
|
895
503
|
* Indicates whether the column will be visible when its parent is collapsed.
|
|
896
|
-
* ```html
|
|
897
|
-
* <igx-column-group>
|
|
898
|
-
* <igx-column [visibleWhenCollapsed]="true"></igx-column>
|
|
899
|
-
* </igx-column-group>
|
|
900
|
-
* ```
|
|
901
|
-
*
|
|
902
|
-
* @memberof IgxColumnComponent
|
|
903
504
|
*/
|
|
904
505
|
public set visibleWhenCollapsed(value: boolean);
|
|
905
506
|
public get visibleWhenCollapsed(): boolean;
|
|
@@ -908,23 +509,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
908
509
|
|
|
909
510
|
/* mustSetInCodePlatforms: WebComponents;Blazor;React */
|
|
910
511
|
/**
|
|
911
|
-
* @remarks
|
|
912
|
-
* Pass optional parameters for DatePipe and/or DecimalPipe to format the display value for date and numeric columns.
|
|
913
|
-
* Accepts an `IColumnPipeArgs` object with any of the `format`, `timezone` and `digitsInfo` properties.
|
|
914
|
-
* For more details see https://angular.io/api/common/DatePipe and https://angular.io/api/common/DecimalPipe
|
|
915
|
-
* @example
|
|
916
|
-
* ```typescript
|
|
917
|
-
* const pipeArgs: IColumnPipeArgs = {
|
|
918
|
-
* format: 'longDate',
|
|
919
|
-
* timezone: 'UTC',
|
|
920
|
-
* digitsInfo: '1.1-2'
|
|
921
|
-
* }
|
|
922
|
-
* ```
|
|
923
|
-
* ```html
|
|
924
|
-
* <igx-column dataType="date" [pipeArgs]="pipeArgs"></igx-column>
|
|
925
|
-
* <igx-column dataType="number" [pipeArgs]="pipeArgs"></igx-column>
|
|
926
|
-
* ```
|
|
927
|
-
* @memberof IgxColumnComponent
|
|
928
512
|
*/
|
|
929
513
|
public set pipeArgs(value: IgcColumnPipeArgs);
|
|
930
514
|
public get pipeArgs(): IgcColumnPipeArgs;
|
|
@@ -933,18 +517,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
933
517
|
|
|
934
518
|
/**
|
|
935
519
|
* Pass optional properties for the default column editors.
|
|
936
|
-
* @remarks
|
|
937
|
-
* Options may be applicable only to specific column type editors.
|
|
938
|
-
* @example
|
|
939
|
-
* ```typescript
|
|
940
|
-
* const editorOptions: IColumnEditorOptions = {
|
|
941
|
-
* dateTimeFormat: 'MM/dd/YYYY',
|
|
942
|
-
* }
|
|
943
|
-
* ```
|
|
944
|
-
* ```html
|
|
945
|
-
* <igx-column dataType="date" [editorOptions]="editorOptions"></igx-column>
|
|
946
|
-
* ```
|
|
947
|
-
* @memberof IgxColumnComponent
|
|
948
520
|
*/
|
|
949
521
|
public set editorOptions(value: IgcColumnEditorOptions);
|
|
950
522
|
public get editorOptions(): IgcColumnEditorOptions;
|
|
@@ -954,11 +526,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
954
526
|
|
|
955
527
|
/**
|
|
956
528
|
* Returns the filteringExpressionsTree of the column.
|
|
957
|
-
* ```typescript
|
|
958
|
-
* let tree = this.column.filteringExpressionsTree;
|
|
959
|
-
* ```
|
|
960
|
-
*
|
|
961
|
-
* @memberof IgxColumnComponent
|
|
962
529
|
*/
|
|
963
530
|
public get filteringExpressionsTree(): IgcFilteringExpressionsTree;
|
|
964
531
|
|
|
@@ -969,12 +536,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
969
536
|
// We need that because Blazor cannot handle the type correctly.
|
|
970
537
|
/**
|
|
971
538
|
* Sets/gets the parent column.
|
|
972
|
-
* ```typescript
|
|
973
|
-
* let parentColumn = this.column.parent;
|
|
974
|
-
* ```
|
|
975
|
-
* ```typescript
|
|
976
|
-
* this.column.parent = higherLevelColumn;
|
|
977
|
-
* ```
|
|
978
539
|
*/
|
|
979
540
|
public set parent(value: IgcColumnComponent);
|
|
980
541
|
public get parent(): IgcColumnComponent;
|
|
@@ -983,9 +544,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
983
544
|
|
|
984
545
|
/**
|
|
985
546
|
* Returns a reference to the top level parent column.
|
|
986
|
-
* ```typescript
|
|
987
|
-
* let topLevelParent = this.column.topLevelParent;
|
|
988
|
-
* ```
|
|
989
547
|
*/
|
|
990
548
|
public get topLevelParent(): IgcColumnComponent;
|
|
991
549
|
|
|
@@ -998,11 +556,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
998
556
|
* Column cannot be pinned if:
|
|
999
557
|
* - Is already pinned
|
|
1000
558
|
* - index argument is out of range
|
|
1001
|
-
* ```typescript
|
|
1002
|
-
* let success = this.column.pin();
|
|
1003
|
-
* ```
|
|
1004
|
-
*
|
|
1005
|
-
* @memberof IgxColumnComponent
|
|
1006
559
|
*/
|
|
1007
560
|
public pin(index?: number, pinningPosition?: ColumnPinningPosition): boolean;
|
|
1008
561
|
|
|
@@ -1014,11 +567,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
1014
567
|
* Column cannot be unpinned if:
|
|
1015
568
|
* - Is already unpinned
|
|
1016
569
|
* - index argument is out of range
|
|
1017
|
-
* ```typescript
|
|
1018
|
-
* let success = this.column.unpin();
|
|
1019
|
-
* ```
|
|
1020
|
-
*
|
|
1021
|
-
* @memberof IgxColumnComponent
|
|
1022
570
|
*/
|
|
1023
571
|
public unpin(index?: number): boolean;
|
|
1024
572
|
|
|
@@ -1028,12 +576,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
1028
576
|
* Moves a column to the specified visible index.
|
|
1029
577
|
* If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed.
|
|
1030
578
|
* If passed index would move the column to a different column group. moving is not performed.
|
|
1031
|
-
*
|
|
1032
|
-
* @example
|
|
1033
|
-
* ```typescript
|
|
1034
|
-
* column.move(index);
|
|
1035
|
-
* ```
|
|
1036
|
-
* @memberof IgxColumnComponent
|
|
1037
579
|
*/
|
|
1038
580
|
public move(index: number): void;
|
|
1039
581
|
|
|
@@ -1041,13 +583,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
|
|
|
1041
583
|
|
|
1042
584
|
/**
|
|
1043
585
|
* Autosize the column to the longest currently visible cell value, including the header cell.
|
|
1044
|
-
* ```typescript
|
|
1045
|
-
* @ViewChild('grid') grid: IgxGridComponent;
|
|
1046
|
-
* let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
|
|
1047
|
-
* column.autosize();
|
|
1048
|
-
* ```
|
|
1049
|
-
*
|
|
1050
|
-
* @memberof IgxColumnComponent
|
|
1051
586
|
* @param byHeaderOnly Set if column should be autosized based only on the header content.
|
|
1052
587
|
*/
|
|
1053
588
|
public autosize(byHeaderOnly?: boolean): void;
|
|
@@ -1058,45 +593,21 @@ export declare interface IgcColumnComponentEventMap {
|
|
|
1058
593
|
|
|
1059
594
|
/**
|
|
1060
595
|
* Emitted when the column is hidden or shown.
|
|
1061
|
-
*
|
|
1062
|
-
* ```html
|
|
1063
|
-
* <igx-column (hiddenChange)="hiddenChange($event)">
|
|
1064
|
-
* </igx-column>
|
|
1065
|
-
* ```
|
|
1066
|
-
*
|
|
1067
596
|
*/
|
|
1068
597
|
hiddenChange: CustomEvent<boolean>;
|
|
1069
598
|
|
|
1070
599
|
/**
|
|
1071
600
|
* Emitted when the column expanded or collapsed.
|
|
1072
|
-
*
|
|
1073
|
-
* ```html
|
|
1074
|
-
* <igx-column (expandedChange)="expandedChange($event)">
|
|
1075
|
-
* </igx-column>
|
|
1076
|
-
* ```
|
|
1077
|
-
*
|
|
1078
601
|
*/
|
|
1079
602
|
expandedChange: CustomEvent<boolean>;
|
|
1080
603
|
|
|
1081
604
|
/**
|
|
1082
605
|
* Emitted when the column width changes.
|
|
1083
|
-
*
|
|
1084
|
-
* ```html
|
|
1085
|
-
* <igx-column (widthChange)="widthChange($event)">
|
|
1086
|
-
* </igx-column>
|
|
1087
|
-
* ```
|
|
1088
|
-
*
|
|
1089
606
|
*/
|
|
1090
607
|
widthChange: CustomEvent<string>;
|
|
1091
608
|
|
|
1092
609
|
/**
|
|
1093
610
|
* Emitted when the column is pinned/unpinned.
|
|
1094
|
-
*
|
|
1095
|
-
* ```html
|
|
1096
|
-
* <igx-column (pinnedChange)="pinnedChange($event)">
|
|
1097
|
-
* </igx-column>
|
|
1098
|
-
* ```
|
|
1099
|
-
*
|
|
1100
611
|
*/
|
|
1101
612
|
pinnedChange: CustomEvent<boolean>;
|
|
1102
613
|
|