@graphty/graphty-element / index / Neighbor

Interface: Neighbor

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

One neighbor of a node.

Properties

edgeCount

readonly edgeCount: number

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

How many edges join the two along the direction followed, each counted once.

---

excludedBy?

readonly optional excludedBy?: object

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

Present when the neighbor is in the data but the session's visibility filter hides it. "filter" covers visibility.set() and visibility.setWindow() alike: the time window is part of the one visibility filter. Open: more kinds may be added.

kind

readonly kind: "filter"

---

name

readonly name: string

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

The value at data.knownFields.nodeLabelPath, as text, else String(node.id). Untrusted text from the data: render it as text, never as markup.

---

node

readonly node: NodeRecord

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

The neighbor's record, deep-frozen.

---

weight

readonly weight: number

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

The edges' combined weight. When NeighborPage.measuredBy is null the page counts edges, and this equals Neighbor.edgeCount.