Protected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected areaProtected Optional areaReadonly ariaThe IDs this table uses for ARIA references (prefix from the host id).
1.1.91
Readonly ariaTexts for screen readers (English defaults + tableOptions.ariaTexts).
1.1.91
Optional batchBatch edit of this table (pending values, shown in the cells) – created by TableScope.
1.1.96
Protected borderProtected borderProtected borderProtected borderOptional cellExcel-style editing of this table (the editor above the cell) – created by TableScope with
tableOptions.editing.
1.1.99
Protected Readonly cleanupProtected colProtected contentProtected contentContent pixels scrolled out at the top, i.e. the offset that is actually rendered (see adjustBody).
Protected contentProtected Optional debounceReadonly directionThe resolved writing direction of the table (TableOptionsIf.direction; "auto" is decided when the table
is built).
1.1.98
Protected Readonly domProtected draggingProtected draggingProtected draggingProtected editingOptional fillFill handle of this table – created by TableScope.
1.1.96
Protected Optional getProtected Optional getProtected Optional headerThe header cell with the keyboard focus (row, column of the cell's origin) – set by the arrow-up key in the
first body row, see TableScope. undefined: the focus is in the body (FocusModelIf).
Readonly hostProtected hoverProtected hoverOptional masterMaster/detail of this table (detail rows below master rows) – created by TableScope with
tableOptions.masterDetail.
1.1.97
Protected Optional mouseProtected Optional pendingExact content position requested by scrollToPixel() for a capped scroll height (see TableScope).
Optional rowRow drag of this table (drag handles, pointer and keyboard drag) – created by TableScope.
1.1.95
Protected scrollProtected scrollProtected scrollProtected scrollProtected scrollProtected Optional storesince 1.1.92 – no longer used, see TableStateService.
Protected storedReadonly tableReadonly tableReadonly tableThe overlay layer over the body ("Loading…", "No rows to show").
1.1.92
Optional tableCell formulas of this table – created by TableScope with tableOptions.cellFormulas (flat bodies).
1.1.99
Protected treeStatic maxMaximum height (px) of the scrollable content wrapper. Taller tables are scrolled proportionally (rendering is based on the scroll factor anyway): browsers clamp element heights (Chrome ~33.5 million px) and GPU rasterization loses precision long before (1px borders disappear and text jitters beyond ~16.7 million px). 8 million px keep sub-pixel precision.
Protected addProtected adjustProtected Adjusts the layout and positioning of the specified area in the table. This method is used internally and should not be called directly.
The identifier of the area to adjust (e.g. header, body, footer).
Optional yStart: number = 0The starting y-position for the layout adjustments.
Protected adjustProtected adjustProtected Adjusts the columns to fit the width of the row's parent element.
The parameters for adjusting the columns.
Protected adjustProtected adjustAdjusts the dragging column during a mouse move event.
The mouse move event.
The index of the source column.
Indicates if it's the first rendering of the dragging column.
Protected adjustAdjusts the position and size of the hover column based on the mouse move event.
The mouse move event object.
Protected adjustAdjusts the position and size of the hover row based on the mouse move event.
The mouse move event.
Protected adjustFits the width of a leading row number column (RowNumberColumnDef) to its largest number. Cheap on every render pass: only the text of the largest number is compared; it is measured (canvas) only when it changed.
true if the width changed (the containers must be adjusted)
1.1.93
Protected afterCalled at the end of every render pass (scroll, repaint). TableScope marks the scroll position of the table state as changed here (stored and reported debounced, see TableStateService).
1.1.92
Protected applyrole, aria-colindex, spans and aria-sort of a cell.
rowspan and colspan of the cell (≥ 1)
Protected applyProtected Applies CSS classes to an HTML element.
The HTML element to which CSS classes will be applied.
An object containing CSS class names as keys and boolean values indicating whether to apply or remove the class.
Protected applyrole="row" and aria-rowindex; body rows of a tree: level, position, expanded; row selection: selected.
Marks the scroll position as changed (it is stored with the table state, see TableStateService).
since 1.1.92 – the table does this after every render pass.
A client x coordinate (e.g. PointerEvent.clientX) as x in the host from the start of its padding box – the
coordinates in which the table positions everything (right-to-left: from the right edge).
x in client (viewport) coordinates
px from the start
1.1.98
Protected debounceProtected disposeCancels a pending debounced rendering and calls all renderer cleanup functions (e.g. unmounts framework components rendered into cells). Used by TableScope.destroy.
Protected drawProtected Draws big cells (rowspan and or colspan) in body/center
CellRange
X position in pixel for top left corner
Y position in pixel for top left corner
AreaModelIf
Parent div as HTMLDivElement
SideIdent (west,center,east)
Protected findProtected Finds the row index of an important rowspan cell in a given area model.
The area model to search in.
The current row index.
The current column index.
Protected getProtected getProtected getRow and column numbers for screen readers of the current render pass (computed at its start).
the counts
1.1.91
Protected getThe width that % and weight columns share: host width minus the fixed west columns and a vertical scroll bar.
Optional hostWidth: number = ...the width of the host element (default: its current client width)
the width in px (0 if the host has no width yet, e.g. while it is hidden)
The body cell at a point in host coordinates, clamped to the body (a point above the body = row 0, right of the columns = the last column …) – computed, not read from the DOM.
x relative to the host's padding box
y relative to the host's padding box
row and column index, [-1, -1] without rows or columns
1.1.96
The rectangle of a body cell in host coordinates (relative to the padding box of the host) – computed from the
row and column positions, also for cells that are not rendered – and the visible part of its area (clip…: the
body between header and footer, horizontally the fixed west/east area or the scrollable center).
display index
model index
the geometry
1.1.96
Protected getThe height of all body rows in px – the model's content height plus, in RenderScope, the heights of open detail rows (master/detail).
px
1.1.97
The positions of the body rows: prefix sums of the row heights (O(log n) lookups also for variable heights) plus the heights of open detail rows. Built lazily – again after invalidateRowLayout, a new body model or another row count.
the layout of the body rows
1.1.97
The top of a body row in content pixels: AreaModelIf.getYPosByRowIndex plus the heights of the open detail rows above it (master/detail).
display index
px from the top of the first body row
1.1.97
The visible body in client (viewport) coordinates – including fixed west/east columns, without the scroll bar – and the content pixels scrolled out at its top. Row drag computes the row under the pointer with it.
the geometry
1.1.95
Protected getName of a row checkbox: "Select row 5" (body) resp. "Select all rows" (header).
Protected getThe x position of a column relative to the host element: fixed west and east columns do not scroll.
model index of the column
x position of the column over all columns (getXPosByColumnIndex)
the left position in px
Protected getRetrieves the column widths of a table within a specified range.
The index of the first column to retrieve the width of.
The index of the last column to retrieve the width of.
An array containing the widths of the columns within the specified range.
Protected getProtected getThe DOM service of this table (all DOM access of the table goes through it).
the service
1.1.95
Index of the first column that is not a row number column: 1 behind a RowNumberColumnDef, otherwise 0.
The checkbox of showCheckboxWihoutExtraColumn and the tree arrow are bound to it.
0 or 1
1.1.93
Protected getProtected Returns a number value extracted from the specified attribute of the source element.
The source element from which to extract the attribute value.
The attribute key to extract the value from.
Protected getRetrieves the heights of rows within a specified range.
The index of the first row in the range.
The index of the last row in the range.
The area model.
Protected getScroll bar pixels per content pixel: 1, below 1 for a capped scroll height (isScrollHeightCapped).
the factor for scrollTop changes
1.1.95
Protected getProtected Retrieves the value of the specified attribute from the nearest ancestor element that has the attribute.
The source element from which to start searching for the nearest ancestor element.
The name of the attribute to retrieve.
The value of the specified attribute, or an empty string if the attribute is not found.
Protected getProtected hasProtected hideProtected hideProtected hideProtected initDrops cached, derived values of the area models (AreaModelIf.invalidateDerivedValues, e.g. the totals of an
AreaModelAggregateFooter) – called where data may have changed (filter, sorting, editing, updateCells,
the public tableApi.repaint() / repaintHard()), not on scrolling.
Optional change: DerivedValuesChangeIfthe changed rows of an edit or updateCells() (models may recompute less)
1.1.94
Protected isWhether the table runs from right to left (TableOptionsIf.direction).
true for "rtl" (also a resolved "auto")
1.1.98
True if the table content is taller than EleScope.maxScrollHeightInPx; then the scroll bar is scaled and scrollTop is no longer a content pixel position.
Protected measureWidth in px of a row number text: with the font and padding of a rendered number cell label; before the first
number cell exists with the font of the host and 6 px padding on each side (then approximate is true).
Digits are measured as "0" (tabular figures: all digits are as wide as the widest).
the width and whether it is approximate
Protected onCalled after the shown overlay changed (ARIA in TableScope).
previous and new overlay, its text
1.1.92
Protected removeRemoves the ARIA attributes the table has set on the host element (see initHostAria).
1.1.91
Protected renderRenders the content of a dragging column.
The geographic data of the column.
The y-coordinate of the rendered content.
Protected renderProtected rerenderRerenders the content of a table cell based on the given parameters.
Protected rerenderAfter updateCells() without a repaint: draws the rendered cells of a footer with cached totals again (only if the
footer implements AreaModelIf.invalidateDerivedValues, and not if the events changed the footer itself).
Protected rerenderProtected resetProtected restoreSets the height of the detail row behind one body row in the current row layout without building it again (a detail row was expanded or collapsed). Does nothing if the layout is outdated anyway.
display index of the master row
the detail height, 0 = none
true if the layout was updated, false if it is outdated (it is built again on the next access)
1.1.97
Remembers the text of the open in-cell editor (called on every input, see InputHandler) so that a repaint keeps it.
display row index of the edited cell
model column index
the editor element
1.1.99
Protected setSets (or with undefined removes) an ARIA attribute of the host and remembers the app's own value the first
time, so that removeHostAria can restore it (e.g. an aria-label the app set on an Angular host).
1.1.91
Protected setWrites a value without the column's editInputPipe (values copied inside the table are already converted – a pipe
that expects text could break them). All area models apply the pipe in setValue, so it is left out for the call.
Sets the horizontal scroll position of the body as distance from the start (see getViewportScrollLeft).
px from the start
1.1.98
Protected snapProtected Rounds a pixel offset to whole device pixels. The scroll offsets are derived from a scroll factor and are fractional; rows and cells placed at fractional positions render blurry text and 1px borders.
offset in CSS pixels
offset snapped to the device pixel grid
Protected storeUpdates the cells in the table with the provided values and optionally repaints all cells.
The array of events containing information about the cells to update.
Optional. If true, repaints all cells after updating. Defaults to false.
Protected updateShows the overlay that fits the body now (see TableOverlay.update) and reports a change to onOverlayChanged.
1.1.92
Area heights read once at the start of adjustAfterScrolling() (before the DOM is modified).