Type of the column settings.
Type of the schema field.
The index of the active column which is first non-fixed column in the view (either on left or right depending on Grid alignment)
Index of active column or -1 if there is no space for scrollable columns (ie only space for fixed columns)
Specifies the number of pixels of the anchored column which have been scrolled off the view Changes to allow smooth scrolling
Specifies the number of pixels the column at the opposite end of the anchored column has off the view This value will be:
The row to goto for a page down.
Calculates the scroll anchor for a page left scroll action. Warning: NOT IMPLEMENTED
A new scroll anchor which can be used for page left scrolling or undefined if a left scroll operation is not possible.
Calculates the scroll anchor for a page right scroll action. Warning: NOT IMPLEMENTED
A new scroll anchor which can be used for page right scrolling or undefined if a right scroll operation is not possible.
The row to go to for a page up.
Gets the bounds of the canvas which contains the scrollable area.
A RevCornerRectangle representing the bounds of the scrollable canvas area, or undefined if scrolling is not possible.
Grid column coordinate.
Grid row coordinate.
Bounding rect of cell with the given coordinates.
The rendered row height at index
The rendered column width at index
Finds a cell at the specified canvas offset.
The x-coordinate of the canvas offset.
The y-coordinate of the canvas offset.
The cell at the specified canvas offset, or undefined if not found.
Finds a cell at the specified data point.
index of field column within grid
index of row within its subgrid within the grid
the subgrid to search within
the cell at the specified index, or undefined if not found
Finds a cell at the specified grid row and column.
index of active column within grid
index of row within its subgrid within the grid
the subgrid to search within
whether the pool can be recomputed (set to false if called from within animation frame)
the cell at the specified index, or undefined if not found
Finds a cell at the specified viewport row and column.
index of column within viewport
index of row within viewport
whether the pool can be recomputed (set to false if called from within animation frame)
the cell at the specified index, or undefined if not found
Get cell at offset position on canvas.
x position on canvas.
y position on canvas.
Cell at co-ordinate or undefined if none.
The number of columns in the view layout.
The array of columns in the view layout.
The array of columns in the view layout but restricted to readonly.
First scrollable column in view
Indicates whether the first (left most) scrollable column is displayed in view as much as possible.
true if the first scrollable column is maximally in the view, false otherwise.
Indicates whether the last (right most) scrollable column is displayed in view as much as possible.
true if the last scrollable column is maximally in the view, false otherwise.
Get the column index matching the provided active column index.
The grid column index.
The given column if in view or undefined if not.
Get the column in viewport with the provided field index.
The grid column index.
The column if found and in viewport, otherwise undefined.
Get the index of the column whose edge is closest to the coordinate at pixelX
The horizontal coordinate.
The column index under the coordinate at pixelX.
Indicates whether an active column is in view.
the column index
true if the column is in view, false otherwise.
Check if a field column is in viewport. A column will not be in viewport if it is either not active or scrolled out of view.
the column's field index
The last col was rendered (is in view)
Limit an active column index value to within the range of active column indices of columns that are scrollable.
The active column index to limit.
The passed activeColumnIndex if it is within the range of scrollable columns, or the active column index of the closest scrollable column or undefined if no scrollable columns are present.
A counter which increments every time the rows or columns are recomputed. Used to check whether a cell pool is valid.
Subgrid row index of the first scrollable row
Gets the index of the last row that can be scrolled to in the view. Ensures that vertical computations are performed outside of the animation frame before returning the value.
The index of the last scrollable row, or undefined if not available.
Gets the subgrid row index of the last scrollable row.
Ensures that vertical computations are up-to-date before accessing the value.
Returns undefined if there is no last scrollable row, otherwise returns the
corresponding subgrid row index.
The number of rows before/above the main subgrid in the view layout.
The number of rows in the view layout.
The array of rows in the view layout.
The array of rows in the view layout but restricted to readonly.
Get the row in viewport with the provided subgrid row index and subgrid.
The index of the row within the specified subgrid.
The subgrid to which the row belongs.
The given row if in viewport or undefined if not.
Check if a subgrid row is in view.
The index of the row (within a subgrid) to check.
The subgrid to check against.
true if the row is in view, otherwise false.
Limit a row index value to within the range of indices of rows that are scrollable.
The row index to limit.
The passed rowIndex if it is within the range of scrollable rows, or the index of the closest scrollable row or undefined if no scrollable rows are present.
Ensures that the specified cell is within the viewport. If its column or row is not currently in view, adjusts the viewport to bring them into view.
The index of the active column to ensure is in view.
The index of the row in main subgrid to ensure is in view.
If true, attempts to maximize the visibility of the column and row within the viewport.
true if the viewport start position was changed to bring the column or row into view; otherwise, false.
Ensures that the specified row index is within the viewport of the grid. If the row is within the fixed rows, no scrolling occurs. Otherwise, the method scrolls the grid to bring the row into view, considering whether the scrolling should be maximal (i.e., align the row at the top of the viewport) and handling edge cases where the viewport size is not an exact multiple of the row height.
The index of the row in the main subgrid to ensure in viewport.
If true, ensure the row is maximally in view; otherwise do not scroll if it is already partially in view.
true if scrolling was performed to bring the row into view; false otherwise.
Scrolls the viewport by the specified number of columns.
The number of columns to scroll (can be negative).
true if the viewport was scrolled; otherwise, false.
Scrolls the viewport by the specified number of columns and rows.
The number of columns to scroll (can be negative).
The number of rows to scroll (can be negative).
true if the viewport was scrolled; otherwise, false.
Index of active column that should be anchor
true if changed
Sets the column scroll anchor to its current limit. This will scroll the viewport as far as possible to the right.
Manages the visual layout of the grid, including the arrangement and sizing of rows and columns, scroll positions, and mapping between data and view coordinates.
See
View Layout Component 🗎