@guiexpert/table · TypeScript API

API reference

Every class, interface and option of the core – with examples that are compiled against the real code. The framework packages are thin wrappers around exactly this API.

Open the full reference → Learn it step by step All symbols A–Z

Where to start

The most important types, grouped like the reference. Each group links to the chapters of the training that use them.

Table & API

Create a table and control it.

  • TableScope – creates and runs a table in a host element
  • TableApi – scroll, sort, filter, copy, export, update cells
  • TableScope.destroy() – release a table (listeners, observers, renderers)
Training: First table · Web Component & CDN
Table model

From your data to a model.

Training: Array<T> → model · Array of arrays · Fixed columns
Area models

Header, body and footer – or a model of your own.

Training: TableModel & areas · Own AreaModel · Footer totals
Columns

Label, width, alignment, renderers, sorting, editing.

  • ColumnDef – new ColumnDef(…) and ColumnDef.create({ … })
  • ColumnDefIf – every field of a column
  • Size – px, % and weight widths – constants px0 … px500
Training: ColumnDef · Sorting
Options

Behaviour and look of a table.

Training: TableOptions · Persist state
Events, selection & keyboard

React to what the user does.

Training: Events & context menu · Selection & copy
Renderers & styling

How cells look.

Training: Cell renderers · Heatmap · Theming & dark mode
Trees, groups, export

The rest of the toolbox.

Training: Tree table · Header groups · Excel export · Live data