RowManager

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);

Configs

appendRowBuffer: Number= 5

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: Number= 5

Number of rows to render above current viewport

rowHeight: NumberAlso a property

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

Properties

Calculations

totalHeight: Numberreadonly

Total estimated grid height (used for scroller)

Other

rowOffsetHeight: Numberreadonly

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

Rows

bottomRow: Rowreadonly

Get the Row currently displayed furthest down.

firstVisibleRow: Rowreadonly

Get the topmost visible Row

lastVisibleRow: Rowreadonly

Get the last visible Row

rowHeight: NumberAlso a config

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

rows: Row[]readonly

Get all Rows

topRow: Rowreadonly

Get the Row that is currently displayed at top.

Functions

Calculations

getRecordCoords

Returns top and bottom for rendered row or estimated coordinates for unrendered.

Parameter	Type	Description
`recordOrId`	Model \| String \| Number	Record or record id
`local`	Boolean	Pass true to get relative record coordinates
`roughly`	Boolean	Pass true to allow a less exact but cheaper estimate

Returns: Rectangle -

Record bounds with format { x, y, width, height, bottom, right }

getRecordCoordsByIndex

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.

Parameter	Type	Description
`recordIndex`	Number	Record index
`local`	Boolean

Returns: Rectangle -

Estimated record bounds

Iteration

forEach

Calls a function for each Row

Parameter	Type	Description
`fn`	function	Function that will be called with Row as first parameter

Other

clearKnownHeights

Invalidates all cached height and resets averageRowHeight and totalKnownHeight

getRowAt

Get the row at the specified Y coordinate, which is by default viewport-based.

Parameter	Type	Description
`y`	Number	The `Y` coordinate to find the Row for.
`local`	Boolean	Pass `true` if the `Y` coordinate is local to the SubGrid's element.

Returns: Row -

Found Row or null if no row is rendered at that point.

invalidateKnownHeight

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

Parameter	Type	Description
`records`	Model \| Model[]

refreshCell

Refresh a single cell.

Parameter	Type	Description
`record`	Model	Record for row holding the cell that should be updated
`columnId`	String \| Number	Column id to identify the cell within the row

Returns: Boolean -

Returns true if cell was found and refreshed, false if not

reinitialize

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

Rows

getNextRow

Gets the Row following the specified Row (by index or object). Wraps around the end.

Parameter	Type	Description
`indexOrRow`	Number \| Row	index or Row

Returns: Row

getRow

Get the Row at a specified store index. Returns undefined if the row index is not rendered.

Parameter	Type	Description
`index`	Number

Returns: Row | undefined

getRowById

Get Row for specified record id

Parameter	Type	Description
`recordOrId`	Model \| String \| Number	Record id (or a record)

Returns: Row | null -

Found Row or null if record not rendered

getRowFor

Get a Row for either a record, a record id or an HTMLElement

Parameter	Type	Description
`recordOrId`	HTMLElement \| Model \| String \| Number	Record or record id or HTMLElement

Returns: Row -

Found Row or null if record not rendered

getRowFromElement

Get a Row from an HTMLElement

Parameter	Type	Description
`element`	HTMLElement

Returns: Row | null -

Found Row or null if record not rendered

Scrolling & rendering

refresh

Rerender all rows

renderFromRecord

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

Parameter	Type	Description
`record`	Model	Record of first row to render

renderFromRow

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

Parameter	Type	Description
`fromRow`	Row	First row to render

renderRows

Renders the passed array (or Set) of rows

Parameter	Type	Description
`rows`	Row[] \| Set	The rows to render

returnToTop

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