Class Node

Represents a single node (vertex) in a graph.

Constructors

constructor

new Node(
    id: string,
    data?: NodeData,
    style?: Partial<NodeStyle>,
    domID?: string,
    children?: Node[],
): 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>
- domID: string = ...
- children: Node[] = []
Returns Node
- Defined in Node.ts:62

Methods

clone

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

collapse

collapse(): void
Returns void
- Defined in Node.ts:307

degree

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

expand

expand(): void
Returns void
- Defined in Node.ts:300

freeze

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

getCircleRadius

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

getCircleRadiusCollapsed

getCircleRadiusCollapsed(): number
Returns number
- Defined in Node.ts:330

getConnectedNodes

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

getConnectingNodes

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

getData

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

Returns NodeData
- Defined in Node.ts:83

getEdgesIn

getEdgesIn(): Edge[]
Returns Edge[]
- Defined in Node.ts:144

getEdgesOut

getEdgesOut(): Edge[]
Returns Edge[]
- Defined in Node.ts:140

getGraphElement

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

getStyle

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

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

hasChildren

hasChildren(): boolean
Returns boolean
- Defined in Node.ts:343

hide

hide(): void
Returns void
- Defined in Node.ts:279

markAsChild

markAsChild(parentNode: Node, childrenDepth: number): void
Parameters
- parentNode: Node
- childrenDepth: number
Returns void
- Defined in Node.ts:347

markAsParent

markAsParent(): void
Returns void
- Defined in Node.ts:353

setChildren

setChildren(children: Node[]): void
Parameters
- children: Node[]
Returns void
- Defined in Node.ts:334

setCircleRadius

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

setCircleRadiusCollapsed

setCircleRadiusCollapsed(radius: number): void
Parameters
- radius: number
Returns void
- Defined in Node.ts:326

setData

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

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:159

show

show(): void
Returns void
- Defined in Node.ts:275

toDict

toDict(dataOnly?: boolean): Record<string, unknown>
Convert node to a simple JSON object representation.
Parameters
- dataOnly: boolean = false
  default: false
Returns Record<string, unknown>
- Defined in Node.ts:183

toggleExpand

toggleExpand(expanded?: boolean): void
Parameters
- Optionalexpanded: boolean
Returns void
- Defined in Node.ts:283

toggleVisibility

toggleVisibility(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in Node.ts:266

unfreeze

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

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:101

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:169

Properties

children

children: Node[]

childrenDepth

childrenDepth: number

defaultCircleRadius

defaultCircleRadius: number = 10

`Readonly`domID

domID: string

`Optional`expanded

expanded?: boolean

`Optional`frozen

frozen?: boolean

`Optional`fx

fx?: number

`Optional`fy

fy?: number

`Readonly`id

id: string

isChild

isChild: boolean

True if this node is a child within a collapsed cluster

isParent

isParent: boolean

True if this node has child nodes

`Optional`parentNode

parentNode?: Node

Reference to the parent cluster node (if this node is a child)

visible

visible: boolean

`Optional`vx

vx?: number

`Optional`vy

vy?: number

`Optional`weight

weight?: number

`Optional`x

x?: number

`Optional`y

y?: number

Class Node

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Node

Methods

clone

Returns Node

collapse

Returns void

degree

Returns number

expand

Returns void

freeze

Returns void

getCircleRadius

Returns number

getCircleRadiusCollapsed

Returns number

getConnectedNodes

Returns Node[]

getConnectingNodes

Returns Node[]

getData

Returns NodeData

getEdgesIn

Returns Edge[]

getEdgesOut

Returns Edge[]

getGraphElement

Returns SVGGElement | null

getStyle

Returns Partial<NodeStyle>

hasChildren

Returns boolean

hide

Returns void

markAsChild

Parameters

Returns void

markAsParent

Returns void

setChildren

Parameters

Returns void

setCircleRadius

Parameters

Returns void

setCircleRadiusCollapsed

Parameters

Returns void

setData

Parameters

Returns void

setStyle

Parameters

Returns void

show

Returns void

toDict

Parameters

Returns Record<string, unknown>

toggleExpand

Parameters

Returns void

toggleVisibility

Parameters

Returns void

unfreeze

Returns void

updateData

Parameters

Returns void

updateStyle

Parameters

`Readonly`domID

`Optional`expanded

`Optional`frozen

`Optional`fx

`Optional`fy

`Readonly`id

`Optional`parentNode

`Optional`vx

`Optional`vy

`Optional`weight

`Optional`x

`Optional`y