RowManager
Plugin

private

Virtual representation of the grid, using Row to represent rows. Plugs into Grid and exposes the following functions on grid itself:

let row = grid.getRowById(1);

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

appendRowBuffer : Number5

Number of rows to render below current viewport
fixedRowHeight : Boolean

Set to true to get a small performance boost in applications that uses fixed row height
prependRowBuffer : Number5

Number of rows to render above current viewport
rowHeight : Number

Default row height, assigned from Grid at construction (either from config rowHeight or CSS). Can be set from renderers

Has a corresponding runtime rowHeight property.

Properties

Properties are getters/setters or publicly accessible variables on this class

allHeightsKnown : Boolean

private

READONLY

Returns true if all rows have a known height. They do if all rows are visited, or if RowManager is configured with fixedRowHeight. If so, all tops can be calculated exactly, no guessing needed
rowOffsetHeight : Number

READONLY

Get actually used row height, which includes any border and might be an average if using variable row height.
totalHeight : Number

READONLY

Total estimated grid height (used for scroller)
bottomRow : Row

READONLY

Get the Row currently displayed furthest down.
firstVisibleRow : Row

READONLY

Get the topmost visible Row
lastVisibleRow : Row

READONLY

Get the last visible Row
rowHeight : Number

ON-OWNER

Set a fixed row height (can still be overridden by renderers) or get configured row height. Setting refreshes all rows

Has a corresponding rowHeight config.
rows : Row[]

READONLY

Get all Rows
topRow : Row

READONLY

Get the Row that is currently displayed at top.

Functions

Functions are methods available for calling on the class

calculateTop( index )

private

Calculates a row top from its data index. Uses known values from the height map, unknown are substituted with the average row height. When configured with fixedRowHeight, it will always calculate a correct value
clearKnownHeights( )

Invalidates all cached height and resets averageRowHeight and totalKnownHeight
getOffsetHeight( record )
: Number

private

Get the known or estimated offset height for the specified record id
getRowAt( y, localfalse )
: Row

Get the row at the specified Y coordinate, which is by default viewport-based.
insert( index, count, action )
: Promise

internal

ASYNC

Animate adding or removing rows to/from the rows array.
invalidateKnownHeight( records )

Invalidate cached height for a record. Removing it from totalKnownHeight and factoring it out of averageRowHeight.
onRecordIdChange( params )

private

Handles record id changes by updating the heightMap key and the Row's id.
refreshCell( record, columnId )
: Boolean

Refresh a single cell.
reinitialize( )
: Boolean

Releases all elements (not from dom), calculates how many are needed, creates those and renders
storeKnownHeight( id, height )

internal

Store supplied height using id as key in the height map. Called by Row when it gets its height. Keeps averageRowHeight and totalKnownHeight up to date. Ignored when configured with fixedRowHeight
getRecordCoords( recordOrId, localfalse, roughlyfalse )
: Rectangle

Returns top and bottom for rendered row or estimated coordinates for unrendered.
getRecordCoordsByIndex( recordIndex, localfalse )
: Rectangle

Returns top and bottom coordinates for specified row. If all heights are known, by for example using fixed row height, the top is calculated exactly. If not, the top is estimated based on the closest known row.
initWithHeight( height, isRenderingfalse )

private

Initializes the RowManager with Rows to fit specified height.
forEach( fn )

Calls a function for each Row
calculateRowCount( )

private

Calculates how many rows fit in the available height (view height)
getNextRow( indexOrRow )
: Row

Gets the Row following the specified Row (by index or object). Wraps around the end.
getRow( index )
: Row/undefined

Get the Row at a specified store index. Returns undefined if the row index is not rendered.
getRowById( recordOrId )
: Row/null

Get Row for specified record id
getRowFor( recordOrId )
: Row

Get a Row for either a record, a record id or an HTMLElement
getRowFromElement( element )
: Row/null

Get a Row from an HTMLElement
matchRowCount( )

private

Add or remove rows to fit row count
offsetRows( offset )

private

Calls offset() for each Row passing along offset parameter
displayRecordAtBottom( )
: Number

private

Moves a row from top to bottom and renders the corresponding record to it.
displayRecordAtTop( )
: Number

private

Moves a row from bottom to top and renders the corresponding record to it.
estimateTotalHeight( immediatefalse )
: Number

private

Estimates height needed to fit all rows, based on average row height. Also offsets rows if needed to not be above the reachable area of the view.
fillAbove( newTop )

private

Moves as many rows from the bottom to the top that are needed to fill to current scroll pos.
fillBelow( newTop )

private

Moves as many rows from the top to the bottom that are needed to fill to current scroll pos.
jumpToPosition( newScrollTop, forceRecordIndex )

private

Makes sure that specified record is displayed in view
refresh( )

Rerender all rows
renderFromRecord( record )

Renders from specified records row and down (used for example when collapsing a group, does not affect rows above).
renderFromRow( fromRow )

Renders from specified row and down (used for example when collapsing a group, does not affect rows above).
renderRows( rows )

Renders the passed array (or Set) of rows
returnToTop( )

Renders from the top of the grid, also resetting scroll to top. Used for example when collapsing all groups.
translateFromRow( fromRow )

private

Translates all rows after the specified row. Used when a single rows height is changed and the others should rearrange. (Called from Row#render)
updateRenderedRows( newScrollTop, forcefalse )
: Number

private

Handles virtual rendering (only visible rows + buffer are in dom) for rows
warpIfNeeded( )

private

Jumps to a position if it is far enough from current position. Otherwise does nothing.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

rowHeight

private

Triggered when the owning Grid's rowHeight is changed.
rowRowHeight

private

Triggered when an individual rendered Row has its height changed.

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onRowHeight

private

Called when the owning Grid's rowHeight is changed.
onRowRowHeight

private

Called when an individual rendered Row has its height changed.

Source path

Grid/row/RowManager.js

Inheritance tree1

RowManager

RowManager Plugin private