pivotick v3.0.0

---

pivotick / GraphUI / NeighborsPanel

Interface: NeighborsPanel

Defined in: interfaces/GraphUI.ts:893

Represents the configuration for the neighbors panel in the graph UI's sidebar

Defines how to compute and display neighbors for nodes and edges.

Default

All neighbor for the chosen entity

Properties

enabled?

optional enabled: boolean

Defined in: interfaces/GraphUI.ts:899

Whether the sidebar shows a neighbours panel at all. false removes it and its separator — right for a graph whose edges say nothing worth listing.

Default

true

---

graph?

optional graph: NeighborsGraphOptions

Defined in: interfaces/GraphUI.ts:913

Options for the panel's neighbour graph, which otherwise draws with the main graph's render options.

Example

// Small plain nodes in the panel, never zoomed past 1×.
graph: { render: { nodeStyleMap: plainStyles, maxZoom: 1 }, layout: { radialGap: 80 } }

---

render?

optional render: string | HTMLElement | (element, ctx) => RenderResult

Defined in: interfaces/GraphUI.ts:905

Remarks

A returned string renders as plain text; return an HTMLElement to render HTML. May be async: the slot shows a placeholder until it resolves, and a result arriving after the selection moved on is dropped.