@graphty/graphty-element / index / NeighborPage
Interface: NeighborPage ​
Defined in: graphty-element/src/session/types.ts:427
A RecordPage of neighbors, plus what the numbers measured.
Extends ​
Properties ​
columns? ​
readonlyoptionalcolumns?: readonlyPageColumn[]
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 ?? [].
Inherited from ​
measuredBy ​
readonlymeasuredBy:WeightMeaning|null
Defined in: graphty-element/src/session/types.ts:429
The weight the rows were combined by, or null when every row's weight is an edge count.
missing ​
readonlymissing:number
Defined in: graphty-element/src/session/types.ts:434
How many EDGES walked (not neighbors) had no number at the weight column and so weighed 1, as in a run. 0 when measuredBy is null.
offset ​
readonlyoffset:number
Defined in: graphty-element/src/session/types.ts:235
The position of records[0] in the ordered list: the offset asked for.
Inherited from ​
records ​
readonlyrecords: readonlyNeighbor[]
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.
Inherited from ​
revision ​
readonlyrevision: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.
Inherited from ​
total ​
readonlytotal:number
Defined in: graphty-element/src/session/types.ts:237
How many records the whole ordered list holds.