Represents a store for HTML elements.

Hierarchy

Constructors

Properties

areaBodyCenter: DivScope
areaBodyCenterGeo: GeoData = ...
areaBodyEast: DivScope
areaBodyEastGeo: GeoData = ...
areaBodyWest: DivScope
areaBodyWestGeo: GeoData = ...
areaFooterCenter: DivScope
areaFooterEast: DivScope
areaFooterWest: DivScope
areaHeaderCenter: DivScope
areaHeaderEast: DivScope
areaHeaderWest: DivScope
ariaIds: AriaIds

The IDs this table uses for ARIA references (prefix from the host id).

Since

1.1.91

borderFixedEast?: HTMLDivElement
borderFixedWest?: HTMLDivElement
borderFooterTop?: HTMLDivElement
borderHeaderBottom?: HTMLDivElement
contentDiv: HTMLDivElement
contentWrapperDiv: HTMLDivElement

The resolved writing direction of the table (TableOptionsIf.direction; "auto" is decided when the table is built).

Since

1.1.98

draggingColumn: HTMLDivElement
horizontalScrollBarHeight: number = 0

Height of the horizontal scroll bar of scrollViewport in px, measured in adjustContainersAndRows. 0 without a horizontal scroll bar and with overlay scroll bars (macOS default, mobile) – they take no space.

hostElement: HTMLDivElement
hoverColumn: HTMLDivElement
hoverRow: HTMLDivElement
scrollTop: number = 0
scrollViewport: HTMLDivElement
tableModel: TableModelIf
tableOptions: TableOptionsIf
tableOverlay: TableOverlay

The overlay layer over the body ("Loading…", "No rows to show").

Since

1.1.92

verticalScrollBarWidth: number = 0

Width of the vertical scroll bar of scrollViewport in px (at the end of the rows: right, in right-to-left on the left), measured in adjustContainersAndRows. 0 without one and with overlay scroll bars.

maxScrollHeightInPx: number = 8_000_000

Maximum height (px) of the scrollable content wrapper. Taller tables are scrolled proportionally (rendering is based on the scroll factor anyway): browsers clamp element heights (Chrome ~33.5 million px) and GPU rasterization loses precision long before (1px borders disappear and text jitters beyond ~16.7 million px). 8 million px keep sub-pixel precision.

Methods

  • Adjusts the position or appearance of elements after scrolling. This method must be overwritten in child classes.

    Returns void

  • Position and size of the detail layer (master/detail) in the host – overwritten in RenderScope.

    Parameters

    • _left: number
    • _top: number
    • _width: number
    • _height: number

    Returns void

    Since

    1.1.97

  • A client x coordinate (e.g. PointerEvent.clientX) as x in the host from the start of its padding box – the coordinates in which the table positions everything (right-to-left: from the right edge).

    Parameters

    • clientX: number

      x in client (viewport) coordinates

    Returns number

    px from the start

    Since

    1.1.98

  • The height of all body rows in px – the model's content height plus, in RenderScope, the heights of open detail rows (master/detail).

    Returns number

    px

    Since

    1.1.97

  • The width the table lays out header, body and footer in: the host width minus a vertical scroll bar that takes space (see verticalScrollBarWidth). A logical width – in right-to-left the bar is on the left.

    Returns number

    px

    Since

    1.1.104

  • The horizontal scroll position of the body as distance from the start (≥ 0) – scrollLeft, in right-to-left -scrollLeft.

    Returns number

    px

    Since

    1.1.98

  • Sets the static ARIA attributes of the host element: role="grid" (a tree body: "treegrid") and its name and description from the table options. Counts and the active cell follow with every render pass.

    Returns void

    Since

    1.1.91

  • Lays out the scroll viewport, the nine areas, the separator borders, the overlay and the detail layer for the current size of the host and the current padding – without rendering the rows (that is adjustAfterScrolling). repaintHard() uses it to set a new scroll position before its one render pass.

    Returns void

    Since

    1.1.107

  • Height of the horizontal scroll bar of the scroll viewport: offsetHeight − clientHeight (the viewport has no border, see the constructor).

    Returns number

  • Width of the vertical scroll bar of the scroll viewport: offsetWidth − clientWidth.

    Returns number

  • Protected

    Resets the size of the wrapper div based on the content dimensions.

    Returns void

    Returns nothing.

  • Gives an ARIA attribute of the host back the value it had before the table changed it (e.g. aria-busy after loading), or removes it if the host had none.

    Parameters

    • key: string

    Returns void

    Since

    1.1.92

  • Sets (or with undefined removes) an ARIA attribute of the host and remembers the app's own value the first time, so that removeHostAria can restore it (e.g. an aria-label the app set on an Angular host).

    Parameters

    • key: string
    • value: undefined | string

    Returns void

    Since

    1.1.91

  • Shows the overlay that fits the current state (requested by the API, or "no rows" for an empty body). Overwritten in RenderScope.

    Returns void

    Since

    1.1.92