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