-
Notifications
You must be signed in to change notification settings - Fork 54
/
Copy pathmaterial-table.html
executable file
·2024 lines (1358 loc) · 60 KB
/
material-table.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<div class="docs-api">
<h2>
API reference for Angular Material table
</h2><p class="docs-api-module-import">
<code>
import {MatTableModule} from '@angular/material/table';
</code>
</p>
<h3 id="material-table-directives" class="docs-header-link docs-api-h3">
<span header-link="directives"></span>
Directives
</h3>
<h4 id="MatRecycleRows" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatRecycleRows"></span>
<code>MatRecycleRows</code>
</h4><p class="docs-api-class-description"><p>Enables the recycle view repeater strategy, which reduces rendering latency. Not compatible with
tables that animate rows.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">mat-table[recycleRows]</span>
<span class="docs-api-class-selector-name">table[mat-table][recycleRows]</span>
</p>
<h4 id="MatTable" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatTable"></span>
<code>MatTable</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkTable" class="docs-api-class-extends-type">
CdkTable
</a>
</span>
</h4><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">mat-table</span>
<span class="docs-api-class-selector-name">table[mat-table]</span>
</p><span class="docs-api-class-export-label">Exported as:</span>
<span class="docs-api-class-export-name">matTable</span><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
<table class="docs-api-properties-table">
<tr class="docs-api-properties-header-row">
<th class="docs-api-properties-th">Name</th>
<th class="docs-api-properties-th">Description</th>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
@Input()</div><p class="docs-api-property-name">
<code>dataSource: CdkTableDataSourceInput<T></code>
</p>
</td>
<td class="docs-api-property-description"><p>The table's source of data, which can be provided in three ways (in order of complexity):</p>
<ul>
<li>Simple data array (each object represents one table row)</li>
<li>Stream that emits a data array each time the array changes</li>
<li><code>DataSource</code> object that implements the connect/disconnect interface.</li>
</ul>
<p>If a data array is provided, the table must be notified when the array's objects are
added, removed, or moved. This can be done by calling the <code>renderRows()</code> function which will
render the diff since the last table render. If the data array reference is changed, the table
will automatically trigger an update to the rows.</p>
<p>When providing an Observable stream, the table will trigger an update automatically when the
stream emits a new array of data.</p>
<p>Finally, when providing a <code>DataSource</code> object, the table will use the Observable stream
provided by the connect function and trigger updates when that stream emits new data array
values. During the table's ngOnDestroy or when the data source is removed from the table, the
table will call the DataSource's <code>disconnect</code> function (may be useful for cleaning up any
subscriptions registered during the connect process).</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
@Input()</div><p class="docs-api-property-name">
<code>fixedLayout: boolean</code>
</p>
</td>
<td class="docs-api-property-description"><p>Whether to use a fixed table layout. Enabling this option will enforce consistent column widths
and optimize rendering sticky styles for native tables. No-op for flex tables.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
@Input()</div><p class="docs-api-property-name">
<code>multiTemplateDataRows: boolean</code>
</p>
</td>
<td class="docs-api-property-description"><p>Whether to allow multiple rows per data object by evaluating which rows evaluate their 'when'
predicate to true. If <code>multiTemplateDataRows</code> is false, which is the default value, then each
dataobject will render the first row that evaluates its when predicate to true, in the order
defined in the table, or otherwise the default row which does not have a when predicate.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
@Input()</div><p class="docs-api-property-name">
<code>trackBy: TrackByFunction<T></code>
</p>
</td>
<td class="docs-api-property-description"><p>Tracking function that will be used to check the differences in data changes. Used similarly
to <code>ngFor</code> <code>trackBy</code> function. Optimize row operations by identifying a row based on its data
relative to the function to know if a row should be added/removed/moved.
Accepts a function that takes two parameters, <code>index</code> and <code>item</code>.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-output-marker">
@Output()</div><p class="docs-api-property-name">
<code>contentChanged: EventEmitter<void></code>
</p>
</td>
<td class="docs-api-property-description"><p>Emits when the table completes rendering a set of data rows based on the latest data from the
data source, even if the set of rows is empty.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><p class="docs-api-property-name">
<code>needsPositionStickyOnElement: false</code>
</p>
</td>
<td class="docs-api-property-description"><p>Overrides the need to add position: sticky on every sticky cell element in <code>CdkTable</code>.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><p class="docs-api-property-name">
<code>stickyCssClass: 'mat-mdc-table-sticky'</code>
</p>
</td>
<td class="docs-api-property-description"><p>Overrides the sticky CSS class set by the <code>CdkTable</code>.</p>
</td>
</tr>
</table>
<h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">addColumnDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Adds a column definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
columnDef</p>
<code class="docs-api-method-parameter-type">CdkColumnDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">addFooterRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Adds a footer row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
footerRowDef</p>
<code class="docs-api-method-parameter-type">CdkFooterRowDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">addHeaderRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Adds a header row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
headerRowDef</p>
<code class="docs-api-method-parameter-type">CdkHeaderRowDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">addRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Adds a row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
rowDef</p>
<code class="docs-api-method-parameter-type">CdkRowDef<T></code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">removeColumnDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Removes a column definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
columnDef</p>
<code class="docs-api-method-parameter-type">CdkColumnDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">removeFooterRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Removes a footer row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
footerRowDef</p>
<code class="docs-api-method-parameter-type">CdkFooterRowDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">removeHeaderRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Removes a header row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
headerRowDef</p>
<code class="docs-api-method-parameter-type">CdkHeaderRowDef</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">removeRowDef
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Removes a row definition that was not included as part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
rowDef</p>
<code class="docs-api-method-parameter-type">CdkRowDef<T></code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">renderRows
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Renders rows based on the table's latest set of data, which was either provided directly as an
input or retrieved through an Observable stream (directly or from a DataSource).
Checks for differences in the data since the last diff to perform only the necessary
changes (add/remove/move rows).</p>
<p>If the table's data source is a DataSource or Observable, this will be invoked automatically
each time the provided Observable stream emits a new data array. Otherwise if your data is
an array, this function will need to be called to render any changes.</p>
</td>
</tr></table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">setNoDataRow
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Sets a no data row definition that was not included as a part of the content children.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
noDataRow</p>
<code class="docs-api-method-parameter-type">CdkNoDataRow</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
</p>
</td>
</tr>
</table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">updateStickyColumnStyles
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Updates the column sticky styles. First resets all applied styles with respect to the cells
sticking to the left and right. Then sticky styles are added for the left and right according
to the column definitions for each cell in each row. This is automatically called when
the data source provides a new set of data or when a column definition changes its sticky
input. May be called manually for cases where the cell content changes outside of these events.</p>
</td>
</tr></table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">updateStickyFooterRowStyles
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Updates the footer sticky styles. First resets all applied styles with respect to the cells
sticking to the bottom. Then, evaluating which cells need to be stuck to the bottom. This is
automatically called when the footer row changes its displayed set of columns, or if its
sticky input changes. May be called manually for cases where the cell content changes outside
of these events.</p>
</td>
</tr></table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">updateStickyHeaderRowStyles
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Updates the header sticky styles. First resets all applied styles with respect to the cells
sticking to the top. Then, evaluating which cells need to be stuck to the top. This is
automatically called when the header row changes its displayed set of columns, or if its
sticky input changes. May be called manually for cases where the cell content changes outside
of these events.</p>
</td>
</tr></table>
<h4 id="MatCellDef" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatCellDef"></span>
<code>MatCellDef</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkCellDef" class="docs-api-class-extends-type">
CdkCellDef
</a>
</span>
</h4><p class="docs-api-class-description"><p>Cell definition for the mat-table.
Captures the template of a column's data row cell as well as cell-specific properties.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">[matCellDef]</span>
</p>
<h4 id="MatHeaderCellDef" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatHeaderCellDef"></span>
<code>MatHeaderCellDef</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkHeaderCellDef" class="docs-api-class-extends-type">
CdkHeaderCellDef
</a>
</span>
</h4><p class="docs-api-class-description"><p>Header cell definition for the mat-table.
Captures the template of a column's header cell and as well as cell-specific properties.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">[matHeaderCellDef]</span>
</p>
<h4 id="MatFooterCellDef" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatFooterCellDef"></span>
<code>MatFooterCellDef</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkFooterCellDef" class="docs-api-class-extends-type">
CdkFooterCellDef
</a>
</span>
</h4><p class="docs-api-class-description"><p>Footer cell definition for the mat-table.
Captures the template of a column's footer cell and as well as cell-specific properties.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">[matFooterCellDef]</span>
</p>
<h4 id="MatColumnDef" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatColumnDef"></span>
<code>MatColumnDef</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkColumnDef" class="docs-api-class-extends-type">
CdkColumnDef
</a>
</span>
</h4><p class="docs-api-class-description"><p>Column definition for the mat-table.
Defines a set of cells available for a table column.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">[matColumnDef]</span>
</p><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
<table class="docs-api-properties-table">
<tr class="docs-api-properties-header-row">
<th class="docs-api-properties-th">Name</th>
<th class="docs-api-properties-th">Description</th>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">@Input(<span class="docs-api-input-alias">'matColumnDef'</span>)
</div><p class="docs-api-property-name">
<code>name: string</code>
</p>
</td>
<td class="docs-api-property-description"><p>Unique name for this column.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
@Input()</div><p class="docs-api-property-name">
<code>sticky: boolean</code>
</p>
</td>
<td class="docs-api-property-description"><p>Whether sticky positioning should be applied.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">@Input(<span class="docs-api-input-alias">'stickyEnd'</span>)
</div><p class="docs-api-property-name">
<code>stickyEnd: boolean</code>
</p>
</td>
<td class="docs-api-property-description"><p>Whether this column should be sticky positioned on the end of the row. Should make sure
that it mimics the <code>CanStick</code> mixin such that <code>_hasStickyChanged</code> is set to true if the value
has been changed.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><p class="docs-api-property-name">
<code>cssClassFriendlyName: string</code>
</p>
</td>
<td class="docs-api-property-description"><p>Transformed version of the column name that can be used as part of a CSS classname. Excludes
all non-alphanumeric characters and the special characters '-' and '_'. Any characters that
do not match are replaced by the '-' character.</p>
</td>
</tr>
</table>
<h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">hasStickyChanged
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Whether the sticky value has changed since this was last called.</p>
</td>
</tr><thead>
<tr class="docs-api-method-returns-header-row">
<th colspan="2" class="docs-api-method-returns-header-cell">Returns</th>
</tr>
</thead>
<tr>
<td class="docs-api-method-returns-type-cell">
<code class="docs-api-method-returns-type">boolean</code>
</td>
<td class="docs-api-method-returns-description-cell">
<p class="docs-api-method-returns-description">
</p>
</td>
</tr></table>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">resetStickyChanged
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Resets the dirty check for cases where the sticky state has been used without checking.</p>
</td>
</tr></table>
<h4 id="MatHeaderCell" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatHeaderCell"></span>
<code>MatHeaderCell</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkHeaderCell" class="docs-api-class-extends-type">
CdkHeaderCell
</a>
</span>
</h4><p class="docs-api-class-description"><p>Header cell template container that adds the right classes and role.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">mat-header-cell</span>
<span class="docs-api-class-selector-name">th[mat-header-cell]</span>
</p>
<h4 id="MatFooterCell" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatFooterCell"></span>
<code>MatFooterCell</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkFooterCell" class="docs-api-class-extends-type">
CdkFooterCell
</a>
</span>
</h4><p class="docs-api-class-description"><p>Footer cell template container that adds the right classes and role.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">mat-footer-cell</span>
<span class="docs-api-class-selector-name">td[mat-footer-cell]</span>
</p>
<h4 id="MatCell" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatCell"></span>
<code>MatCell</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkCell" class="docs-api-class-extends-type">
CdkCell
</a>
</span>
</h4><p class="docs-api-class-description"><p>Cell template container that adds the right classes and role.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">mat-cell</span>
<span class="docs-api-class-selector-name">td[mat-cell]</span>
</p>
<h4 id="MatHeaderRowDef" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="MatHeaderRowDef"></span>
<code>MatHeaderRowDef</code>
<span class="docs-api-class-extends-clauses">
<span class="docs-api-class-extends-label">extends</span>
<a href="cdk/table/api#CdkHeaderRowDef" class="docs-api-class-extends-type">
CdkHeaderRowDef
</a>
</span>
</h4><p class="docs-api-class-description"><p>Header row definition for the mat-table.
Captures the header row's template and other header properties such as the columns to display.</p>
</p><p class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">Selector:</span>
<span class="docs-api-class-selector-name">[matHeaderRowDef]</span>
</p><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
<table class="docs-api-properties-table">
<tr class="docs-api-properties-header-row">
<th class="docs-api-properties-th">Name</th>
<th class="docs-api-properties-th">Description</th>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">@Input(<span class="docs-api-input-alias"> matHeaderRowDef</span>)
</div><p class="docs-api-property-name">
<code>columns: Iterable<string></code>
</p>
</td>
<td class="docs-api-property-description"><p>The columns to be displayed on this row.</p>
</td>
</tr>
<tr class="docs-api-properties-row">
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">@Input(<span class="docs-api-input-alias"> matHeaderRowDefSticky</span>)
</div><p class="docs-api-property-name">
<code>sticky: boolean</code>
</p>
</td>
<td class="docs-api-property-description"><p>Whether sticky positioning should be applied.</p>
</td>
</tr>
</table>
<h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">extractCellTemplate
</th>
</tr>
</thead><tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
<p>Gets this row def's relevant cell template from the provided column def.</p>
</td>
</tr><thead>
<tr class="docs-api-method-parameters-header-row">