Class GraphTracer

Hierarchy

Tracer
- GraphTracer

Index

Constructors

constructor

Methods

Constructors

constructor

new GraphTracer(title?: undefined | string): GraphTracer

Inherited from Tracer.constructor
- Defined in Tracer.ts:3
Create a tracer.

Parameters
- Optional title: undefined | string
Returns GraphTracer

Methods

addEdge

addEdge(source: any, target: any, weight?: any): void

- Defined in GraphTracer.ts:100
Add an edge.

Parameters
- source: any
  
  The id of the node where the edge starts.
- target: any
  
  The id of the node where the edge ends.
- Optional weight: any
Returns void

addNode

addNode(id: any, weight?: any, x?: undefined | number, y?: undefined | number): void

- Defined in GraphTracer.ts:68
Add a node.

Parameters
- id: any
- Optional weight: any
- Optional x: undefined | number
  
  The x position between -160 and +160.
- Optional y: undefined | number
  
  The y position between -160 and +160.
Returns void

deselect

deselect(target: any, source?: any): void

- Defined in GraphTracer.ts:163
Stop selecting a node.

Parameters
- target: any
  
  The id of the node to stop selecting.
- Optional source: any
  
  The id of the node to stop selecting from.
Returns void

destroy

destroy(): void

Inherited from Commander.destroy
- Defined in Commander.ts:56
Remove the tracer.

Returns void

directed

directed(isDirected?: undefined | false | true): this

- Defined in GraphTracer.ts:18
Make the graph directed.

Parameters
- Optional isDirected: undefined | false | true
Returns this

layoutCircle

layoutCircle(): this

- Defined in GraphTracer.ts:36
Arrange nodes on a circular layout.

Returns this

layoutRandom

layoutRandom(): this

- Defined in GraphTracer.ts:55
Arrange nodes randomly.

Returns this

layoutTree

layoutTree(root?: any, sorted?: undefined | false | true): this

- Defined in GraphTracer.ts:47
Arrange nodes on a tree layout.

Parameters
- Optional root: any
  
  The id of a root node.
- Optional sorted: undefined | false | true
  
  Whether to sort sibling nodes.
Returns this

leave

leave(target: any, source?: any, weight?: any): void

- Defined in GraphTracer.ts:143
Leave after visiting a node.

Parameters
- target: any
  
  The id of the node to leave.
- Optional source: any
  
  The id of the node to leave to.
- Optional weight: any
  
  The weight of target to set to.
Returns void

log

log(logTracer: LogTracer): void

- Defined in GraphTracer.ts:172
Synchronize with a log tracer.

Parameters
- logTracer: LogTracer
Returns void

removeEdge

removeEdge(source: any, target: any): void

- Defined in GraphTracer.ts:121
Remove an edge.

Parameters
- source: any
  
  The id of the node where the edge starts.
- target: any
  
  The id of the node where the edge ends.
Returns void

removeNode

removeNode(id: any): void

- Defined in GraphTracer.ts:89
Remove a node.

Parameters
- id: any
Returns void

reset

reset(): void

Inherited from Tracer.reset
- Defined in Tracer.ts:25
Reset the tracer.

Returns void

select

select(target: any, source?: any): void

- Defined in GraphTracer.ts:153
Select a node.

Parameters
- target: any
  
  The id of the node to select.
- Optional source: any
  
  The id of the node to select from.
Returns void

set

set(array2d?: any[][]): void

- Defined in GraphTracer.ts:9
Set an adjacency matrix to visualize.

Parameters
- Optional array2d: any[][]
Returns void

updateEdge

updateEdge(source: any, target: any, weight?: any): void

- Defined in GraphTracer.ts:111
Update an edge.

Parameters
- source: any
  
  The id of the node where the edge starts.
- target: any
  
  The id of the node where the edge ends.
- Optional weight: any
Returns void

updateNode

updateNode(id: any, weight?: any, x?: undefined | number, y?: undefined | number): void

- Defined in GraphTracer.ts:80
Update a node.

Parameters
- id: any
- Optional weight: any
- Optional x: undefined | number
  
  The x position between -160 and +160.
- Optional y: undefined | number
  
  The y position between -160 and +160.
Returns void

visit

visit(target: any, source?: any, weight?: any): void

- Defined in GraphTracer.ts:132
Visit a node.

Parameters
- target: any
  
  The id of the node to visit.
- Optional source: any
  
  The id of the node to visit from.
- Optional weight: any
  
  The weight of target to set to.
Returns void

weighted

weighted(isWeighted?: undefined | false | true): this

- Defined in GraphTracer.ts:28
Make the graph weighted.

Parameters
- Optional isWeighted: undefined | false | true
Returns this

Static delay

delay(lineNumber?: Number): void

Inherited from Tracer.delay
- Defined in Tracer.ts:18
Pause to show changes in all tracers.

Parameters
- Optional lineNumber: Number
  
  The line number to indicate when paused. If omitted, the line calling this method will be indicated.
Returns void

Generated using TypeDoc