Class Edge

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

Index

Accessors

source

get source(): Node
Required by d3-force

Returns Node
- Defined in Edge.ts:77

target

get target(): Node
Returns Node
- Defined in Edge.ts:80

Constructors

constructor

new Edge(
    id: string,
    from: Node,
    to: Node,
    data?: EdgeData,
    style?: Partial<EdgeFullStyle>,
    directed?: boolean | null,
    syntheticTerminalNode?: Node,
): Edge
Create a new Edge instance.
Parameters
- id: string
  Unique identifier for the edge
- from: Node
  Source node
- to: Node
  Target node
- Optionaldata: EdgeData
  Optional data payload for the edge
- Optionalstyle: Partial<EdgeFullStyle>
  Optional style for the edge
- directed: boolean | null = null
- OptionalsyntheticTerminalNode: Node
Returns Edge
- Defined in Edge.ts:59

Methods

clearDirty

clearDirty(): void
Returns void
- Defined in Edge.ts:218

clone

clone(): Edge
Returns Edge
- Defined in Edge.ts:194

getData

getData(): EdgeData
Get the edge's data.

Returns EdgeData
- Defined in Edge.ts:87

getEdgeStyle

getEdgeStyle(): Partial<EdgeStyle>
Get the edge's style.

Returns Partial<EdgeStyle>
- Defined in Edge.ts:119

getGraphElement

getGraphElement(): SVGGElement | null
Returns SVGGElement | null
- Defined in Edge.ts:156

getLabelStyle

getLabelStyle(): Partial<LabelStyle>
Get the edge's label style if available.

Returns Partial<LabelStyle>
- Defined in Edge.ts:126

getStyle

getStyle(): Partial<EdgeFullStyle>
Get the edge's style.

Returns Partial<EdgeFullStyle>
- Defined in Edge.ts:112

hide

hide(): void
Returns void
- Defined in Edge.ts:239

isDirty

isDirty(): boolean
Returns boolean
- Defined in Edge.ts:222

markDirty

markDirty(): void
Returns void
- Defined in Edge.ts:214

setData

setData(newData: EdgeData): void
Update the edge's data.
Parameters
- newData: EdgeData
  New data to set
Returns void
- Defined in Edge.ts:95

setFrom

setFrom(node: Node): void
Parameters
- node: Node
Returns void
- Defined in Edge.ts:161

setStyle

setStyle(newStyle: EdgeFullStyle): void
Update the edge's style.
Parameters
- newStyle: EdgeFullStyle
  New style to set
Returns void
- Defined in Edge.ts:134

setTo

setTo(node: Node): void
Parameters
- node: Node
Returns void
- Defined in Edge.ts:165

show

show(): void
Returns void
- Defined in Edge.ts:235

toDict

toDict(): Record<string, unknown>
Convert edge to a simple JSON object representation.

Returns Record<string, unknown>
- Defined in Edge.ts:172

toggleVisibility

toggleVisibility(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in Edge.ts:226

toSimulationDTO

toSimulationDTO(): SimulationEdgeDTO
Structured-cloneable payload for the simulation worker; endpoints reduced to ids, keeps directed.

Returns SimulationEdgeDTO
- Defined in Edge.ts:183

updateData

updateData(partialData: Partial<EdgeData>): void
Merge partial data into the current edge data.
Parameters
- partialData: Partial<EdgeData>
  Partial data object to merge
Returns void
- Defined in Edge.ts:104

updateStyle

updateStyle(partialStyle: PartialEdgeFullStyle): void
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
- Defined in Edge.ts:144

Properties

`Readonly`directed

directed: boolean | null

`Readonly`domID

domID: string

from

from: Node

`Readonly`id

id: string

`Optional`isCrossCluster

isCrossCluster?: boolean

True for the subclass of synthetic edges that stand in for a real edge whose both endpoints are children of different clusters. Unlike the external→cluster synthetic edges, these are resolved as a set (one per collapse state) by ClusterDrawer.resolveCrossClusterEdges rather than the per-node toggle.

`Optional`isSynthetic

isSynthetic?: boolean

True if this is a synthetic edge (placeholder for collapsed cluster child)

`Optional`syntheticSourceNode

syntheticSourceNode?: Node

For a cross-cluster synthetic edge: the real child the from side stands in for.

`Optional`syntheticTerminalNode

syntheticTerminalNode?: Node

The actual child node this synthetic edge points to (for expansion logic)

to

to: Node

visible

visible: boolean

Class Edge

Index

Accessors

Constructors

Methods

Properties

Accessors

source

Returns Node

target

Returns Node

Constructors

constructor

Parameters

Returns Edge

Methods

clearDirty

Returns void

clone

Returns Edge

getData

Returns EdgeData

getEdgeStyle

Returns Partial<EdgeStyle>

getGraphElement

Returns SVGGElement | null

getLabelStyle

Returns Partial<LabelStyle>

getStyle

Returns Partial<EdgeFullStyle>

hide

Returns void

isDirty

Returns boolean

markDirty

Returns void

setData

Parameters

Returns void

setFrom

Parameters

Returns void

setStyle

Parameters

Returns void

setTo

Parameters

Returns void

show

Returns void

toDict

Returns Record<string, unknown>

toggleVisibility

Parameters

Returns void

toSimulationDTO

Returns SimulationEdgeDTO

updateData

Parameters

Returns void

updateStyle

Parameters

Returns void

Properties

Readonlydirected

ReadonlydomID

from

Readonlyid

OptionalisCrossCluster

OptionalisSynthetic

OptionalsyntheticSourceNode

OptionalsyntheticTerminalNode

to

visible

Settings

On This Page

`Readonly`directed

`Readonly`domID

`Readonly`id

`Optional`isCrossCluster

`Optional`isSynthetic

`Optional`syntheticSourceNode

`Optional`syntheticTerminalNode