pivotick v3.0.0

---

pivotick / Edge

Class: Edge

Defined in: Edge.ts:48

Represents an edge (connection) between two nodes in a graph.

Accessors

isSynthetic

Get Signature

get isSynthetic(): boolean

Defined in: Edge.ts:338

True for a stand-in: a line drawn for real edges whose ends are hidden in closed clusters.

Returns

boolean

---

source

Get Signature

get source(): Node

Defined in: Edge.ts:131

Required by d3-force

Returns

Node

---

target

Get Signature

get target(): Node

Defined in: Edge.ts:134

Returns

Node

Constructors

Constructor

new Edge(id, from, to, data?, style?, directed?): Edge

Defined in: Edge.ts:94

Create a new Edge instance.

Parameters

id

string

Unique identifier for the edge

from

Node

Source node

to

Node

Target node

data?

EdgeData

Optional data payload for the edge

style?

Partial<EdgeFullStyle>

Optional style for the edge

directed?

boolean | null

Returns

Edge

Methods

clearDirty()

clearDirty(): void

Defined in: Edge.ts:278

Returns

void

---

clone()

clone(): Edge

Defined in: Edge.ts:251

Returns

Edge

---

getData()

getData(): EdgeData

Defined in: Edge.ts:141

Get the edge's data.

Returns

EdgeData

---

getEdgeStyle()

getEdgeStyle(): Partial<EdgeStyle>

Defined in: Edge.ts:173

Get the edge's style.

Returns

Partial<EdgeStyle>

---

getGraphElement()

getGraphElement(): SVGGElement | null

Defined in: Edge.ts:210

Returns

SVGGElement | null

---

getLabelStyle()

getLabelStyle(): Partial<LabelStyle>

Defined in: Edge.ts:180

Get the edge's label style if available.

Returns

Partial<LabelStyle>

---

getSources()

getSources(): string[]

Defined in: Edge.ts:389

The sources vouching for this edge — pivot ids, plus 'seed' for data that was here to begin with. Which pivot asserted a relationship is the load-bearing half of provenance, so edges carry it exactly as nodes do.

Returns

string[]

---

getStyle()

getStyle(): Partial<EdgeFullStyle>

Defined in: Edge.ts:166

Get the edge's style.

Returns

Partial<EdgeFullStyle>

---

hasSource()

hasSource(source): boolean

Defined in: Edge.ts:394

Whether source vouches for this edge. 'seed' is true for un-pivoted data.

Parameters

source

string

Returns

boolean

---

hide()

hide(): void

Defined in: Edge.ts:300

Returns

void

---

isDirty()

isDirty(): boolean

Defined in: Edge.ts:282

Returns

boolean

---

markDirty()

markDirty(): void

Defined in: Edge.ts:274

Returns

void

---

setData()

setData(newData): void

Defined in: Edge.ts:149

Update the edge's data.

Parameters

newData

EdgeData

New data to set

Returns

void

---

setFrom()

setFrom(node): void

Defined in: Edge.ts:215

Parameters

node

Node

Returns

void

---

setLayerVisible()

setLayerVisible(layerVisible): boolean

Defined in: Edge.ts:309

Switch this edge's layer on or off, re-deriving visible from the other reasons it may already be hidden for. Returns whether anything changed.

Parameters

layerVisible

boolean

Returns

boolean

---

setStyle()

setStyle(newStyle): void

Defined in: Edge.ts:188

Update the edge's style.

Parameters

newStyle

EdgeFullStyle

New style to set

Returns

void

---

setTo()

setTo(node): void

Defined in: Edge.ts:219

Parameters

node

Node

Returns

void

---

show()

show(): void

Defined in: Edge.ts:295

Returns

void

---

toDict()

toDict(): Record<string, unknown>

Defined in: Edge.ts:226

Convert edge to a simple JSON object representation.

Returns

Record<string, unknown>

---

toggleVisibility()

toggleVisibility(visible): void

Defined in: Edge.ts:286

Parameters

visible

boolean

Returns

void

---

toSimulationDTO()

toSimulationDTO(): SimulationEdgeDTO

Defined in: Edge.ts:240

Structured-cloneable payload for the simulation worker; endpoints reduced to ids, keeps directed. The style is stripped of functions — see Node.toSimulationDTO.

Returns

SimulationEdgeDTO

---

updateData()

updateData(partialData): void

Defined in: Edge.ts:158

Merge partial data into the current edge data.

Parameters

partialData

Partial<EdgeData>

Partial data object to merge

Returns

void

---

updateStyle()

updateStyle(partialStyle): void

Defined in: Edge.ts:198

Merge partial style into the current edge style. Useful for updating only parts of the style.

Parameters

partialStyle

PartialEdgeFullStyle

Partial style object to merge

Returns

void

Properties

directed

readonly directed: boolean | null

Defined in: Edge.ts:52

---

domID

readonly domID: string

Defined in: Edge.ts:84

---

from

from: Node

Defined in: Edge.ts:50

---

id

readonly id: string

Defined in: Edge.ts:49

---

layerVisible

layerVisible: boolean

Defined in: Edge.ts:63

Whether this edge's layer is switched on. A veto over visible: every other reason an edge is hidden (endpoints filtered out, a collapsed cluster, a manual hide) is asserted through show / hide, and show cannot bring an edge back while its layer is off.

---

representedEdges?

optional representedEdges: Edge[]

Defined in: Edge.ts:75

For a stand-in: the real edges it speaks for. Edges landing on the same pair of dots share one line, so one stand-in can cover several relations of several kinds; it is filtered out only once every one of them is. Undefined on a real edge.

---

to

to: Node

Defined in: Edge.ts:51

---

visible

visible: boolean

Defined in: Edge.ts:56

---

visibleIgnoringLayer

visibleIgnoringLayer: boolean

Defined in: Edge.ts:69

What visible would be if every layer were on — i.e. visibility from the endpoint, collapse and manual reasons alone. The simulation gates on this rather than on visible, so switching a layer off never changes the layout.