@graphty/graphty-element / index / NeighborOptions
Interface: NeighborOptions ​
Defined in: graphty-element/src/session/types.ts:362
Which neighbors of a node a SessionDataApi.neighbors page lists, how they are weighed, and in what order. Every field is optional.
Properties ​
direction? ​
readonlyoptionaldirection?:SelectionDirection
Defined in: graphty-element/src/session/types.ts:368
Which edges to follow: arriving ("in"), leaving ("out") or both ("all"), as the Neighborhood selection takes it. On an undirected graph all three are the same. Default "all".
limit? ​
readonlyoptionallimit?:number
Defined in: graphty-element/src/session/types.ts:388
The most rows the page holds; Infinity reads to the end. Default 100.
offset? ​
readonlyoptionaloffset?:number
Defined in: graphty-element/src/session/types.ts:386
The position of the page's first row in the ordered list. Default 0.
scope? ​
readonlyoptionalscope?:ScopeInput
Defined in: graphty-element/src/session/types.ts:378
Which neighbors are listed: any scope, such as "selection". Default "graph".
sort? ​
readonlyoptionalsort?:NeighborSort
Defined in: graphty-element/src/session/types.ts:384
The order. Absent: strongest first when the page has a weight (largest first for a strength, smallest first for a distance), else by name. Rows that sort equal keep the graph's own order.
weight? ​
readonlyoptionalweight?:WeightMeaning|null
Defined in: graphty-element/src/session/types.ts:376
The edge weight, as runs take it: the literal name of an edge column, and whether a larger value means a stronger tie ("strength", whose edges add up) or a longer one ("distance", whose shortest edge counts). An edge with no number there weighs 1, as in a run, and is counted in NeighborPage.missing. null counts edges. Absent, the weight the graph was loaded with, read as a strength; counts when it was loaded with none.