Graphty

Appearance

@graphty/graphty-element / session / RecordPage

Interface: RecordPage<TRecord> ​

Defined in: graphty-element/src/session/types.ts:231

One window onto an ordered list of records.

Extended by ​

Type Parameters ​

TRecord ​

TRecord

Properties ​

columns? ​

readonly optional columns?: readonly PageColumn[]

Defined in: graphty-element/src/session/types.ts:251

The result columns, in the order asked for; present exactly when columns was given, and typed as present then, so a page read with columns needs no ?? [].

offset ​

readonly offset: number

Defined in: graphty-element/src/session/types.ts:235

The position of records[0] in the ordered list: the offset asked for.

records ​

readonly records: readonly TRecord[]

Defined in: graphty-element/src/session/types.ts:233

The records, deep-frozen; at most limit of them, fewer at the end of the list.

revision ​

readonly revision: string

Defined in: graphty-element/src/session/types.ts:246

Changes whenever anything a page could show may have changed: a record added, removed or edited, an undo, a load, the selection or a set's members. A page held under one revision is stale once SessionDataApi.nodePage answers another. Opaque: compare it, do not parse it. A run publishing or clearing its result, or being removed, moves it too. It is the session's, not the page's: every page read at the same moment carries the same revision, whatever its options, so nodePage({ limit: 0 }) asks cheaply whether anything changed.

total ​

readonly total: number

Defined in: graphty-element/src/session/types.ts:237

How many records the whole ordered list holds.