Class OverlayOptions

The defaults of OverlayOptionsIf: English texts, an automatic "No rows to show", a loading overlay that blocks the body and appears right away.

Example

const overlayOptions = OverlayOptions.create({ noRowsText: "Keine Daten" });
console.log(overlayOptions.loadingText); // "Loading…"

Since

1.1.92

Hierarchy

  • OverlayOptions

Implements

Constructors

constructor

Properties

autoNoRows blockInteractionWhileLoading getOverlayElement? loadingDelayInMs loadingText noMatchesText noRowsText

Methods

create

Constructors

constructor

Properties

autoNoRows

autoNoRows: boolean = true

true (default): an empty body shows "No rows to show" (or "No matching rows") by itself, after every repaint. false: only TableApi.showNoRowsOverlay shows it.

blockInteractionWhileLoading

blockInteractionWhileLoading: boolean = true

true (default): while "Loading…" is shown, the table ignores mouse events on the body (click, double click, hover, context menu – the page still sees them) and the keyboard cannot start editing or toggle rows in the body; navigation, copying and the header still work. false: the loading overlay is only a picture, the table stays usable. "No rows" / "No matching rows" never block.

Optional getOverlayElement

getOverlayElement?: ((kind, text) => undefined | HTMLElement) = undefined

Type declaration

    • (kind, text): undefined | HTMLElement

    • Parameters

      Returns undefined | HTMLElement

loadingDelayInMs

loadingDelayInMs: number = 0

Waits this long (ms) before the loading overlay appears. Answers that come faster show no spinner at all (no flashing); meanwhile an automatic "No rows to show" stays as it is. Default: 0 (right away).

loadingText

loadingText: string = "Loading…"

Text of the loading overlay. Default: "Loading…".

noMatchesText

noMatchesText: string = "No matching rows"

Text when the external filter hides all rows. Default: "No matching rows".

noRowsText

noRowsText: string = "No rows to show"

Text of the overlay of an empty body. Default: "No rows to show".

Methods

Static create

Settings

Member Visibility

Theme

On This Page