1771 Technologies Logo

Grid API

ViewportApi

Defines methods for managing the viewport within Graphite Grid.

Properties

  • Name
    getScrollOverflowX
    Type
    () => ScrollOverflow
    Description

    Gets the current horizontal overflow setting of the viewport.

  • Name
    getScrollOverflowY
    Type
    () => ScrollOverflow
    Description

    Gets the current vertical overflow setting of the viewport.

  • Name
    getScrollX
    Type
    () => number
    Description

    Returns the current horizontal scroll position of the grid.

  • Name
    getScrollY
    Type
    () => number
    Description

    Returns the current vertical scroll position of the grid.

  • Name
    getViewport
    Type
    () => null | HTMLElement
    Description

    Gets the current viewport element used by Graphite Grid.

  • Name
    getViewportClientHeight
    Type
    () => number
    Description

    Returns the client height of the viewport.

  • Name
    getViewportClientWidth
    Type
    () => number
    Description

    Returns the client width of the viewport.

  • Name
    isRtl
    Type
    () => boolean
    Description

    Checks if the content is rendered in right-to-left direction.

  • Name
    scrollIntoView
    Type
    (params: ScrollIntoViewParams) => void
    Description

    Scrolls a specified row, column, or both into view.

  • Name
    setRtl
    Type
    (rtl: boolean) => void
    Description

    Sets the direction of content rendering to right-to-left or left-to-right.

  • Name
    setScrollOverflowX
    Type
    (overflow: ScrollOverflow) => void
    Description

    Sets the horizontal overflow setting of the viewport.

  • Name
    setScrollOverflowY
    Type
    (overflow: ScrollOverflow) => void
    Description

    Sets the vertical overflow setting of the viewport.

  • Name
    setViewport
    Type
    (element: null | HTMLElement) => void
    Description

    Sets the viewport element for Graphite Grid. This method is called by the renderer.