@angular/cdk
Version:
Angular Material Component Development Kit
1,259 lines • 146 kB
JavaScript
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/table/table.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { Directionality } from '@angular/cdk/bidi';
import { coerceBooleanProperty } from '@angular/cdk/coercion';
import { isDataSource } from '@angular/cdk/collections';
import { Platform } from '@angular/cdk/platform';
import { DOCUMENT } from '@angular/common';
import { Attribute, ChangeDetectionStrategy, ChangeDetectorRef, Component, ContentChildren, Directive, ElementRef, EmbeddedViewRef, Inject, Input, isDevMode, IterableDiffers, Optional, QueryList, ViewChild, ViewContainerRef, ViewEncapsulation } from '@angular/core';
import { BehaviorSubject, Observable, of as observableOf, Subject } from 'rxjs';
import { takeUntil } from 'rxjs/operators';
import { CdkColumnDef } from './cell';
import { CdkCellOutlet, CdkFooterRowDef, CdkHeaderRowDef, CdkRowDef } from './row';
import { StickyStyler } from './sticky-styler';
import { getTableDuplicateColumnNameError, getTableMissingMatchingRowDefError, getTableMissingRowDefsError, getTableMultipleDefaultRowDefsError, getTableUnknownColumnError, getTableUnknownDataSourceError } from './table-errors';
/**
* Interface used to provide an outlet for rows to be inserted into.
* @record
*/
export function RowOutlet() { }
if (false) {
/** @type {?} */
RowOutlet.prototype.viewContainer;
}
/**
* Provides a handle for the table to grab the view container's ng-container to insert data rows.
* \@docs-private
*/
export class DataRowOutlet {
/**
* @param {?} viewContainer
* @param {?} elementRef
*/
constructor(viewContainer, elementRef) {
this.viewContainer = viewContainer;
this.elementRef = elementRef;
}
}
DataRowOutlet.decorators = [
{ type: Directive, args: [{ selector: '[rowOutlet]' },] }
];
/** @nocollapse */
DataRowOutlet.ctorParameters = () => [
{ type: ViewContainerRef },
{ type: ElementRef }
];
if (false) {
/** @type {?} */
DataRowOutlet.prototype.viewContainer;
/** @type {?} */
DataRowOutlet.prototype.elementRef;
}
/**
* Provides a handle for the table to grab the view container's ng-container to insert the header.
* \@docs-private
*/
export class HeaderRowOutlet {
/**
* @param {?} viewContainer
* @param {?} elementRef
*/
constructor(viewContainer, elementRef) {
this.viewContainer = viewContainer;
this.elementRef = elementRef;
}
}
HeaderRowOutlet.decorators = [
{ type: Directive, args: [{ selector: '[headerRowOutlet]' },] }
];
/** @nocollapse */
HeaderRowOutlet.ctorParameters = () => [
{ type: ViewContainerRef },
{ type: ElementRef }
];
if (false) {
/** @type {?} */
HeaderRowOutlet.prototype.viewContainer;
/** @type {?} */
HeaderRowOutlet.prototype.elementRef;
}
/**
* Provides a handle for the table to grab the view container's ng-container to insert the footer.
* \@docs-private
*/
export class FooterRowOutlet {
/**
* @param {?} viewContainer
* @param {?} elementRef
*/
constructor(viewContainer, elementRef) {
this.viewContainer = viewContainer;
this.elementRef = elementRef;
}
}
FooterRowOutlet.decorators = [
{ type: Directive, args: [{ selector: '[footerRowOutlet]' },] }
];
/** @nocollapse */
FooterRowOutlet.ctorParameters = () => [
{ type: ViewContainerRef },
{ type: ElementRef }
];
if (false) {
/** @type {?} */
FooterRowOutlet.prototype.viewContainer;
/** @type {?} */
FooterRowOutlet.prototype.elementRef;
}
/**
* The table template that can be used by the mat-table. Should not be used outside of the
* material library.
* \@docs-private
* @type {?}
*/
export const CDK_TABLE_TEMPLATE =
// Note that according to MDN, the `caption` element has to be projected as the **first**
// element in the table. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption
`
<ng-content select="caption"></ng-content>
<ng-container headerRowOutlet></ng-container>
<ng-container rowOutlet></ng-container>
<ng-container footerRowOutlet></ng-container>
`;
/**
* Interface used to conveniently type the possible context interfaces for the render row.
* \@docs-private
* @record
* @template T
*/
export function RowContext() { }
/**
* Class used to conveniently type the embedded view ref for rows with a context.
* \@docs-private
* @abstract
* @template T
*/
class RowViewRef extends EmbeddedViewRef {
}
/**
* Set of properties that represents the identity of a single rendered row.
*
* When the table needs to determine the list of rows to render, it will do so by iterating through
* each data object and evaluating its list of row templates to display (when multiTemplateDataRows
* is false, there is only one template per data object). For each pair of data object and row
* template, a `RenderRow` is added to the list of rows to render. If the data object and row
* template pair has already been rendered, the previously used `RenderRow` is added; else a new
* `RenderRow` is * created. Once the list is complete and all data objects have been itereated
* through, a diff is performed to determine the changes that need to be made to the rendered rows.
*
* \@docs-private
* @record
* @template T
*/
export function RenderRow() { }
if (false) {
/** @type {?} */
RenderRow.prototype.data;
/** @type {?} */
RenderRow.prototype.dataIndex;
/** @type {?} */
RenderRow.prototype.rowDef;
}
/**
* A data table that can render a header row, data rows, and a footer row.
* Uses the dataSource input to determine the data to be rendered. The data can be provided either
* as a data array, an Observable stream that emits the data array to render, or a DataSource with a
* connect function that will return an Observable stream that emits the data array to render.
* @template T
*/
export class CdkTable {
/**
* @param {?} _differs
* @param {?} _changeDetectorRef
* @param {?} _elementRef
* @param {?} role
* @param {?} _dir
* @param {?} _document
* @param {?} _platform
*/
constructor(_differs, _changeDetectorRef, _elementRef, role, _dir, _document, _platform) {
this._differs = _differs;
this._changeDetectorRef = _changeDetectorRef;
this._elementRef = _elementRef;
this._dir = _dir;
this._platform = _platform;
/**
* Subject that emits when the component has been destroyed.
*/
this._onDestroy = new Subject();
/**
* Map of all the user's defined columns (header, data, and footer cell template) identified by
* name. Collection populated by the column definitions gathered by `ContentChildren` as well as
* any custom column definitions added to `_customColumnDefs`.
*/
this._columnDefsByName = new Map();
/**
* Column definitions that were defined outside of the direct content children of the table.
* These will be defined when, e.g., creating a wrapper around the cdkTable that has
* column definitions as *its* content child.
*/
this._customColumnDefs = new Set();
/**
* Data row definitions that were defined outside of the direct content children of the table.
* These will be defined when, e.g., creating a wrapper around the cdkTable that has
* built-in data rows as *its* content child.
*/
this._customRowDefs = new Set();
/**
* Header row definitions that were defined outside of the direct content children of the table.
* These will be defined when, e.g., creating a wrapper around the cdkTable that has
* built-in header rows as *its* content child.
*/
this._customHeaderRowDefs = new Set();
/**
* Footer row definitions that were defined outside of the direct content children of the table.
* These will be defined when, e.g., creating a wrapper around the cdkTable that has a
* built-in footer row as *its* content child.
*/
this._customFooterRowDefs = new Set();
/**
* Whether the header row definition has been changed. Triggers an update to the header row after
* content is checked. Initialized as true so that the table renders the initial set of rows.
*/
this._headerRowDefChanged = true;
/**
* Whether the footer row definition has been changed. Triggers an update to the footer row after
* content is checked. Initialized as true so that the table renders the initial set of rows.
*/
this._footerRowDefChanged = true;
/**
* Cache of the latest rendered `RenderRow` objects as a map for easy retrieval when constructing
* a new list of `RenderRow` objects for rendering rows. Since the new list is constructed with
* the cached `RenderRow` objects when possible, the row identity is preserved when the data
* and row template matches, which allows the `IterableDiffer` to check rows by reference
* and understand which rows are added/moved/removed.
*
* Implemented as a map of maps where the first key is the `data: T` object and the second is the
* `CdkRowDef<T>` object. With the two keys, the cache points to a `RenderRow<T>` object that
* contains an array of created pairs. The array is necessary to handle cases where the data
* array contains multiple duplicate data objects and each instantiated `RenderRow` must be
* stored.
*/
this._cachedRenderRowsMap = new Map();
/**
* CSS class added to any row or cell that has sticky positioning applied. May be overriden by
* table subclasses.
*/
this.stickyCssClass = 'cdk-table-sticky';
this._multiTemplateDataRows = false;
// TODO(andrewseguin): Remove max value as the end index
// and instead calculate the view on init and scroll.
/**
* Stream containing the latest information on what rows are being displayed on screen.
* Can be used by the data source to as a heuristic of what data should be provided.
*
* \@docs-private
*/
this.viewChange = new BehaviorSubject({ start: 0, end: Number.MAX_VALUE });
if (!role) {
this._elementRef.nativeElement.setAttribute('role', 'grid');
}
this._document = _document;
this._isNativeHtmlTable = this._elementRef.nativeElement.nodeName === 'TABLE';
}
/**
* Tracking function that will be used to check the differences in data changes. Used similarly
* to `ngFor` `trackBy` 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, `index` and `item`.
* @return {?}
*/
get trackBy() {
return this._trackByFn;
}
/**
* @param {?} fn
* @return {?}
*/
set trackBy(fn) {
if (isDevMode() && fn != null && typeof fn !== 'function' && (/** @type {?} */ (console)) &&
(/** @type {?} */ (console.warn))) {
console.warn(`trackBy must be a function, but received ${JSON.stringify(fn)}.`);
}
this._trackByFn = fn;
}
/**
* The table's source of data, which can be provided in three ways (in order of complexity):
* - Simple data array (each object represents one table row)
* - Stream that emits a data array each time the array changes
* - `DataSource` object that implements the connect/disconnect interface.
*
* 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 `renderRows()` 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.
*
* When providing an Observable stream, the table will trigger an update automatically when the
* stream emits a new array of data.
*
* Finally, when providing a `DataSource` 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 `disconnect` function (may be useful for cleaning up any
* subscriptions registered during the connect process).
* @return {?}
*/
get dataSource() {
return this._dataSource;
}
/**
* @param {?} dataSource
* @return {?}
*/
set dataSource(dataSource) {
if (this._dataSource !== dataSource) {
this._switchDataSource(dataSource);
}
}
/**
* Whether to allow multiple rows per data object by evaluating which rows evaluate their 'when'
* predicate to true. If `multiTemplateDataRows` 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.
* @return {?}
*/
get multiTemplateDataRows() {
return this._multiTemplateDataRows;
}
/**
* @param {?} v
* @return {?}
*/
set multiTemplateDataRows(v) {
this._multiTemplateDataRows = coerceBooleanProperty(v);
// In Ivy if this value is set via a static attribute (e.g. <table multiTemplateDataRows>),
// this setter will be invoked before the row outlet has been defined hence the null check.
if (this._rowOutlet && this._rowOutlet.viewContainer.length) {
this._forceRenderDataRows();
}
}
/**
* @return {?}
*/
ngOnInit() {
this._setupStickyStyler();
if (this._isNativeHtmlTable) {
this._applyNativeTableSections();
}
// Set up the trackBy function so that it uses the `RenderRow` as its identity by default. If
// the user has provided a custom trackBy, return the result of that function as evaluated
// with the values of the `RenderRow`'s data and index.
this._dataDiffer = this._differs.find([]).create((/**
* @param {?} _i
* @param {?} dataRow
* @return {?}
*/
(_i, dataRow) => {
return this.trackBy ? this.trackBy(dataRow.dataIndex, dataRow.data) : dataRow;
}));
}
/**
* @return {?}
*/
ngAfterContentChecked() {
// Cache the row and column definitions gathered by ContentChildren and programmatic injection.
this._cacheRowDefs();
this._cacheColumnDefs();
// Make sure that the user has at least added header, footer, or data row def.
if (!this._headerRowDefs.length && !this._footerRowDefs.length && !this._rowDefs.length) {
throw getTableMissingRowDefsError();
}
// Render updates if the list of columns have been changed for the header, row, or footer defs.
this._renderUpdatedColumns();
// If the header row definition has been changed, trigger a render to the header row.
if (this._headerRowDefChanged) {
this._forceRenderHeaderRows();
this._headerRowDefChanged = false;
}
// If the footer row definition has been changed, trigger a render to the footer row.
if (this._footerRowDefChanged) {
this._forceRenderFooterRows();
this._footerRowDefChanged = false;
}
// If there is a data source and row definitions, connect to the data source unless a
// connection has already been made.
if (this.dataSource && this._rowDefs.length > 0 && !this._renderChangeSubscription) {
this._observeRenderChanges();
}
this._checkStickyStates();
}
/**
* @return {?}
*/
ngOnDestroy() {
this._rowOutlet.viewContainer.clear();
this._headerRowOutlet.viewContainer.clear();
this._footerRowOutlet.viewContainer.clear();
this._cachedRenderRowsMap.clear();
this._onDestroy.next();
this._onDestroy.complete();
if (isDataSource(this.dataSource)) {
this.dataSource.disconnect(this);
}
}
/**
* 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).
*
* 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.
* @return {?}
*/
renderRows() {
this._renderRows = this._getAllRenderRows();
/** @type {?} */
const changes = this._dataDiffer.diff(this._renderRows);
if (!changes) {
return;
}
/** @type {?} */
const viewContainer = this._rowOutlet.viewContainer;
changes.forEachOperation((/**
* @param {?} record
* @param {?} prevIndex
* @param {?} currentIndex
* @return {?}
*/
(record, prevIndex, currentIndex) => {
if (record.previousIndex == null) {
this._insertRow(record.item, (/** @type {?} */ (currentIndex)));
}
else if (currentIndex == null) {
viewContainer.remove((/** @type {?} */ (prevIndex)));
}
else {
/** @type {?} */
const view = (/** @type {?} */ (viewContainer.get((/** @type {?} */ (prevIndex)))));
viewContainer.move((/** @type {?} */ (view)), currentIndex);
}
}));
// Update the meta context of a row's context data (index, count, first, last, ...)
this._updateRowIndexContext();
// Update rows that did not get added/removed/moved but may have had their identity changed,
// e.g. if trackBy matched data on some property but the actual data reference changed.
changes.forEachIdentityChange((/**
* @param {?} record
* @return {?}
*/
(record) => {
/** @type {?} */
const rowView = (/** @type {?} */ (viewContainer.get((/** @type {?} */ (record.currentIndex)))));
rowView.context.$implicit = record.item.data;
}));
this.updateStickyColumnStyles();
}
/**
* Sets the header row definition to be used. Overrides the header row definition gathered by
* using `ContentChild`, if one exists. Sets a flag that will re-render the header row after the
* table's content is checked.
* \@docs-private
* @deprecated Use `addHeaderRowDef` and `removeHeaderRowDef` instead
* \@breaking-change 8.0.0
* @param {?} headerRowDef
* @return {?}
*/
setHeaderRowDef(headerRowDef) {
this._customHeaderRowDefs = new Set([headerRowDef]);
this._headerRowDefChanged = true;
}
/**
* Sets the footer row definition to be used. Overrides the footer row definition gathered by
* using `ContentChild`, if one exists. Sets a flag that will re-render the footer row after the
* table's content is checked.
* \@docs-private
* @deprecated Use `addFooterRowDef` and `removeFooterRowDef` instead
* \@breaking-change 8.0.0
* @param {?} footerRowDef
* @return {?}
*/
setFooterRowDef(footerRowDef) {
this._customFooterRowDefs = new Set([footerRowDef]);
this._footerRowDefChanged = true;
}
/**
* Adds a column definition that was not included as part of the content children.
* @param {?} columnDef
* @return {?}
*/
addColumnDef(columnDef) {
this._customColumnDefs.add(columnDef);
}
/**
* Removes a column definition that was not included as part of the content children.
* @param {?} columnDef
* @return {?}
*/
removeColumnDef(columnDef) {
this._customColumnDefs.delete(columnDef);
}
/**
* Adds a row definition that was not included as part of the content children.
* @param {?} rowDef
* @return {?}
*/
addRowDef(rowDef) {
this._customRowDefs.add(rowDef);
}
/**
* Removes a row definition that was not included as part of the content children.
* @param {?} rowDef
* @return {?}
*/
removeRowDef(rowDef) {
this._customRowDefs.delete(rowDef);
}
/**
* Adds a header row definition that was not included as part of the content children.
* @param {?} headerRowDef
* @return {?}
*/
addHeaderRowDef(headerRowDef) {
this._customHeaderRowDefs.add(headerRowDef);
this._headerRowDefChanged = true;
}
/**
* Removes a header row definition that was not included as part of the content children.
* @param {?} headerRowDef
* @return {?}
*/
removeHeaderRowDef(headerRowDef) {
this._customHeaderRowDefs.delete(headerRowDef);
this._headerRowDefChanged = true;
}
/**
* Adds a footer row definition that was not included as part of the content children.
* @param {?} footerRowDef
* @return {?}
*/
addFooterRowDef(footerRowDef) {
this._customFooterRowDefs.add(footerRowDef);
this._footerRowDefChanged = true;
}
/**
* Removes a footer row definition that was not included as part of the content children.
* @param {?} footerRowDef
* @return {?}
*/
removeFooterRowDef(footerRowDef) {
this._customFooterRowDefs.delete(footerRowDef);
this._footerRowDefChanged = true;
}
/**
* 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.
* @return {?}
*/
updateStickyHeaderRowStyles() {
/** @type {?} */
const headerRows = this._getRenderedRows(this._headerRowOutlet);
/** @type {?} */
const tableElement = (/** @type {?} */ (this._elementRef.nativeElement));
// Hide the thead element if there are no header rows. This is necessary to satisfy
// overzealous a11y checkers that fail because the `rowgroup` element does not contain
// required child `row`.
/** @type {?} */
const thead = tableElement.querySelector('thead');
if (thead) {
thead.style.display = headerRows.length ? '' : 'none';
}
/** @type {?} */
const stickyStates = this._headerRowDefs.map((/**
* @param {?} def
* @return {?}
*/
def => def.sticky));
this._stickyStyler.clearStickyPositioning(headerRows, ['top']);
this._stickyStyler.stickRows(headerRows, stickyStates, 'top');
// Reset the dirty state of the sticky input change since it has been used.
this._headerRowDefs.forEach((/**
* @param {?} def
* @return {?}
*/
def => def.resetStickyChanged()));
}
/**
* 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.
* @return {?}
*/
updateStickyFooterRowStyles() {
/** @type {?} */
const footerRows = this._getRenderedRows(this._footerRowOutlet);
/** @type {?} */
const tableElement = (/** @type {?} */ (this._elementRef.nativeElement));
// Hide the tfoot element if there are no footer rows. This is necessary to satisfy
// overzealous a11y checkers that fail because the `rowgroup` element does not contain
// required child `row`.
/** @type {?} */
const tfoot = tableElement.querySelector('tfoot');
if (tfoot) {
tfoot.style.display = footerRows.length ? '' : 'none';
}
/** @type {?} */
const stickyStates = this._footerRowDefs.map((/**
* @param {?} def
* @return {?}
*/
def => def.sticky));
this._stickyStyler.clearStickyPositioning(footerRows, ['bottom']);
this._stickyStyler.stickRows(footerRows, stickyStates, 'bottom');
this._stickyStyler.updateStickyFooterContainer(this._elementRef.nativeElement, stickyStates);
// Reset the dirty state of the sticky input change since it has been used.
this._footerRowDefs.forEach((/**
* @param {?} def
* @return {?}
*/
def => def.resetStickyChanged()));
}
/**
* 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.
* @return {?}
*/
updateStickyColumnStyles() {
/** @type {?} */
const headerRows = this._getRenderedRows(this._headerRowOutlet);
/** @type {?} */
const dataRows = this._getRenderedRows(this._rowOutlet);
/** @type {?} */
const footerRows = this._getRenderedRows(this._footerRowOutlet);
// Clear the left and right positioning from all columns in the table across all rows since
// sticky columns span across all table sections (header, data, footer)
this._stickyStyler.clearStickyPositioning([...headerRows, ...dataRows, ...footerRows], ['left', 'right']);
// Update the sticky styles for each header row depending on the def's sticky state
headerRows.forEach((/**
* @param {?} headerRow
* @param {?} i
* @return {?}
*/
(headerRow, i) => {
this._addStickyColumnStyles([headerRow], this._headerRowDefs[i]);
}));
// Update the sticky styles for each data row depending on its def's sticky state
this._rowDefs.forEach((/**
* @param {?} rowDef
* @return {?}
*/
rowDef => {
// Collect all the rows rendered with this row definition.
/** @type {?} */
const rows = [];
for (let i = 0; i < dataRows.length; i++) {
if (this._renderRows[i].rowDef === rowDef) {
rows.push(dataRows[i]);
}
}
this._addStickyColumnStyles(rows, rowDef);
}));
// Update the sticky styles for each footer row depending on the def's sticky state
footerRows.forEach((/**
* @param {?} footerRow
* @param {?} i
* @return {?}
*/
(footerRow, i) => {
this._addStickyColumnStyles([footerRow], this._footerRowDefs[i]);
}));
// Reset the dirty state of the sticky input change since it has been used.
Array.from(this._columnDefsByName.values()).forEach((/**
* @param {?} def
* @return {?}
*/
def => def.resetStickyChanged()));
}
/**
* Get the list of RenderRow objects to render according to the current list of data and defined
* row definitions. If the previous list already contained a particular pair, it should be reused
* so that the differ equates their references.
* @private
* @return {?}
*/
_getAllRenderRows() {
/** @type {?} */
const renderRows = [];
// Store the cache and create a new one. Any re-used RenderRow objects will be moved into the
// new cache while unused ones can be picked up by garbage collection.
/** @type {?} */
const prevCachedRenderRows = this._cachedRenderRowsMap;
this._cachedRenderRowsMap = new Map();
// For each data object, get the list of rows that should be rendered, represented by the
// respective `RenderRow` object which is the pair of `data` and `CdkRowDef`.
for (let i = 0; i < this._data.length; i++) {
/** @type {?} */
let data = this._data[i];
/** @type {?} */
const renderRowsForData = this._getRenderRowsForData(data, i, prevCachedRenderRows.get(data));
if (!this._cachedRenderRowsMap.has(data)) {
this._cachedRenderRowsMap.set(data, new WeakMap());
}
for (let j = 0; j < renderRowsForData.length; j++) {
/** @type {?} */
let renderRow = renderRowsForData[j];
/** @type {?} */
const cache = (/** @type {?} */ (this._cachedRenderRowsMap.get(renderRow.data)));
if (cache.has(renderRow.rowDef)) {
(/** @type {?} */ (cache.get(renderRow.rowDef))).push(renderRow);
}
else {
cache.set(renderRow.rowDef, [renderRow]);
}
renderRows.push(renderRow);
}
}
return renderRows;
}
/**
* Gets a list of `RenderRow<T>` for the provided data object and any `CdkRowDef` objects that
* should be rendered for this data. Reuses the cached RenderRow objects if they match the same
* `(T, CdkRowDef)` pair.
* @private
* @param {?} data
* @param {?} dataIndex
* @param {?=} cache
* @return {?}
*/
_getRenderRowsForData(data, dataIndex, cache) {
/** @type {?} */
const rowDefs = this._getRowDefs(data, dataIndex);
return rowDefs.map((/**
* @param {?} rowDef
* @return {?}
*/
rowDef => {
/** @type {?} */
const cachedRenderRows = (cache && cache.has(rowDef)) ? (/** @type {?} */ (cache.get(rowDef))) : [];
if (cachedRenderRows.length) {
/** @type {?} */
const dataRow = (/** @type {?} */ (cachedRenderRows.shift()));
dataRow.dataIndex = dataIndex;
return dataRow;
}
else {
return { data, rowDef, dataIndex };
}
}));
}
/**
* Update the map containing the content's column definitions.
* @private
* @return {?}
*/
_cacheColumnDefs() {
this._columnDefsByName.clear();
/** @type {?} */
const columnDefs = mergeQueryListAndSet(this._contentColumnDefs, this._customColumnDefs);
columnDefs.forEach((/**
* @param {?} columnDef
* @return {?}
*/
columnDef => {
if (this._columnDefsByName.has(columnDef.name)) {
throw getTableDuplicateColumnNameError(columnDef.name);
}
this._columnDefsByName.set(columnDef.name, columnDef);
}));
}
/**
* Update the list of all available row definitions that can be used.
* @private
* @return {?}
*/
_cacheRowDefs() {
this._headerRowDefs =
mergeQueryListAndSet(this._contentHeaderRowDefs, this._customHeaderRowDefs);
this._footerRowDefs =
mergeQueryListAndSet(this._contentFooterRowDefs, this._customFooterRowDefs);
this._rowDefs = mergeQueryListAndSet(this._contentRowDefs, this._customRowDefs);
// After all row definitions are determined, find the row definition to be considered default.
/** @type {?} */
const defaultRowDefs = this._rowDefs.filter((/**
* @param {?} def
* @return {?}
*/
def => !def.when));
if (!this.multiTemplateDataRows && defaultRowDefs.length > 1) {
throw getTableMultipleDefaultRowDefsError();
}
this._defaultRowDef = defaultRowDefs[0];
}
/**
* Check if the header, data, or footer rows have changed what columns they want to display or
* whether the sticky states have changed for the header or footer. If there is a diff, then
* re-render that section.
* @private
* @return {?}
*/
_renderUpdatedColumns() {
/** @type {?} */
const columnsDiffReducer = (/**
* @param {?} acc
* @param {?} def
* @return {?}
*/
(acc, def) => acc || !!def.getColumnsDiff());
// Force re-render data rows if the list of column definitions have changed.
if (this._rowDefs.reduce(columnsDiffReducer, false)) {
this._forceRenderDataRows();
}
// Force re-render header/footer rows if the list of column definitions have changed..
if (this._headerRowDefs.reduce(columnsDiffReducer, false)) {
this._forceRenderHeaderRows();
}
if (this._footerRowDefs.reduce(columnsDiffReducer, false)) {
this._forceRenderFooterRows();
}
}
/**
* Switch to the provided data source by resetting the data and unsubscribing from the current
* render change subscription if one exists. If the data source is null, interpret this by
* clearing the row outlet. Otherwise start listening for new data.
* @private
* @param {?} dataSource
* @return {?}
*/
_switchDataSource(dataSource) {
this._data = [];
if (isDataSource(this.dataSource)) {
this.dataSource.disconnect(this);
}
// Stop listening for data from the previous data source.
if (this._renderChangeSubscription) {
this._renderChangeSubscription.unsubscribe();
this._renderChangeSubscription = null;
}
if (!dataSource) {
if (this._dataDiffer) {
this._dataDiffer.diff([]);
}
this._rowOutlet.viewContainer.clear();
}
this._dataSource = dataSource;
}
/**
* Set up a subscription for the data provided by the data source.
* @private
* @return {?}
*/
_observeRenderChanges() {
// If no data source has been set, there is nothing to observe for changes.
if (!this.dataSource) {
return;
}
/** @type {?} */
let dataStream;
if (isDataSource(this.dataSource)) {
dataStream = this.dataSource.connect(this);
}
else if (this.dataSource instanceof Observable) {
dataStream = this.dataSource;
}
else if (Array.isArray(this.dataSource)) {
dataStream = observableOf(this.dataSource);
}
if (dataStream === undefined) {
throw getTableUnknownDataSourceError();
}
this._renderChangeSubscription = dataStream.pipe(takeUntil(this._onDestroy)).subscribe((/**
* @param {?} data
* @return {?}
*/
data => {
this._data = data || [];
this.renderRows();
}));
}
/**
* Clears any existing content in the header row outlet and creates a new embedded view
* in the outlet using the header row definition.
* @private
* @return {?}
*/
_forceRenderHeaderRows() {
// Clear the header row outlet if any content exists.
if (this._headerRowOutlet.viewContainer.length > 0) {
this._headerRowOutlet.viewContainer.clear();
}
this._headerRowDefs.forEach((/**
* @param {?} def
* @param {?} i
* @return {?}
*/
(def, i) => this._renderRow(this._headerRowOutlet, def, i)));
this.updateStickyHeaderRowStyles();
this.updateStickyColumnStyles();
}
/**
* Clears any existing content in the footer row outlet and creates a new embedded view
* in the outlet using the footer row definition.
* @private
* @return {?}
*/
_forceRenderFooterRows() {
// Clear the footer row outlet if any content exists.
if (this._footerRowOutlet.viewContainer.length > 0) {
this._footerRowOutlet.viewContainer.clear();
}
this._footerRowDefs.forEach((/**
* @param {?} def
* @param {?} i
* @return {?}
*/
(def, i) => this._renderRow(this._footerRowOutlet, def, i)));
this.updateStickyFooterRowStyles();
this.updateStickyColumnStyles();
}
/**
* Adds the sticky column styles for the rows according to the columns' stick states.
* @private
* @param {?} rows
* @param {?} rowDef
* @return {?}
*/
_addStickyColumnStyles(rows, rowDef) {
/** @type {?} */
const columnDefs = Array.from(rowDef.columns || []).map((/**
* @param {?} columnName
* @return {?}
*/
columnName => {
/** @type {?} */
const columnDef = this._columnDefsByName.get(columnName);
if (!columnDef) {
throw getTableUnknownColumnError(columnName);
}
return (/** @type {?} */ (columnDef));
}));
/** @type {?} */
const stickyStartStates = columnDefs.map((/**
* @param {?} columnDef
* @return {?}
*/
columnDef => columnDef.sticky));
/** @type {?} */
const stickyEndStates = columnDefs.map((/**
* @param {?} columnDef
* @return {?}
*/
columnDef => columnDef.stickyEnd));
this._stickyStyler.updateStickyColumns(rows, stickyStartStates, stickyEndStates);
}
/**
* Gets the list of rows that have been rendered in the row outlet.
* @param {?} rowOutlet
* @return {?}
*/
_getRenderedRows(rowOutlet) {
/** @type {?} */
const renderedRows = [];
for (let i = 0; i < rowOutlet.viewContainer.length; i++) {
/** @type {?} */
const viewRef = ((/** @type {?} */ ((/** @type {?} */ (rowOutlet.viewContainer.get(i))))));
renderedRows.push(viewRef.rootNodes[0]);
}
return renderedRows;
}
/**
* Get the matching row definitions that should be used for this row data. If there is only
* one row definition, it is returned. Otherwise, find the row definitions that has a when
* predicate that returns true with the data. If none return true, return the default row
* definition.
* @param {?} data
* @param {?} dataIndex
* @return {?}
*/
_getRowDefs(data, dataIndex) {
if (this._rowDefs.length == 1) {
return [this._rowDefs[0]];
}
/** @type {?} */
let rowDefs = [];
if (this.multiTemplateDataRows) {
rowDefs = this._rowDefs.filter((/**
* @param {?} def
* @return {?}
*/
def => !def.when || def.when(dataIndex, data)));
}
else {
/** @type {?} */
let rowDef = this._rowDefs.find((/**
* @param {?} def
* @return {?}
*/
def => def.when && def.when(dataIndex, data))) || this._defaultRowDef;
if (rowDef) {
rowDefs.push(rowDef);
}
}
if (!rowDefs.length) {
throw getTableMissingMatchingRowDefError(data);
}
return rowDefs;
}
/**
* Create the embedded view for the data row template and place it in the correct index location
* within the data row view container.
* @private
* @param {?} renderRow
* @param {?} renderIndex
* @return {?}
*/
_insertRow(renderRow, renderIndex) {
/** @type {?} */
const rowDef = renderRow.rowDef;
/** @type {?} */
const context = { $implicit: renderRow.data };
this._renderRow(this._rowOutlet, rowDef, renderIndex, context);
}
/**
* Creates a new row template in the outlet and fills it with the set of cell templates.
* Optionally takes a context to provide to the row and cells, as well as an optional index
* of where to place the new row template in the outlet.
* @private
* @param {?} outlet
* @param {?} rowDef
* @param {?} index
* @param {?=} context
* @return {?}
*/
_renderRow(outlet, rowDef, index, context = {}) {
// TODO(andrewseguin): enforce that one outlet was instantiated from createEmbeddedView
outlet.viewContainer.createEmbeddedView(rowDef.template, context, index);
for (let cellTemplate of this._getCellTemplates(rowDef)) {
if (CdkCellOutlet.mostRecentCellOutlet) {
CdkCellOutlet.mostRecentCellOutlet._viewContainer.createEmbeddedView(cellTemplate, context);
}
}
this._changeDetectorRef.markForCheck();
}
/**
* Updates the index-related context for each row to reflect any changes in the index of the rows,
* e.g. first/last/even/odd.
* @private
* @return {?}
*/
_updateRowIndexContext() {
/** @type {?} */
const viewContainer = this._rowOutlet.viewContainer;
for (let renderIndex = 0, count = viewContainer.length; renderIndex < count; renderIndex++) {
/** @type {?} */
const viewRef = (/** @type {?} */ (viewContainer.get(renderIndex)));
/** @type {?} */
const context = (/** @type {?} */ (viewRef.context));
context.count = count;
context.first = renderIndex === 0;
context.last = renderIndex === count - 1;
context.even = renderIndex % 2 === 0;
context.odd = !context.even;
if (this.multiTemplateDataRows) {
context.dataIndex = this._renderRows[renderIndex].dataIndex;
context.renderIndex = renderIndex;
}
else {
context.index = this._renderRows[renderIndex].dataIndex;
}
}
}
/**
* Gets the column definitions for the provided row def.
* @private
* @param {?} rowDef
* @return {?}
*/
_getCellTemplates(rowDef) {
if (!rowDef || !rowDef.columns) {
return [];
}
return Array.from(rowDef.columns, (/**
* @param {?} columnId
* @return {?}
*/
columnId => {
/** @type {?} */
const column = this._columnDefsByName.get(columnId);
if (!column) {
throw getTableUnknownColumnError(columnId);
}
return rowDef.extractCellTemplate(column);
}));
}
/**
* Adds native table sections (e.g. tbody) and moves the row outlets into them.
* @private
* @return {?}
*/
_applyNativeTableSections() {
/** @type {?} */
const documentFragment = this._document.createDocumentFragment();
/** @type {?} */
const sections = [
{ tag: 'thead', outlet: this._headerRowOutlet },
{ tag: 'tbody', outlet: this._rowOutlet },
{ tag: 'tfoot', outlet: this._footerRowOutlet },
];
for (const section of sections) {
/** @type {?} */
const element = this._document.createElement(section.tag);
element.setAttribute('role', 'rowgroup');
element.appendChild(section.outlet.elementRef.nativeElement);
documentFragment.appendChild(element);
}
// Use a DocumentFragment so we don't hit the DOM on each iteration.
this._elementRef.nativeElement.appendChild(documentFragment);
}
/**
* Forces a re-render of the data rows. Should be called in cases where there has been an input
* change that affects the evaluation of which rows should be rendered, e.g. toggling
* `multiTemplateDataRows` or adding/removing row definitions.
* @private
* @return {?}
*/
_forceRenderDataRows() {
this._dataDiffer.diff([]);
this._rowOutlet.viewContainer.clear();
this.renderRows();
this.updateStickyColumnStyles();
}
/**
* Checks if there has been a change in sticky states since last check and applies the correct
* sticky styles. Since checking resets the "dirty" state, this should only be performed once
* during a change detection and after the inputs are settled (after content check).
* @private
* @return {?}
*/
_checkStickyStates() {
/** @type {?} */
const stickyCheckReducer = (/**
* @param {?} acc
* @param {?} d
* @return {?}
*/
(acc, d) => {
return acc || d.hasStickyChanged();
});
// Note that the check needs to occur for every definition since it notifies the definition
// that it can reset its dirty state. Using another operator like `some` may short-circuit
// remaining definitions and leave them in an unchecked state.
if (this._headerRowDefs.reduce(stickyCheckReducer, false)) {
this.updateStickyHeaderRowStyles();
}
if (this._footerRowDefs.reduce(stickyCheckReducer, false)) {
this.updateStickyFooterRowStyles();
}
if (Array.from(this._columnDefsByName.values()).reduce(stickyCheckReducer, false)) {
this.updateStickyColumnStyles();
}
}
/**
* Creates the sticky styler that will be used for sticky rows and columns. Listens
* for directionality changes and provides the latest direction to the styler. Re-applies column
* stickiness when directionality changes.
* @private
* @return {?}
*/
_setupStickyStyler() {
/** @type {?} */
const direction = this._dir ? this._dir.value : 'ltr';
this._stickyStyler = new StickyStyler(this._isNativeHtmlTable, this.stickyCssClass, direction, this._platform.isBrowser);
(this._dir ? this._dir.change : observableOf())
.pipe(takeUntil(this._onDestroy))
.subscribe((/**
* @param {?} value
* @return {?}
*/
value => {
this._stickyStyler.direction = value;
this.updateStickyColumnStyles();
}));
}
}
CdkTable.decorators = [
{ type: Component, args: [{
selector: 'cdk-table, table[cdk-table]',
exportAs: 'cdkTable',
template: CDK_TABLE_TEMPLATE,
host: {
'class': 'cdk-table',
},
encapsulation: ViewEncapsulation.None,
// The "OnPush" status for the `MatTable` component is effectively a noop, so we are removing it.
// The view for `MatTable` consists entirely of templates declared in other views. As they are
// declared elsewhere, they are checked when their declaration points are checked.
// tslint:disable-next-line:validate-decorators
changeDetection: ChangeDetectionStrategy.Default
}] }
];
/** @nocollapse */
CdkTable.ctorParameters = () => [
{ type: IterableDiffers },
{ type: ChangeDetectorRef },
{ type: ElementRef },
{ type: String, decorators: [{ type: Attribute, args: ['role',] }] },
{ type: Directionality, decorators: [{ type: Optional }] },
{ type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] },
{ type: Platform }
];
CdkTable.propDecorators = {
trackBy: [{ type: Input }],
dataSource: [{ type: Input }],
multiTemplateDataRows: [{ type: Input }],
_rowOutlet: [{ type: ViewChild, args: [DataRowOutlet, { static: true },] }],
_headerRowOutlet: [{ type: ViewChild, args: [HeaderRowOutlet, { static: true },] }],
_footerRowOutlet: [{ type: ViewChild, args: [FooterRowOutlet, { static: true },] }],
_contentColumnDefs: [{ type: ContentChildren, args: [CdkColumnDef, { descendants: true },] }],
_contentRowDefs: [{ type: ContentChildren, args: [CdkRowDef, { descendants: true },] }],
_contentHeaderRowDefs: [{ type: ContentChildren, args: [CdkHeaderRowDef, {
descendants: true
},] }],
_contentFooterRowDefs: [{ type: ContentChildren, args: [CdkFooterRowDef, {
descendants: true
},] }]
};
if (false) {
/** @type {?} */
CdkTable.ngAcceptInputType_multiTemplateDataRows;
/**
* @type {?}
* @private
*/
CdkTable.prototype._document;
/**
* Latest data provided by the data source.
* @type {?}
* @protected
*/
CdkTable.prototype._data;
/**
* Subject that emits whe