Class Node

Represents a single node (vertex) in a graph.

Index

Constructors

Methods

clone degree freeze getCircleRadius getConnectedNodes getConnectingNodes getData getGraphElement getStyle setCircleRadius setData setStyle toJSON unfreeze updateData updateStyle

Properties

defaultCircleRadius domID frozen? fx? fy? id vx? vy? x? y?

Constructors

constructor

new Node(id: string, data?: NodeData, style?: Partial<NodeStyle>): Node
Create a new Node instance.
Parameters
- id: string
  Unique identifier for the node
- Optionaldata: NodeData
  Optional data payload associated with the node
- Optionalstyle: Partial<NodeStyle>
Returns Node
- Defined in Node.ts:37

Methods

clone

clone(): Node
Returns Node
- Defined in Node.ts:156

degree

degree(): number
Returns number
- Defined in Node.ts:207

freeze

freeze(): void
Returns void
- Defined in Node.ts:195

getCircleRadius

getCircleRadius(): number
Returns number
- Defined in Node.ts:215

getConnectedNodes

getConnectedNodes(): Node[]
Returns Node[]
- Defined in Node.ts:96

getConnectingNodes

getConnectingNodes(): Node[]
Returns Node[]
- Defined in Node.ts:102

getData

getData(): NodeData
Get the node's data.

Returns NodeData
- Defined in Node.ts:51

getGraphElement

getGraphElement(): SVGGElement | null
Returns SVGGElement | null
- Defined in Node.ts:134

getStyle

getStyle(): Partial<NodeStyle>
Get the node's data.

Returns Partial<NodeStyle>
- Defined in Node.ts:111

setCircleRadius

setCircleRadius(radius: number): void
Parameters
- radius: number
Returns void
- Defined in Node.ts:211

setData

setData(newData: NodeData): void
Update the node's data.
Parameters
- newData: NodeData
  New data to set
Returns void
- Defined in Node.ts:59

setStyle

setStyle(newStyle: Partial<NodeStyle>): void
Update the node's data.
Parameters
- newStyle: Partial<NodeStyle>
  New data to set
Returns void
- Defined in Node.ts:119

toJSON

toJSON(): object
Convert node to a simple JSON object representation.

Returns object
- Defined in Node.ts:142

unfreeze

unfreeze(): void
Returns void
- Defined in Node.ts:201

updateData

updateData(partialData: Partial<NodeData>): void
Merge partial data into the current node data. Useful for updating only parts of the data.
Parameters
- partialData: Partial<NodeData>
  Partial data object to merge
Returns void
- Defined in Node.ts:69

updateStyle

updateStyle(partialStyle: Partial<NodeStyle>): void
Merge partial data into the current node data. Useful for updating only parts of the data.
Parameters
- partialStyle: Partial<NodeStyle>
  Partial data object to merge
Returns void
- Defined in Node.ts:129

Properties

defaultCircleRadius

defaultCircleRadius: number = 10

`Readonly`domID

domID: string

`Optional`frozen

frozen?: boolean

`Optional`fx

fx?: number

`Optional`fy

fy?: number

`Readonly`id

id: string

`Optional`vx

vx?: number

`Optional`vy

vy?: number

`Optional`x

x?: number

`Optional`y

y?: number