Class Edge

source

• get source(): Node

  Required by d3-force

  Returns Node

target

• get target(): Node

  Returns Node

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

clearDirty

• clearDirty(): void

  Returns void

clone

• clone(): Edge

  Returns Edge

getData

• getData(): EdgeData

  Get the edge's data.

  Returns EdgeData

getEdgeStyle

• getEdgeStyle(): Partial<EdgeStyle>

  Get the edge's style.

  Returns Partial<EdgeStyle>

getGraphElement

• getGraphElement(): SVGGElement | null

  Returns SVGGElement | null

getLabelStyle

• getLabelStyle(): Partial<LabelStyle>

  Get the edge's label style if available.

  Returns Partial<LabelStyle>

getStyle

• getStyle(): Partial<EdgeFullStyle>

  Get the edge's style.

  Returns Partial<EdgeFullStyle>

hide

• hide(): void

  Returns void

isDirty

• isDirty(): boolean

  Returns boolean

markDirty

• markDirty(): void

  Returns void

setData

• setData(newData: EdgeData): void

  Update the edge's data.

  Parameters

  • newData: EdgeData

    New data to set

  Returns void

setFrom

• setFrom(node: Node): void

  Parameters

  • node: Node

  Returns void

setStyle

• setStyle(newStyle: EdgeFullStyle): void

  Update the edge's style.

  Parameters

  • newStyle: EdgeFullStyle

    New style to set

  Returns void

setTo

• setTo(node: Node): void

  Parameters

  • node: Node

  Returns void

show

• show(): void

  Returns void

toDict

• toDict(): Record<string, unknown>

  Convert edge to a simple JSON object representation.

  Returns Record<string, unknown>

toggleVisibility

• toggleVisibility(visible: boolean): void

  Parameters

  • visible: boolean

  Returns void

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

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

Readonlydirected

ReadonlydomID

from

Readonlyid

OptionalisSynthetic

OptionalsyntheticTerminalNode

to

visible