RevGrid - v0.10.0
    Preparing search index...

    Class RevViewLayout<BGS, BCS, SF>

    Type Parameters

    Implements

    Index

    Properties

    clientId internalParent

    Accessors

    columnCount columnRowCellPoolComputationInvalid columns columnScrollAnchorIndex columnScrollAnchorOffset columnsViewWidth firstScrollableActiveColumnIndex firstScrollableColumn firstScrollableColumnIndex firstScrollableColumnLeftOverflow firstScrollableRowIndex firstScrollableRowViewTop firstScrollableSubgridRowIndex firstScrollableVisibleColumnMaximallyVisible fixedColumnsViewWidth lastScrollableActiveColumnIndex lastScrollableColumn lastScrollableColumnIndex lastScrollableColumnRightOverflow lastScrollableRowIndex lastScrollableRowSubgridRowIndex lastScrollableVisibleColumnMaximallyVisible preMainRowCount rowColumnCellPoolComputationInvalid rowCount rows rowsColumnsComputationId rowScrollAnchorIndex scrollableCanvasBounds scrollableCanvasLeft scrollableColumnCount scrollableColumnsViewWidth scrollableRowCount uiControlTracking unanchoredColumnOverflow

    Methods

    beginUiControlTracking calculatePageDownRowAnchor calculatePageLeftColumnAnchor calculatePageRightColumnAnchor calculatePageUpRowAnchor endUiControlTracking ensureColumnIsInView ensureColumnRowAreInView ensureRowIsInView findCellAtCanvasOffset findCellAtDataPoint findCellAtGridPoint findCellAtViewpointIndex findColumnIndexOfCanvasOffset findColumnWithActiveIndex findColumnWithFieldIndex findFullyVisibleColumnWithActiveIndex findIndexOfScrollableColumnClosestToCanvasOffset findIndexOfScrollableRowClosestToOffset findLeftGridLineInclusiveColumnIndexOfCanvasOffset findLeftGridLineInclusiveColumnOfCanvasOffset findLinedHoverCellAtCanvasOffset findRowIndexOfCanvasOffset findRowWithSubgridRowIndex findScrollableCellClosestToCanvasOffset findTopGridLineInclusiveRowIndexOfCanvasOffset findTopGridLineInclusiveRowOfCanvasOffset getActiveColumnWidthEdgeClosestToPixelX getBoundsOfCell getColumnRowOrderedCellPool getColumnsCount getRenderedHeight getRenderedWidth getRowColumnOrderedCellPool getRowsCount getScrollTop getVisibleCellMatrix getVisibleDataRow getVisibleRow invalidateAll invalidateHorizontalAll invalidateVerticalAll isActiveColumnFullyVisible isActiveColumnVisible isDataColumnVisible isDataRowVisible isLastColumnVisible isRowVisible limitActiveColumnIndexToView limitRowIndexToView resetAllCellPaintFingerprints resetAllCellPropertiesCaches scrollColumnsBy scrollColumnsRowsBy scrollHorizontalViewportBy scrollRowsBy scrollVerticalViewportBy setColumnScrollAnchor setColumnScrollAnchorToLimit setHorizontalViewportStart setRowScrollAnchor setRowScrollAnchorToLimit setVerticalViewportStart tryGetColumnWithFieldIndex

    Properties

    clientId: string

    A unique string allowing you to identify different instances

    internalParent: RevClientObject

    The parent of an object allowing you to easily navigate during debugging

    Accessors

    • get columnCount(): number

      Returns number

    • get columnRowCellPoolComputationInvalid(): boolean

      Returns boolean

    • get columnScrollAnchorIndex(): number

      The index of the active column which is first in view (either on left or right depending on Grid alignment)

      Returns number

    • get columnScrollAnchorOffset(): number

      The number of pixels that the scroll anchored column is offset. Changes to allow smooth scrolling

      Returns number

    • get columnsViewWidth(): number

      Returns number

    • get firstScrollableActiveColumnIndex(): undefined | number

      Returns undefined | number

    • get firstScrollableColumnIndex(): undefined | number

      Returns undefined | number

    • get firstScrollableColumnLeftOverflow(): undefined | number

      Returns undefined | number

    • get firstScrollableRowIndex(): undefined | number

      Returns undefined | number

    • get firstScrollableRowViewTop(): undefined | number

      Returns undefined | number

    • get firstScrollableSubgridRowIndex(): undefined | number

      Returns undefined | number

    • get firstScrollableVisibleColumnMaximallyVisible(): boolean

      Returns boolean

    • get fixedColumnsViewWidth(): number

      Returns number

    • get lastScrollableActiveColumnIndex(): undefined | number

      Returns undefined | number

    • get lastScrollableColumnIndex(): undefined | number

      Returns undefined | number

    • get lastScrollableColumnRightOverflow(): undefined | number

      Returns undefined | number

    • get lastScrollableRowIndex(): undefined | number

      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.

      Returns undefined | number

      The index of the last scrollable row, or undefined if not available.

    • get lastScrollableRowSubgridRowIndex(): undefined | number

      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.

      Returns undefined | number

    • get lastScrollableVisibleColumnMaximallyVisible(): boolean

      Returns boolean

    • get preMainRowCount(): number

      Returns number

    • get rowColumnCellPoolComputationInvalid(): boolean

      Returns boolean

    • get rowCount(): number

      Returns number

    • get rowsColumnsComputationId(): number

      Returns number

    • get rowScrollAnchorIndex(): number

      Returns number

    • get scrollableCanvasLeft(): number

      Returns number

    • get scrollableColumnCount(): number

      Returns number

    • get scrollableColumnsViewWidth(): number

      Returns number

    • get scrollableRowCount(): number

      Returns number

    • get uiControlTracking(): boolean

      Returns boolean

    • get unanchoredColumnOverflow(): undefined | number

      Returns undefined | number

    Methods

    • Returns void

    • Returns void

    • Parameters

      • activeColumnIndex: number
      • maximally: boolean

      Returns boolean

    • Ensures that both the specified column and row are visible within the viewport. If either the column or row is not currently in view, adjusts the viewport to bring them into view.

      Parameters

      • activeColumnIndex: number

        The index of the active column to ensure is visible.

      • mainSubgridRowIndex: number

        The index of the row in main subgrid to ensure is visible.

      • maximally: boolean

        If true, attempts to maximize the visibility of the column and row within the viewport.

      Returns boolean

      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 visible 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.

      Parameters

      • mainSubgridRowIndex: number

        The index of the row in the main subgrid to ensure is visible.

      • maximally: boolean

        If true, ensure the row is fully in view; otherwise do not scroll if it is already partially visible.

      Returns boolean

      true if scrolling was performed to bring the row into view; false otherwise.

      If the scrollable row indices are inconsistent.

    • Parameters

      • activeColumnIndex: number
      • subgridRowIndex: number
      • subgrid: RevSubgrid<BCS, SF>
      • canComputePool: boolean

      Returns undefined | RevViewCell<BCS, SF>

    • Parameters

      • viewportColumnIndex: number
      • viewportRowIndex: number
      • canComputePool: boolean

      Returns RevViewCell<BCS, SF>

    • Parameters

      • canvasOffsetX: number

      Returns number

    • Get the "visible column" object matching the provided grid column index.

      Parameters

      • activeColumnIndex: number

        The grid column index.

      Returns undefined | RevViewLayoutColumn<BCS, SF>

      The given column if visible or undefined if not.

      Requested column may not be visible due to being scrolled out of view. Find a visible column object.

    • Parameters

      • canvasOffsetX: number

      Returns number

    • Parameters

      • y: number

      Returns number

    • Parameters

      • canvasOffsetX: number

      Returns number

    • Get cell at offset position on canvas.

      Parameters

      • canvasXOffset: number

        x position on canvas.

      • canvasYOffset: number

        y position on canvas.

      Returns undefined | RevLinedHoverCell<BCS, SF>

      Cell at co-ordinate or undefined if none.

    • Parameters

      • canvasOffsetY: number

      Returns number

    • Parameters

      • canvasOffsetX: number
      • canvasOffsetY: number

      Returns undefined | RevViewCell<BCS, SF>

    • Parameters

      • canvasOffsetY: number

      Returns number

    • the index of the column whose edge is closest to the coordinate at pixelX

      Parameters

      • pixelX: number

        The horizontal coordinate.

      Returns number

      The column index under the coordinate at pixelX.

    • Parameters

      • x: number

        Grid column coordinate.

      • y: number

        Grid row coordinate.

      Returns RevRectangle

      Bounding rect of cell with the given coordinates.

    • Returns number

      Number of columns we just rendered.

    • Parameters

      • index: number

      Returns number

      The rendered row height at index

    • Parameters

      • index: number

      Returns number

      The rendered column width at index

    • Returns number

      Answer how many rows we rendered

    • Returns number

      Current vertical scroll value.

    • Matrix of unformatted values of visible cells.

      Returns unknown[][]

    • Get the "visible row" object matching the provided data row index.

      Parameters

      • rowIndex: number

        The data row index within the given subgrid.

      • subgrid: RevSubgrid<BCS, SF>

      Returns undefined | RevViewLayoutRow<BCS, SF>

      The given row if visible or undefined if not.

      Requested row may not be visible due to being scrolled out of view. Find a visible row object.

    • Get the "visible row" object matching the provided grid row index.

      Parameters

      • rowIndex: number

        The grid row index.

      Returns RevViewLayoutRow<BCS, SF>

      The given row if visible or undefined if not.

      Requested row may not be visible due to being outside the bounds of the rendered grid. Find a visible row object.

    • Parameters

      • scrollDimensionAsWell: boolean

      Returns void

    • Parameters

      • scrollDimensionAsWell: boolean

      Returns void

    • Parameters

      • scrollDimensionAsWell: boolean

      Returns void

    • Parameters

      • activeColumnIndex: number

      Returns boolean

    • Get the visibility of the column matching the provided grid column index.

      Parameters

      • activeColumnIndex: number

        the column index

      Returns boolean

      The given column is visible.

      Requested column may not be visible due to being scrolled out of view. Determines if a column is visible.

    • Get the visibility of the column matching the provided data column index.

      Parameters

      • columnIndex: number

        the column index

      Returns boolean

      Requested column may not be visible due to being scrolled out of view or if the column is inactive. Determines if a column is visible.

    • Returns boolean

      The last col was rendered (is visible)

    • Get the visibility of the row matching the provided grid row index.

      Parameters

      • rowIndex: number

        The grid row index.

      Returns boolean

      The given row is visible.

      Requested row may not be visible due to being outside the bounds of the rendered grid. Determines visibility of a row.

    • Parameters

      • activeColumnIndex: number

      Returns undefined | number

    • Parameters

      • rowIndex: number

      Returns undefined | number

    • Returns void

    • Returns void

    • Parameters

      • scrollColumnCount: number

      Returns boolean

    • Parameters

      • columnCount: number
      • rowCount: number

      Returns boolean

    • Parameters

      • delta: number

      Returns void

    • Parameters

      • rowScrollCount: number

      Returns boolean

    • Parameters

      • delta: number

      Returns boolean

    • Parameters

      • activeColumnIndex: number

        Index of active column that should be anchor

      • offset: number

      Returns boolean

      true if changed

    • Returns void

    • Parameters

      • value: number

      Returns boolean

    • Parameters

      • index: number
      • offset: number

      Returns boolean

    • Returns void

    • Parameters

      • viewportStart: number

      Returns void

    • Get the "visible column" object matching the provided data column index.

      Parameters

      • columnIndex: number

        The grid column index.

      Returns undefined | RevViewLayoutColumn<BCS, SF>

      Requested column may not be visible due to being scrolled out of view or if the column is inactive. Find a visible column object.

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    columnCountcolumnRowCellPoolComputationInvalidcolumnscolumnScrollAnchorIndexcolumnScrollAnchorOffsetcolumnsViewWidthfirstScrollableActiveColumnIndexfirstScrollableColumnfirstScrollableColumnIndexfirstScrollableColumnLeftOverflowfirstScrollableRowIndexfirstScrollableRowViewTopfirstScrollableSubgridRowIndexfirstScrollableVisibleColumnMaximallyVisiblefixedColumnsViewWidthlastScrollableActiveColumnIndexlastScrollableColumnlastScrollableColumnIndexlastScrollableColumnRightOverflowlastScrollableRowIndexlastScrollableRowSubgridRowIndexlastScrollableVisibleColumnMaximallyVisiblepreMainRowCountrowColumnCellPoolComputationInvalidrowCountrowsrowsColumnsComputationIdrowScrollAnchorIndexscrollableCanvasBoundsscrollableCanvasLeftscrollableColumnCountscrollableColumnsViewWidthscrollableRowCountuiControlTrackingunanchoredColumnOverflow
    Methods
    beginUiControlTrackingcalculatePageDownRowAnchorcalculatePageLeftColumnAnchorcalculatePageRightColumnAnchorcalculatePageUpRowAnchorendUiControlTrackingensureColumnIsInViewensureColumnRowAreInViewensureRowIsInViewfindCellAtCanvasOffsetfindCellAtDataPointfindCellAtGridPointfindCellAtViewpointIndexfindColumnIndexOfCanvasOffsetfindColumnWithActiveIndexfindColumnWithFieldIndexfindFullyVisibleColumnWithActiveIndexfindIndexOfScrollableColumnClosestToCanvasOffsetfindIndexOfScrollableRowClosestToOffsetfindLeftGridLineInclusiveColumnIndexOfCanvasOffsetfindLeftGridLineInclusiveColumnOfCanvasOffsetfindLinedHoverCellAtCanvasOffsetfindRowIndexOfCanvasOffsetfindRowWithSubgridRowIndexfindScrollableCellClosestToCanvasOffsetfindTopGridLineInclusiveRowIndexOfCanvasOffsetfindTopGridLineInclusiveRowOfCanvasOffsetgetActiveColumnWidthEdgeClosestToPixelXgetBoundsOfCellgetColumnRowOrderedCellPoolgetColumnsCountgetRenderedHeightgetRenderedWidthgetRowColumnOrderedCellPoolgetRowsCountgetScrollTopgetVisibleCellMatrixgetVisibleDataRowgetVisibleRowinvalidateAllinvalidateHorizontalAllinvalidateVerticalAllisActiveColumnFullyVisibleisActiveColumnVisibleisDataColumnVisibleisDataRowVisibleisLastColumnVisibleisRowVisiblelimitActiveColumnIndexToViewlimitRowIndexToViewresetAllCellPaintFingerprintsresetAllCellPropertiesCachesscrollColumnsByscrollColumnsRowsByscrollHorizontalViewportByscrollRowsByscrollVerticalViewportBysetColumnScrollAnchorsetColumnScrollAnchorToLimitsetHorizontalViewportStartsetRowScrollAnchorsetRowScrollAnchorToLimitsetVerticalViewportStarttryGetColumnWithFieldIndex