Class EleScope

Represents a store for HTML elements.

Hierarchy

Constructors

constructor

Properties

areaBodyCenter areaBodyCenterGeo areaBodyEast areaBodyEastGeo areaBodyWest areaBodyWestGeo areaFooterCenter areaFooterEast areaFooterWest areaHeaderCenter areaHeaderEast areaHeaderWest ariaIds borderFixedEast borderFixedWest borderFooterTop borderHeaderBottom contentDiv contentWrapperDiv direction dom draggingColumn hostElement hoverColumn hoverRow scrollTop scrollViewport tableModel tableOptions tableOverlay maxScrollHeightInPx

Methods

adjustAfterScrolling adjustContainersAndRows adjustDetailLayerBounds clientXToHostX getAreaChild getBodyContentHeight getViewportScrollLeft initHostAria isRtl removeHostAria resetSizeOfWrapperDiv restoreHostAriaAttribute setHostAriaAttribute setViewportScrollLeft updateOverlay

Constructors

constructor

Properties

Protected areaBodyCenter

areaBodyCenter: DivScope

Protected areaBodyCenterGeo

areaBodyCenterGeo: GeoData = ...

Protected areaBodyEast

areaBodyEast: DivScope

Protected areaBodyEastGeo

areaBodyEastGeo: GeoData = ...

Protected areaBodyWest

areaBodyWest: DivScope

Protected areaBodyWestGeo

areaBodyWestGeo: GeoData = ...

Protected areaFooterCenter

areaFooterCenter: DivScope

Protected areaFooterEast

areaFooterEast: DivScope

Protected areaFooterWest

areaFooterWest: DivScope

Protected areaHeaderCenter

areaHeaderCenter: DivScope

Protected areaHeaderEast

areaHeaderEast: DivScope

Protected areaHeaderWest

areaHeaderWest: DivScope

Readonly ariaIds

ariaIds: AriaIds

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

Since

1.1.91

Protected borderFixedEast

borderFixedEast: HTMLDivElement

Protected borderFixedWest

borderFixedWest: HTMLDivElement

Protected borderFooterTop

borderFooterTop: HTMLDivElement

Protected borderHeaderBottom

borderHeaderBottom: HTMLDivElement

Protected contentDiv

contentDiv: HTMLDivElement

Protected contentWrapperDiv

contentWrapperDiv: HTMLDivElement

Readonly direction

direction: ResolvedTableDirection

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

Since

1.1.98

Protected Readonly dom

dom: ConvenienceDomService

Protected draggingColumn

draggingColumn: HTMLDivElement

Readonly hostElement

hostElement: HTMLDivElement

Protected hoverColumn

hoverColumn: HTMLDivElement

Protected hoverRow

hoverRow: HTMLDivElement

Protected scrollTop

scrollTop: number = 0

scrollViewport

scrollViewport: HTMLDivElement

Readonly tableModel

tableModel: TableModelIf

Readonly tableOptions

tableOptions: TableOptionsIf

Readonly tableOverlay

tableOverlay: TableOverlay

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

Since

1.1.92

Static maxScrollHeightInPx

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

adjustAfterScrolling

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

    Returns void

adjustContainersAndRows

  • Adjusts the containers and rows of the table based on the current state.

    Returns void

Protected adjustDetailLayerBounds

  • 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

clientXToHostX

  • 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

Protected getAreaChild

Protected getBodyContentHeight

  • 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

getViewportScrollLeft

  • 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

Protected initHostAria

  • 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

isRtl

Protected removeHostAria

Protected resetSizeOfWrapperDiv

  • Protected

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

    Returns void

    Returns nothing.

Protected restoreHostAriaAttribute

  • 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

Protected setHostAriaAttribute

  • 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

setViewportScrollLeft

Protected updateOverlay

  • 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

Settings

Member Visibility

Theme

On This Page